Frameconnector v1 | OneTeg Documentation

Version 1

Connector Overview: This page documents all 101 actions for the Frameconnector v1.

Accounts (2)

GET Get Accounts for User

/v2/accounts

Fetch all Accounts that a given User has access to

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Accept`	N/A
`Response Type`	N/A

GET List accounts

/v2/devices/accounts

List available accounts to pair your C2C device with.

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`X-client-version`	Firmware or software version of a C2C integration. Will be used to determine the correct Device Model configuration for the device when multiple are available. Must be a valid semantic version. For more on semantic versions, see here: https://semver.org/
`Accept`	N/A
`Response Type`	N/A

Actions (3)

POST Create a Custom Action

/v2/teams/{team_id}/actions

Create a Custom Action belonging to A Team

Parameters

Parameter Name	Description
`Content Type`	N/A
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Team Id`	(Required)
`Accept`	N/A
`Response Type`	N/A

Options (6)

Option Name	Description
`Url`	N/A
`Name`	N/A
`Event`	N/A
`Description`	N/A
`Allow Collaborators`	N/A
`Include`	N/A

GET Get Custom Actions for a given Team

/v2/teams/{team_id}/actions

Fetch Custom Actions belonging to a given Team

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Include`	N/A
`Team Id`	(Required)
`Accept`	N/A
`Response Type`	N/A

GET Get Custom Actions for an Account or Team

/v2/accounts/{account_id}/actions

Get Custom Actions available to a given Account

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Include`	N/A
`Account Id`	(Required)
`Accept`	N/A
`Response Type`	N/A

Assets (7)

POST Add Asset to a Review Link

/v2/review_links/{review_link_id}/assets

Add assets to a Review Link

Parameters

Parameter Name	Description
`Content Type`	N/A
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Review Link Id`	(Required)
`Accept`	N/A
`Response Type`	N/A

Options (1)

Option Name	Description
`Asset Ids`	N/A

DELETE Bulk delete assets

/v2/batch/assets

Delete a list of Assets

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Accept`	N/A
`Response Type`	N/A

POST Create C2C asset

/v2/assets

THIS ENDPOINT IS DEPRECATED. Please use /v2/devices/assets instead. While this endpoint will continue to function as normal, we ask that integrations begin using the new endpoint instead for consistency with the rest of the C2C API.

Asset upload initiation specifically for C2C devices and applications.

Parameters

Parameter Name	Description
`Content Type`	N/A
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`X-client-version`	Firmware or software version of a C2C integration. Will be used to determine the correct Device Model configuration for the device when multiple are available. Must be a valid semantic version. For more on semantic versions, see here: https://semver.org/
`Accept`	N/A
`Response Type`	N/A

Options (9)

Option Name	Description
`Name`	N/A
`Extension`	N/A
`Filetype`	N/A
`Auto Version Id`	N/A
`Is Realtime Upload`	N/A
`Filesize`	N/A
`Channel`	N/A
`Offset`	N/A
`Parts`	N/A

POST Create C2C asset1

/v2/devices/assets

Asset upload initiation specifically for C2C devices and applications.

Note: This endpoint used to be /v2/assets, and while that endpoint will continue to function as normal, we suggest you use this one instead.

Parameters

Parameter Name	Description
`Content Type`	N/A
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`X-client-version`	Firmware or software version of a C2C integration. Will be used to determine the correct Device Model configuration for the device when multiple are available. Must be a valid semantic version. For more on semantic versions, see here: https://semver.org/
`Accept`	N/A
`Response Type`	N/A

Options (9)

Option Name	Description
`Name`	N/A
`Extension`	N/A
`Filetype`	N/A
`Auto Version Id`	N/A
`Is Realtime Upload`	N/A
`Filesize`	N/A
`Channel`	N/A
`Offset`	N/A
`Parts`	N/A

GET Search for Assets

/v2/search/assets

Search for Assets via query parameters

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Account Id`	N/A
`Include`	N/A
`Include Deleted`	Flag to include soft-deleted records in results
`Page`	The page to retrieve
`Page Size`	The number of results to include in the page
`Project Id`	N/A
`Q`	Search text
`Query`	Search text
`Shared Projects`	N/A
`Sort`	Sorting parameters
`Team Id`	N/A
`Type`	N/A
`Accept`	N/A
`Response Type`	N/A

POST Search for Assets

/v2/search/assets

Search for Assets using a JSON payload

Parameters

Parameter Name	Description
`Content Type`	N/A
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Accept`	N/A
`Response Type`	N/A

Options (15)

Option Name	Description
`Account Id`	N/A
`Filter`	N/A
`Include`	N/A
`Include Deleted`	N/A
`Opts`	N/A
`Page`	N/A
`Page Size`	N/A
`Project Id`	N/A
`Properties`	N/A
`Q`	N/A
`Query`	N/A
`Shared Projects`	N/A
`Sort`	N/A
`Team Id`	N/A
`Type`	N/A

PUT Update Assets in a Review Link

/v2/review_links/{review_link_id}/assets

Replace the assets on this Review Link

Parameters

Parameter Name	Description
`Content Type`	N/A
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Review Link Id`	(Required)
`Accept`	N/A
`Response Type`	N/A

Options (1)

Option Name	Description
`Asset Ids`	N/A

Audio

GET Get audio for an Asset

/v2/assets/{asset_id}/audio

Fetch the audio tracks for a given Asset

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Asset Id`	(Required)
`Accept`	N/A
`Response Type`	N/A

Audit_logs

GET (Legacy) Get Audit Logs for an Account

/v2/accounts/{account_id}/audit_logs

Fetch audit logs with some filtering capabilities via query params

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Filter[item Id]`	Filter by Item ID (Asset ID, Project ID, User ID)
`Filter[inserted At][op]`	Filter by log datetime using logical operators
`Filter[inserted At][value]`	ISO Datetime
`Filter[item Type]`	Filter by Item Type
`Filter[action]`	Filter by Action
`Filter[actor Id]`	Filter by Actor ID
`Filter[team Id]`	Filter by Team ID
`Filter[ip Address]`	Filter by IP Address This supports both IPv4 (1.1.1.1) and IPv6 (2001:db8:3333:4444:5555:6666:7777:8888)
`Page`	Page number
`Page Size`	Records per page
`Account Id`	(Required) Account ID
`Accept`	N/A
`Response Type`	N/A

Channels

POST Connect a new device channel

/v2/devices/channels

We can connect a new channel with the following request

Parameters

Parameter Name	Description
`Content Type`	N/A
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`X-client-version`	Firmware or software version of a C2C integration. Will be used to determine the correct Device Model configuration for the device when multiple are available. Must be a valid semantic version. For more on semantic versions, see here: https://semver.org/
`Accept`	N/A
`Response Type`	N/A

Options (2)

Option Name	Description
`Client Id`	N/A
`Device Model Id`	N/A

Children (2)

POST Create an Asset

/v2/assets/{asset_id}/children

Create a new asset.

Parameters

Parameter Name	Description
`Content Type`	N/A
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Asset Id`	(Required)
`Accept`	N/A
`Response Type`	N/A

Options (8)

Option Name	Description
`Type`	N/A
`Name`	N/A
`Extension`	N/A
`Filetype`	N/A
`Is Realtime Upload`	N/A
`Description`	N/A
`Filesize`	N/A
`Properties`	N/A

GET Fetch child Assets

/v2/assets/{asset_id}/children

Get child elements of a given asset. Can be used to get the items in a review link, version stack, folder, as well as including an asset to use on the cover of a folder.

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Include Deleted`	Include deleted files by passing true
`Include`	Include additional "pre-loads" for related resources
`Sort`	The sorting order for the returned list of Assets. Supporting chaining like comment_count,id. Also supports reversing the order with - i.e. -comment_count,id or filetype,-id.
`Page`	The current page number in this Paginated Response
`Page Size`	Number of pages in this Paginated Response
`Asset Id`	(Required)
`Accept`	N/A
`Response Type`	N/A

Code

POST Request device code

/v2/device/code

Parameters

Parameter Name	Description
`Content Type`	N/A
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`X-client-version`	Firmware or software version of a C2C integration. Will be used to determine the correct Device Model configuration for the device when multiple are available. Must be a valid semantic version. For more on semantic versions, see here: https://semver.org/
`Content-type`	N/A
`Accept`	N/A
`Response Type`	N/A

Options (3)

Option Name	Description
`Client Id`	(Required) A unique identifier for the physical hardware device. This value needs to be guaranteed to be unique for the device. This could be a serial number or a randomly generated UUID.
`Client Secret`	(Required) This will be issued to you by Frame.io support and identifies the your device model. This value should be kept secret from the user, and should be encrypted at rest
`Scope`	(Required) The permissions we are requesting, with spaces used as delimiters. Hardware devices can only request the following two scopes (This can only be one of asset_create,offline)

Collaborators (4)

POST Add a Collaborator to a Project

/v2/projects/{project_id}/collaborators

Add a new Collaborator to a Project

Parameters

Parameter Name	Description
`Content Type`	N/A
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Include`	Include additional "pre-loads" for this resource
`Project Id`	(Required)
`Accept`	N/A
`Response Type`	N/A

Options (1)

Option Name	Description
`Email`	N/A

POST Batch create Collaborators and PendingCollaborators within a Project

/v2/batch/projects/{project_id}/collaborators

Submit a list of Collaborators to add to the given Project as Collaborators

Parameters

Parameter Name	Description
`Content Type`	N/A
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Project Id`	(Required)
`Accept`	N/A
`Response Type`	N/A

Options (2)

Option Name	Description
`Default Message`	N/A
`Send Email`	N/A

DELETE Batch delete Collaborators and PendingCollaborators for a Project

/v2/batch/projects/{project_id}/collaborators

Submit a list of Collaborators you wish to remove from a given Project

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Project Id`	(Required)
`Accept`	N/A
`Response Type`	N/A

GET Get Project Collaborators

/v2/projects/{project_id}/collaborators

Fetch the list of Collaborators with access to a Project.

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Project Id`	(Required) Project ID
`Accept`	N/A
`Response Type`	N/A

Comments (2)

POST Create a Comment

/v2/assets/{asset_id}/comments

Complete (2)

DELETE Mark a Comment as Uncompleted

/v2/comments/{comment_id}/complete

If a Comment has been marked Completed, you can reset its to Uncompleted by hitting this endpoint.

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Comment Id`	(Required)
`Accept`	N/A
`Response Type`	N/A

POST Mark completed

/v2/comments/{comment_id}/complete

Complete a "Task" on a given Comment

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Comment Id`	(Required)
`Accept`	N/A
`Response Type`	N/A

Connect

POST Connect device

/v2/devices/connect

Connect to the provided C2C Project.

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Project Id`	The project_id you intend to connect to
`X-client-version`	Firmware or software version of a C2C integration. Will be used to determine the correct Device Model configuration for the device when multiple are available. Must be a valid semantic version. For more on semantic versions, see here: https://semver.org/
`Accept`	N/A
`Response Type`	N/A

Copy (2)

POST Bulk copy assets

/v2/batch/assets/{destination_id}/copy

Copy a batch of asset ids to a new folder. You can also choose to copy over all or none of the comments from the original to the copied asset.

Parameters

Parameter Name	Description
`Content Type`	N/A
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Destination Id`	(Required) Destination folder id - must be in the same folder
`Accept`	N/A
`Response Type`	N/A

Options (1)

Option Name	Description
`Copy Comments`	N/A

POST Copy asset

/v2/assets/{destination_folder}/copy

Copy an Asset to a new location

Parameters

Parameter Name	Description
`Content Type`	N/A
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Destination Folder`	(Required) Destination folder id
`Accept`	N/A
`Response Type`	N/A

Options (1)

Option Name	Description
`Id`	N/A

Disconnect (3)

POST Disconnect a specific device channel

/v2/devices/channels/{channel_id}/disconnect

Disconnect a device channel with the following request

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Channel Id`	(Required) Device channel id
`X-client-version`	Firmware or software version of a C2C integration. Will be used to determine the correct Device Model configuration for the device when multiple are available. Must be a valid semantic version. For more on semantic versions, see here: https://semver.org/
`Accept`	N/A
`Response Type`	N/A

POST Disconnect all device channels

/v2/devices/channels/disconnect

Disconnects all connected device channels

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`X-client-version`	Firmware or software version of a C2C integration. Will be used to determine the correct Device Model configuration for the device when multiple are available. Must be a valid semantic version. For more on semantic versions, see here: https://semver.org/
`Accept`	N/A
`Response Type`	N/A

POST Disconnect device

/v2/devices/disconnect

Disconnect the device from the project it's currently connected to.

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`X-client-version`	Firmware or software version of a C2C integration. Will be used to determine the correct Device Model configuration for the device when multiple are available. Must be a valid semantic version. For more on semantic versions, see here: https://semver.org/
`Response Type`	N/A

Events (2)

GET Get audit log entries for a specified User

/v2/users/{user_id}/events

Fetch audit logs for a given user with some filtering capabilities via query params. It works best to think of this as an _activity_ log for the specified user

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Filters[start Date]`	Start ISO Date
`Filters[end Date]`	End ISO Date
`Filters[resource Type]`	Filter by Resource Type
`Filters[event Type]`	Filter by Type of Activity
`Filters[team Id]`	Filter by Team ID
`Filters[project Id]`	Filter by Project ID
`Filters[resource Id]`	Filter by resource ID (Asset ID, Project ID, User ID)
`Filters[user Id]`	Filter by User ID
`Filters[ip Address]`	Filter by IP Address
`Page`	Page number
`Page Size`	Records per page
`User Id`	(Required) User ID
`Accept`	N/A
`Response Type`	N/A

GET Get audit log entries for an Account

/v2/accounts/{account_id}/events

Fetch audit logs with some filtering capabilities via query params

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Filters[start Date]`	Start ISO Date
`Filters[end Date]`	End ISO Date
`Filters[resource Type]`	Filter by Resource Type
`Filters[event Type]`	Filter by Type of Activity
`Filters[team Id]`	Filter by Team ID
`Filters[project Id]`	Filter by Project ID
`Filters[resource Id]`	Filter by resource ID (Asset ID, Project ID, User ID)
`Filters[user Id]`	Filter by User ID
`Filters[ip Address]`	Filter by IP Address This supports both IPv4 (1.1.1.1) and IPv6 (2001:db8:3333:4444:5555:6666:7777:8888)
`Page`	Page number
`Page Size`	Records per page
`Account Id`	(Required) Account ID
`Accept`	N/A
`Response Type`	N/A

Health

GET Status check

/health

Check status of the Frame.io API

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Accept`	N/A
`Response Type`	N/A

Heartbeat

POST Heartbeat ping

/v2/devices/heartbeat

Ommit heartbeat event to Frame.io. This powers the device "online" status in the C2C Connections tab on iOS and Web.

This should be called no more then once a minute, and no less than once every 5 minutes.

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`X-client-version`	Firmware or software version of a C2C integration. Will be used to determine the correct Device Model configuration for the device when multiple are available. Must be a valid semantic version. For more on semantic versions, see here: https://semver.org/
`Accept`	N/A
`Response Type`	N/A

Hooks (2)

POST Create team webhook

/v2/teams/{team_id}/hooks

Create an outbound Webhook for all appropriate actions for a given Team

Parameters

Parameter Name	Description
`Content Type`	N/A
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Team Id`	(Required)
`Accept`	N/A
`Response Type`	N/A

Options (3)

Option Name	Description
`Url`	N/A
`Name`	N/A
`Events`	N/A

GET Get Webhooks for Account

/v2/accounts/{account_id}/hooks

Get Webhooks belonging to a given Account

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Account Id`	(Required)
`Accept`	N/A
`Response Type`	N/A

Impressions

GET Get impressions

/v2/comments/{comment_id}/impressions

Fetch a list of who has 'seen' your comment

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Include`	N/A
`Comment Id`	(Required)
`Accept`	N/A
`Response Type`	N/A

Library (2)

GET Advanced search for Assets

/v2/search/library

Advanced Asset Search

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Account Id`	N/A
`Include Deleted`	Flag to include soft-deleted records in results
`Page`	The page to retrieve
`Page Size`	The number of results to include in the page
`Q`	Search text
`Query`	Search text
`Sort`	Sorting parameters
`Accept`	N/A
`Response Type`	N/A

POST Advanced search for Assets

/v2/search/library

Search using ElasticSearch key/value pairs

Parameters

Parameter Name	Description
`Content Type`	N/A
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Accept`	N/A
`Response Type`	N/A

Options (9)

Option Name	Description
`Account Id`	N/A
`Filter`	N/A
`Include Deleted`	N/A
`Opts`	N/A
`Page`	N/A
`Page Size`	N/A
`Q`	N/A
`Query`	N/A
`Sort`	N/A

Like (2)

POST Create a Like on a Comment

/v2/comments/{comment_id}/like

Leave a thumbs-up on a Comment

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Comment Id`	(Required)
`Accept`	N/A
`Response Type`	N/A

DELETE Delete a like from a comment

/v2/comments/{comment_id}/like

Remove a Like from a Comment

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Comment Id`	(Required)
`Accept`	N/A
`Response Type`	N/A

Me (2)

GET Device Information

/v2/devices/me

Fetches information about the current device connection.

Can be used to verify authorization token and returns information useful to present useful information in your user interface.

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`X-client-version`	Firmware or software version of a C2C integration. Will be used to determine the correct Device Model configuration for the device when multiple are available. Must be a valid semantic version. For more on semantic versions, see here: https://semver.org/
`Accept`	N/A
`Response Type`	N/A

GET Get the current authenticated User

/v2/me

Get information about the currently authenticated user

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Accept`	N/A
`Response Type`	N/A

Members (2)

POST Add a Team member

/v2/teams/{team_id}/members

Add a Team member to a given Team

Parameters

Parameter Name	Description
`Content Type`	N/A
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Team Id`	(Required)
`Accept`	N/A
`Response Type`	N/A

Options (3)

Option Name	Description
`Email`	N/A
`Role`	N/A
`User Id`	N/A

GET Get Team Members

/v2/teams/{team_id}/members

List the members on a given Team

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Team Id`	(Required) Team ID
`Accept`	N/A
`Response Type`	N/A

Membership (3)

GET Get Account membership

/v2/accounts/{account_id}/membership

Get the membership status for the auth token making the request

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Account Id`	(Required)
`Accept`	N/A
`Response Type`	N/A

GET Get current User(s) membership for a Project

/v2/projects/{project_id}/membership

Get the Membership context for a given user within a Project via its ID

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`User Id`	N/A
`Project Id`	(Required)
`Accept`	N/A
`Response Type`	N/A

GET Get user membership for team

/v2/teams/{team_id}/membership

Get currently authed User's membership within a particular Team

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Team Id`	(Required)
`Accept`	N/A
`Response Type`	N/A

Move

POST Move asset

/v2/assets/{destination_folder}/move

Move an asset to a new location

Parameters

Parameter Name	Description
`Content Type`	N/A
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Destination Folder`	(Required) Destination folder id
`Accept`	N/A
`Response Type`	N/A

Options (1)

Option Name	Description
`Id`	N/A

Notifications

GET Get Grouped Notifications

/v2/notifications

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Accept`	N/A
`Response Type`	N/A

Parts (2)

POST Request upload URLs for real-time upload

/v2/assets/{asset_id}/realtime_upload/parts

Parameters

Parameter Name	Description
`Content Type`	N/A
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Asset Id`	(Required) Asset ID
`Accept`	N/A
`Response Type`	N/A

Options (2)

Option Name	Description
`Asset Name`	N/A
`Asset Filesize`	N/A

POST Request upload URLs for real-time upload

/v2/devices/assets/{asset_id}/realtime_upload/parts

Parameters

Parameter Name	Description
`Content Type`	N/A
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Asset Id`	(Required) Asset ID
`X-client-version`	Firmware or software version of a C2C integration. Will be used to determine the correct Device Model configuration for the device when multiple are available. Must be a valid semantic version. For more on semantic versions, see here: https://semver.org/
`Accept`	N/A
`Response Type`	N/A

Options (2)

Option Name	Description
`Asset Name`	N/A
`Asset Filesize`	N/A

Presentations (4)

POST Create a Presentation Link for an asset

/v2/assets/{asset_id}/presentations

Create a new Presentation Link

Parameters

Parameter Name	Description
`Content Type`	N/A
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Asset Id`	(Required)
`Accept`	N/A
`Response Type`	N/A

Options (21)

Option Name	Description
`Project Id`	N/A
`Owner Id`	N/A
`Asset Id`	N/A
`Autoplay`	N/A
`Background Color`	N/A
`Can Download`	N/A
`Color`	N/A
`Deleted At`	N/A
`Description`	N/A
`Enabled`	N/A
`Expires At`	N/A
`Format`	N/A
`Include Ext`	N/A
`Include Upload Date`	N/A
`Layout`	N/A
`Name`	N/A
`Password`	N/A
`Secure`	N/A
`Style`	N/A
`Text Color`	N/A
`Title`	N/A

GET Get Presentation Links for a particular asset

/v2/assets/{asset_id}/presentations

Get a paginated list of Presentation Links attached to a particular asset ID

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Asset Id`	(Required)
`Accept`	N/A
`Response Type`	N/A

GET Get a paginated list of Presentations

/v2/projects/{project_id}/presentations

Get a paginated list of Presentations

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Project Id`	(Required)
`Accept`	N/A
`Response Type`	N/A

GET Get global presentation links

/v2/presentations

Get recently created Presentation Links across a user's account

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Accept`	N/A
`Response Type`	N/A

Projects (3)

POST Create a Project

/v2/teams/{team_id}/projects

Create a new Project belonging to a Team

Parameters

Parameter Name	Description
`Content Type`	N/A
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Team Id`	(Required)
`Accept`	N/A
`Response Type`	N/A

Options (2)

Option Name	Description
`Name`	N/A
`Private`	N/A

GET Get Projects by Team

/v2/teams/{team_id}/projects

Fetch a paginated list of all Projects belonging to a Team

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Filter[archived]`	Add this query param with the value all to return both archived and non-archived projects
`Team Id`	(Required)
`Accept`	N/A
`Response Type`	N/A

GET List projects for account

/v2/devices/accounts/{account_id}/projects

List available Projects to pair your C2C device with.

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Account Id`	(Required) Account ID
`X-client-version`	Firmware or software version of a C2C integration. Will be used to determine the correct Device Model configuration for the device when multiple are available. Must be a valid semantic version. For more on semantic versions, see here: https://semver.org/
`Accept`	N/A
`Response Type`	N/A

Replies (2)

GET Get comments and replies

/v2/comments/{comment_id}/replies

Fetch all Comments and Replies for a given Comment or Reply ID

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Include`	N/A
`Comment Id`	(Required)
`Accept`	N/A
`Response Type`	N/A

POST Leave a Reply on a Comment

/v2/comments/{comment_id}/replies

Review_links (2)

POST Create a Review Link

/v2/projects/{project_id}/review_links

Create a new Review Link in a given Project

Parameters

Parameter Name	Description
`Content Type`	N/A
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Project Id`	(Required)
`Accept`	N/A
`Response Type`	N/A

Options (8)

Option Name	Description
`Name`	N/A
`Allow Approvals`	N/A
`Current Version Only`	N/A
`Enable Downloading`	N/A
`Enable Comments`	N/A
`Is Active`	N/A
`Password`	N/A
`Watermark User Input`	N/A

GET List Review Links in a project

/v2/projects/{project_id}/review_links

List all the Review Links belonging to a Project

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Project Id`	(Required)
`Accept`	N/A
`Response Type`	N/A

Reviewers (2)

POST Invite Reviewer to a Review Link

/v2/review_links/{review_link_id}/reviewers

Invite a Reviewer to a Review Link

Parameters

Parameter Name	Description
`Content Type`	N/A
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Review Link Id`	(Required)
`Accept`	N/A
`Response Type`	N/A

Options (2)

Option Name	Description
`Email`	N/A
`Message`	N/A

DELETE Remove Reviewers from a Review Link

/v2/review_links/{review_link_id}/reviewers

Remove access for a Reviewer to a Review Link

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Review Link Id`	(Required)
`Accept`	N/A
`Response Type`	N/A

Revoke

POST Revoke Device Authorization

/v2/auth/revoke

Revoke device authorization

Parameters

Parameter Name	Description
`Content Type`	N/A
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`X-client-version`	Firmware or software version of a C2C integration. Will be used to determine the correct Device Model configuration for the device when multiple are available. Must be a valid semantic version. For more on semantic versions, see here: https://semver.org/
`Content-type`	N/A
`Accept`	N/A
`Response Type`	N/A

Options (3)

Option Name	Description
`Client Id`	Must be a unique identifier per hardware device, such as a unique hardware serial number. Must be the same client_id used on initial authorization.
`Client Secret`	A static string, provided by Frame.io to be embedded for a device manufacturer/model. Acts as an identifier within Frame.io.
`Token`	N/A

Shared (3)

GET Get Projects where User is a Collaborator

/v2/projects/shared

Fetch all of the Projects that a User has Collaborator access to (not team-member)

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Filter[account Id]`	Filter projects to those belonging to the specified account
`Filter[archived]`	Filter projects by archival status
`Filter[name]`	Filter projects by name
`Page`	The current page number in this Paginated Response
`Page Size`	Number of pages in this Paginated Response
`Accept`	N/A
`Response Type`	N/A

GET Get items in a Review Link

/v2/review_links/{review_link_id}/items/shared

Fetch the list of items (assets, folders, and version stacks) on a given Review Link

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Include`	N/A
`Review Link Id`	(Required)
`Accept`	N/A
`Response Type`	N/A

DELETE Remove items from a Review Link

/v2/review_links/{review_link_id}/items/shared

Remove a list of asset_ids from the assets shared in a Review Link

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Review Link Id`	(Required)
`Accept`	N/A
`Response Type`	N/A

Subtitles

GET Get the subtitles for an Asset

/v2/assets/{asset_id}/subtitles

Fetch subtitles that have been hoisted out by the media pipeline

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Asset Id`	(Required)
`Accept`	N/A
`Response Type`	N/A

Teams (3)

POST Create a Team for the given Account

/v2/accounts/{account_id}/teams

Create a new Team inside the given Account.

_Limited to Pro and Enterprise plans_

Parameters

Parameter Name	Description
`Content Type`	N/A
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Account Id`	(Required)
`Accept`	N/A
`Response Type`	N/A

Options (16)

Option Name	Description
`Access`	N/A
`Account Id`	N/A
`Background Color`	N/A
`Bio`	N/A
`Color`	N/A
`Colors`	N/A
`Dark Theme`	N/A
`Default Session Watermark Template Id`	N/A
`Font Color`	N/A
`Link`	N/A
`Location`	N/A
`Member Limit`	N/A
`Name`	N/A
`Slack Webhook`	N/A
`Solo`	N/A
`Storage Limit`	N/A

GET Get Teams for User

/v2/teams

Return an array of all the Teams a user has access to

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Accept`	N/A
`Response Type`	N/A

GET Get all Teams on an Account

/v2/accounts/{account_id}/teams

Return an array of all of the Teams accessible via a given Account

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Include`	N/A
`Account Id`	(Required)
`Accept`	N/A
`Response Type`	N/A

Trigger

POST Trigger a real-time logging event

/v2/devices/channels/{channel_id}/inputs/{input_index}/trigger

Triggers an event on the device channel.

Can be used for logging a quick comment, or for other things that haven't been dreamed up yet!

Parameters

Parameter Name	Description
`Content Type`	N/A
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Channel Id`	(Required) Device channel id
`Input Index`	(Required) An 0-indexed integer that will be used to identify the input
`X-client-version`	Firmware or software version of a C2C integration. Will be used to determine the correct Device Model configuration for the device when multiple are available. Must be a valid semantic version. For more on semantic versions, see here: https://semver.org/
`Accept`	N/A
`Response Type`	N/A

Options (2)

Option Name	Description
`Action Type`	N/A
`Offset`	N/A

Unversion

DELETE Unversion an Asset

/v2/assets/{asset_id}/unversion

Unversion an Asset from a Version Stack

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Asset Id`	(Required)
`Accept`	N/A
`Response Type`	N/A

Version

POST Version an Asset

/v2/assets/{asset_id}/version

Add an asset to a version stack, or create one if one doesn't already exist

Parameters

Parameter Name	Description
`Content Type`	N/A
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Asset Id`	(Required)
`Accept`	N/A
`Response Type`	N/A

Options (1)

Option Name	Description
`Next Asset Id`	N/A

{account_id}

GET Get Account

/v2/accounts/{account_id}

Fetch a particular account by ID

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Account Id`	(Required) Account ID
`Accept`	N/A
`Response Type`	N/A

{action_id} (3)

DELETE Delete a Custom Action

/v2/actions/{action_id}

Delete a given Custom Action via its ID

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Action Id`	(Required) Custom Action ID
`Accept`	N/A
`Response Type`	N/A

GET Get a Custom Action by ID

/v2/actions/{action_id}

Get a Custom Action via its ID

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Action Id`	(Required) Custom Action ID
`Accept`	N/A
`Response Type`	N/A

PUT Update a Custom Action

/v2/actions/{action_id}

Update a given Custom Action via its ID

Parameters

Parameter Name	Description
`Content Type`	N/A
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Action Id`	(Required) Custom Action ID
`Accept`	N/A
`Response Type`	N/A

Options (6)

Option Name	Description
`Url`	N/A
`Name`	N/A
`Event`	N/A
`Description`	N/A
`Allow Collaborators`	N/A
`Include`	N/A

{asset_id} (3)

DELETE Delete an Asset

/v2/assets/{asset_id}

Delete the referenced Asset ID

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Asset Id`	(Required)
`Accept`	N/A
`Response Type`	N/A

GET Get an Asset

/v2/assets/{asset_id}

Fetch the full Asset manifest

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Include Deleted`	N/A
`Type`	N/A
`Asset Id`	(Required)
`Accept`	N/A
`Response Type`	N/A

PUT Update an Asset

/v2/assets/{asset_id}

Update the manifest on an Asset

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Asset Id`	(Required)
`Accept`	N/A
`Response Type`	N/A

{comment_id} (3)

DELETE Delete a Comment

/v2/comments/{comment_id}

Delete a Comment or Reply using its ID

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Comment Id`	(Required) Comment ID
`Accept`	N/A
`Response Type`	N/A

GET Get a Comment by ID

/v2/comments/{comment_id}

Fetch a Comment by its ID

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Include`	N/A
`Comment Id`	(Required) Comment ID
`Accept`	N/A
`Response Type`	N/A

PUT Update a Comment

/v2/comments/{comment_id}

Update a Comment via its ID, overwriting only the passed key/value pairs

Parameters

Parameter Name	Description
`Content Type`	N/A
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Comment Id`	(Required) Comment ID
`Accept`	N/A
`Response Type`	N/A

Options (8)

Option Name	Description
`Text`	N/A
`Annotation`	N/A
`Page`	N/A
`Pitch`	N/A
`Timestamp`	N/A
`Yaw`	N/A
`Duration`	N/A
`Private`	N/A

{hook_id} (3)

DELETE Delete webhook

/v2/hooks/{hook_id}

Delete a given Webhook via its ID

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Hook Id`	(Required) Webhook ID
`Accept`	N/A
`Response Type`	N/A

GET Get Webhook by ID

/v2/hooks/{hook_id}

Get the information about a given Webhook

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Hook Id`	(Required) Webhook ID
`Accept`	N/A
`Response Type`	N/A

PUT Update webhook

/v2/hooks/{hook_id}

Update the settings for a given Webhook via its ID

Parameters

Parameter Name	Description
`Content Type`	N/A
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Hook Id`	(Required) Webhook ID
`Accept`	N/A
`Response Type`	N/A

Options (3)

Option Name	Description
`Url`	N/A
`Name`	N/A
`Events`	N/A

{presentation_id} (3)

DELETE Delete a Presentation

/v2/presentations/{presentation_id}

Delete a given Presentation Link

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Presentation Id`	(Required) Presentation Link ID
`Accept`	N/A
`Response Type`	N/A

GET Show a Presentation

/v2/presentations/{presentation_id}

Fetch a particular presentaiton link's id

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Presentation Id`	(Required) Presentation Link ID
`Accept`	N/A
`Response Type`	N/A

PUT Update a Presentation

/v2/presentations/{presentation_id}

Update a Presentation Link via it's ID

Parameters

Parameter Name	Description
`Content Type`	N/A
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Presentation Id`	(Required) Presentation Link ID
`Accept`	N/A
`Response Type`	N/A

Options (21)

Option Name	Description
`Asset Id`	N/A
`Autoplay`	N/A
`Background Color`	N/A
`Can Download`	N/A
`Color`	N/A
`Deleted At`	N/A
`Description`	N/A
`Enabled`	N/A
`Expires At`	N/A
`Format`	N/A
`Include Ext`	N/A
`Include Upload Date`	N/A
`Layout`	N/A
`Name`	N/A
`Owner Id`	N/A
`Password`	N/A
`Project Id`	N/A
`Secure`	N/A
`Style`	N/A
`Text Color`	N/A
`Title`	N/A

{project_id} (3)

DELETE Delete Project by ID

/v2/projects/{project_id}

Delete a Project via its ID

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Project Id`	(Required) Project ID
`Accept`	N/A
`Response Type`	N/A

GET Get Project by ID

/v2/projects/{project_id}

Fetch a Project via its ID

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Include`	N/A
`Project Id`	(Required) Project ID
`Accept`	N/A
`Response Type`	N/A

PUT Update a Project

/v2/projects/{project_id}

Update a Project ID with only the fields provided (overwrite)

Parameters

Parameter Name	Description
`Content Type`	N/A
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Project Id`	(Required) Project ID
`Accept`	N/A
`Response Type`	N/A

Options (2)

Option Name	Description
`Name`	N/A
`Private`	N/A

{review_link_id} (3)

DELETE Delete a Review Link

/v2/review_links/{review_link_id}

Delete a given Review Link

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Review Link Id`	(Required)
`Accept`	N/A
`Response Type`	N/A

GET Get a Review Link

/v2/review_links/{review_link_id}

Get a full Review Link manifest

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Include`	N/A
`Review Link Id`	(Required)
`Accept`	N/A
`Response Type`	N/A

PUT Update a Review Link

/v2/review_links/{review_link_id}

Update a Review Links manifest, overwriting any specified key/value pairs

Parameters

Parameter Name	Description
`Content Type`	N/A
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Review Link Id`	(Required)
`Accept`	N/A
`Response Type`	N/A

Options (8)

Option Name	Description
`Name`	N/A
`Allow Approvals`	N/A
`Current Version Only`	N/A
`Enable Downloading`	N/A
`Enable Comments`	N/A
`Is Active`	N/A
`Password`	N/A
`Watermark User Input`	N/A

{team_id}

GET Get a Team

/v2/teams/{team_id}

Fetch a given Team's information by ID

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Include`	N/A
`Team Id`	(Required) Team ID
`Accept`	N/A
`Response Type`	N/A