PHPackages                             clickonmedia/frameio-php-client - PHPackages - PHPackages  [Skip to content](#main-content)[PHPackages](/)[Directory](/)[Categories](/categories)[Trending](/trending)[Leaderboard](/leaderboard)[Changelog](/changelog)[Analyze](/analyze)[Collections](/collections)[Log in](/login)[Sign up](/register)

1. [Directory](/)
2. /
3. clickonmedia/frameio-php-client

AbandonedArchivedLibrary

clickonmedia/frameio-php-client
===============================

3.0.2(6y ago)3936↓100%1[1 issues](https://github.com/clickonmedia/frameio-php-client/issues)MITPHP

Since Apr 15Pushed 5y ago5 watchersCompare

[ Source](https://github.com/clickonmedia/frameio-php-client)[ Packagist](https://packagist.org/packages/clickonmedia/frameio-php-client)[ RSS](/packages/clickonmedia-frameio-php-client/feed)WikiDiscussions master Synced 2mo ago

READMEChangelog (7)Dependencies (5)Versions (10)Used By (0)

Frame.io PHP Client
===================

[](#frameio-php-client)

Run the following command to install the package:

```
composer require clickonmedia/frameio-php-client

```

Frame.io API Documentation
--------------------------

[](#frameio-api-documentation)

Basic Usage
-----------

[](#basic-usage)

```
require __DIR__ . '/vendor/autoload.php';
use Frameio\FrameIOClient;

$frameIO =  new FrameIOClient();
echo $frameIO->getHost();

```

Development / Run tests
-----------------------

[](#development--run-tests)

Copy *.env.example* file from the root directory and rename the file to *.env*. Fill in the variables in the file based on information from the Frame.io dashboard.

```
composer install
composer run-script test

```

Available functionality
-----------------------

[](#available-functionality)

**Get user profile**

```
$frameIO->getProfile()

```

**Gets teams for a user**

```
$frameIO->getTeams()

```

**Get Teams By Account Id**

> @param string $accountId Account ID (required)

```
$frameIO->getTeamsByAccountId( $accountId )

```

**Get user membership for a team**

> @param string $teamId Team ID (required)

```
$frameIO->getTeamMembership( $teamId )

```

**Add user membership to a team**

> @param string $teamId Team ID (required)
> @param string $userId User ID (required)
> @param string $role Member Role (required)

```
$frameIO->addTeamMembership( $teamId, $userId, $role )

```

**Create project**

> @param string $name Project name (required)
> @param string $teamId Team ID (required)
> @param boolean $private Set project as private (optional)

```
$frameIO->createProject( $name, $teamId, $private )

```

**Get project by id**

> @param string $projectId Project ID (required)

```
$frameIO->getProjectById( $projectId )

```

**Delete project by id**

> @param string $projectId Project ID (required)

```
$frameIO->deleteProjectById( $projectId )

```

**Get Projects By Team ID**

> @param string $teamId Team ID (required)

```
$frameIO->getProjectsByTeamid( $teamId )

```

**Get user membership for project**

> @param string $projectId Project ID (required)

```
$frameIO->getUserMembershipForProject( $projectId )

```

**Add a collaborator to a team**

> @param string $projectId Project ID (required)
> @param string $email User email address (required)

```
$frameIO->addCollaboratorToTeam( $projectId, $email )

```

**Create an asset**

> @param string $projectId Project ID (required)

> @param string $args Additional arguments (required):

> name string Name (required)
> filesize int Filesize (required)
> type string Type (required: "file" or "folder")
> description string Description (optional)
> filetype string File type (optional, e.g. "video/mp4")
> fileUrl string File URL (optional)
> properties array Custom Properties (optional)

```
$frameIO->createAsset( $projectId, $args );

```

**Get assets**

> @param string $rootAssetId Parent asset ID (required)
> @param string $type Type (default value: "file")

```
$frameIO->getAssets( $rootAssetId, $type )

```

**Get an Asset by ID**

> @param string $assetId Asset ID (required)

```
$frameIO->getAssetById( $assetId )

```

**Update an Asset**

> @param string $assetId Asset ID (required)
> @param string $name Name (required)
> @param string $args Additional arguments (optional):

PropertyTypeDefaultDescriptionDescriptionstring""-Propertiesarray\[\]/key value pair arrayNumberns are clicked.```
$frameIO->updateAssetById( $assetId, $name, $args )

```

**Delete an Asset By ID**

> @param string $assetId Asset ID (required)

```
$frameIO->deleteAssetById( $assetId )

```

**Add a version to an Asset**

> @param string $assetId Asset ID (required)
> @param string $nextAssetId Next Asset ID (required)

```
$frameIO->addVersionToAsset( $assetId, $nextAssetId )

```

**Get Project Assets**

> @param string $projectId Project ID (required)

```
$frameIO->getProjectAssets( $projectId )

```

**Upload a file to an asset**

> @param object $asset The asset object (required)
> @param string $file\_path File path of the file (required)

```
$frameIO->upload( $asset, $file_path );

```

**Create a Comment**

> @param string $assetId Asset ID (required)
> @param object $args Additional arguments (required)

> text string The body of the comment. (optional)
> annotation string Serialized list of geometry and/or drawing data. (optional)
> timestamp string Timestamp for the comment, in frames. (optional)
> page string Page number for a comment (optional, documents only).
> pitch integer Pitch measurement for the comment (optional, 360deg video only)
> yaw string Yaw measurement for the comment (optional, 360deg video only)

```
$frameIO->createComment( $assetId, $args )

```

**Get Comments By Asset Id**

> @param string $assetId Asset ID (required)

```
$frameIO->getComments( $assetId )

```

**Get Comment By Comment Id**

> @param string $commentId Comment ID (required)

```
$frameIO->getCommentById( $commentId )

```

**Update a Comment**

> @param string $commentId Comment ID (required)
> @param string $text Comment text (default value: "")

```
$frameIO->updateComment( $commentId, $text )

```

**Delete a Comment**

> @param string $commentId Comment ID (required)

```
$frameIO->deleteCommentById ( $commentId )

```

**Get Review Links for Project**

> @param string $projectId Project ID (required)

```
$frameIO->getReviewLinks( $projectId )

```

**Create a Review Link**

> @param string $projectId Project ID (required)
> @param string $name Review link name (required)
> @param string $args Additional arguments (optional):

> allow\_approvals boolean Allow Approvals (default value: false)
> current\_version\_only boolean Current Version Only (default value: false)
> enable\_downloading boolean Enable Downloading (default value: false)
> requires\_passphrase boolean Requires Passphrase (default value: false)
> password string Password (default value: "")
> expires\_at string Expires At (default value: "")

```
$frameIO->createReviewLink( $projectId, $name, $args )

```

**Update a Review Link**

> @param string $reviewLinkId Review link ID (required)
> @param string $name Review name (required)
> @param string $args Additional arguments (optional):

> allow\_approvals boolean Allow Approvals (default value: false)
> current\_version\_only boolean Current Version Only (default value: false)
> enable\_downloading boolean Enable Downloading (default value: false)
> requires\_passphrase boolean Requires Passphrase (default value: false)
> password string Password (default value: "")
> expires\_at string Expires At (default value: "")

```
$frameIO->UpdateReviewLink( $reviewLinkId, $name, args )

```

**Get a Review Link**

> @param string $link\_id Review link ID (required)

```
$frameIO->getReviewLink( $link_id )

```

**Get Review Link Items**

> @param string $link\_id Review link ID (required)

```
$frameIO->getReviewLinkItems( $link_id )

```

**Add Assets to a Review Link**

> @param string $reviewLinkId Review link ID (required)
> @param array $assetIds Asset IDs (required, array of ids)

```
$frameIO->addAssetsToReviewLink( $reviewLinkId, $assetIds )

```

**Search for Assets**

> @param string $query Search query (default value: "")
> @param string $teamId Team ID (default value: "")
> @param string $accountId Account ID (default value: "")

```
$frameIO->getSearchAssets ( $query, $teamId, $accountId )

```

**Search for Assets (Complex)**

> @param string $query Search query (default value: "")
> @param string $teamId Team ID (default value: "")
> @param string $accountId Account ID (default value: "")
> @param string $filter Filter for the query (default value: \[\], key value pair Array)

```
$frameIO->searchAssets ( $query , $teamId , $accountId, $filter )

```

###  Health Score

31

—

LowBetter than 68% of packages

Maintenance13

Infrequent updates — may be unmaintained

Popularity20

Limited adoption so far

Community12

Small or concentrated contributor base

Maturity65

Established project with proven stability

 Bus Factor1

Top contributor holds 95.5% of commits — single point of failure

How is this calculated?**Maintenance (25%)** — Last commit recency, latest release date, and issue-to-star ratio. Uses a 2-year decay window.

**Popularity (30%)** — Total and monthly downloads, GitHub stars, and forks. Logarithmic scaling prevents top-heavy scores.

**Community (15%)** — Contributors, dependents, forks, watchers, and maintainers. Measures real ecosystem engagement.

**Maturity (30%)** — Project age, version count, PHP version support, and release stability.

###  Release Activity

Cadence

Every ~12 days

Recently: every ~1 days

Total

9

Last Release

2488d ago

Major Versions

1.0.4 → 2.0.02019-07-19

2.0.0 → 3.0.02019-07-22

### Community

Maintainers

![](https://www.gravatar.com/avatar/3ad0327569e7a69acbd3548909f4806b03c10efc9c9e66d2d4b9140355b12d8c?d=identicon)[CLICKONMedia](/maintainers/CLICKONMedia)

---

Top Contributors

[![jpylisela](https://avatars.githubusercontent.com/u/2624330?v=4)](https://github.com/jpylisela "jpylisela (42 commits)")[![theKhorshed](https://avatars.githubusercontent.com/u/10390188?v=4)](https://github.com/theKhorshed "theKhorshed (2 commits)")

---

Tags

frameio php client

###  Code Quality

TestsPHPUnit

### Embed Badge

![Health badge](/badges/clickonmedia-frameio-php-client/health.svg)

```
[![Health](https://phpackages.com/badges/clickonmedia-frameio-php-client/health.svg)](https://phpackages.com/packages/clickonmedia-frameio-php-client)
```

###  Alternatives

[laravel/framework

The Laravel Framework.

34.6k509.9M17.0k](/packages/laravel-framework)[laravel/dusk

Laravel Dusk provides simple end-to-end testing and browser automation.

1.9k36.7M259](/packages/laravel-dusk)[laravel/vapor-cli

The Laravel Vapor CLI

31310.7M8](/packages/laravel-vapor-cli)[netflie/whatsapp-cloud-api

The first PHP SDK to send and receive messages using a cloud-hosted version of the WhatsApp Business Platform

640431.7k4](/packages/netflie-whatsapp-cloud-api)[tempest/framework

The PHP framework that gets out of your way.

2.1k23.1k9](/packages/tempest-framework)[blair2004/nexopos

The Free Modern Point Of Sale System build with Laravel, TailwindCSS and Vue.js.

1.2k2.3k](/packages/blair2004-nexopos)

PHPackages © 2026

[Directory](/)[Categories](/categories)[Trending](/trending)[Changelog](/changelog)[Analyze](/analyze)