Version 1.0
Connector Overview: This page documents all 101 actions for the Frameconnector v1.0.
Accounts (2)
GET Get Accounts for User
/v2/accounts
Fetch all Accounts that a given User has access to
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Specifies the expected response content type, such as "application/json". |
|
|
The response format expected from the API (e.g. application/json). |
GET List accounts
/v2/devices/accounts
List available accounts to pair your C2C device with.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
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/ |
|
|
Sets the desired format for the response, typically "application/json". |
|
|
The response format expected from the API (e.g. application/json). |
Actions (3)
POST Create a Custom Action
/v2/teams/{team_id}/actions
Create a Custom Action belonging to A Team
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
(Required) |
|
|
Specifies the expected response content type. |
|
|
The response format expected from the API (e.g. application/json). |
Options (6)
|
Option Name |
Description |
|---|---|
|
|
The URL that the action will trigger. |
|
|
A human-readable name for the custom action. |
|
|
The event that triggers this action. |
|
|
An optional description explaining the action's purpose. |
|
|
Whether collaborators on the team are allowed to use this action. |
|
|
Additional data to include in the action request. |
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 |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Specifies related data to include in the response, such as "team" or "creator". |
|
|
(Required) |
|
|
Sets the expected response content type. |
|
|
The response format expected from the API (e.g. application/json). |
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 |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Determines which related resources to embed in the response. |
|
|
(Required) |
|
|
Indicates the desired response format. |
|
|
The response format expected from the API (e.g. application/json). |
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 |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
(Required) |
|
|
Specifies the expected content type of the response. |
|
|
The response format expected from the API (e.g. application/json). |
Options (1)
|
Option Name |
Description |
|---|---|
|
|
An array of asset identifiers to add to the review link. |
DELETE Bulk delete assets
/v2/batch/assets
Delete a list of Assets
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Sets the desired response content type. |
|
|
The response format expected from the API (e.g. application/json). |
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 |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
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/ |
|
|
Expected response format. |
|
|
The response format expected from the API (e.g. application/json). |
Options (9)
|
Option Name |
Description |
|---|---|
|
|
The filename for the asset. |
|
|
The file extension (e.g., "jpg"). |
|
|
The MIME type of the file. |
|
|
An identifier for automatic versioning. |
|
|
Whether the asset is uploaded in real time. |
|
|
The size of the file in bytes. |
|
|
The camera channel number. |
|
|
The byte offset for chunked uploads. |
|
|
Number of parts for multipart upload. |
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 |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
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/ |
|
|
Expected response format. |
|
|
The response format expected from the API (e.g. application/json). |
Options (9)
|
Option Name |
Description |
|---|---|
|
|
The filename for the asset. |
|
|
The file extension (e.g., "jpg"). |
|
|
The MIME type of the file. |
|
|
An identifier for automatic versioning. |
|
|
Whether the asset is uploaded in real time. |
|
|
The size of the file in bytes. |
|
|
The camera channel number. |
|
|
The byte offset for chunked uploads. |
|
|
Number of parts for multipart upload. |
GET Search for Assets
/v2/search/assets
Search for Assets via query parameters
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Filter assets by the owning account's identifier. |
|
|
Additional data to embed in the results. |
|
|
Flag to include soft-deleted records in results |
|
|
The page to retrieve |
|
|
The number of results to include in the page |
|
|
Filter assets by project. |
|
|
Search text |
|
|
Search text |
|
|
Filter by shared project identifiers. |
|
|
Sorting parameters |
|
|
Filter assets by team. |
|
|
Filter by asset type (e.g., "image", "video"). |
|
|
Expected response content type. |
|
|
The response format expected from the API (e.g. application/json). |
POST Search for Assets
/v2/search/assets
Search for Assets using a JSON payload
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Expected response content type. |
|
|
The response format expected from the API (e.g. application/json). |
Options (15)
|
Option Name |
Description |
|---|---|
|
|
Filter assets belonging to a specific account by providing its unique identifier. |
|
|
Apply a predefined filter to narrow down the asset search results. |
|
|
Additional data to include in the action request. |
|
|
Set to "true" to include deleted assets in the search results. |
|
|
Provide additional options or flags to customize the search behavior. |
|
|
Specify the page number of results to retrieve for paginated responses. |
|
|
Set the number of assets to return per page, controlling the result set size. |
|
|
Filter assets that belong to a specific project by supplying its project ID. |
|
|
Pass a JSON string of property filters to match assets with specific custom properties. |
|
|
Enter a free-text query string to search asset names or descriptions. |
|
|
Provide a structured query string for more complex search criteria. |
|
|
Set to "true" to include assets from projects shared with the current context. |
|
|
Specify the field and order (e.g., "name:asc") to sort the search results. |
|
|
Filter assets belonging to a specific team by providing its team identifier. |
|
|
Filter assets by their type, such as "image" or "video", to restrict results. |
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 |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
(Required) |
|
|
Expected response content type. |
|
|
The response format expected from the API (e.g. application/json). |
Options (1)
|
Option Name |
Description |
|---|---|
|
|
An array of asset identifiers to add to the review link. |
Audio
GET Get audio for an Asset
/v2/assets/{asset_id}/audio
Fetch the audio tracks for a given Asset
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
(Required) |
|
|
Expected response content type. |
|
|
The response format expected from the API (e.g. application/json). |
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 |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Filter by Item ID (Asset ID, Project ID, User ID) |
|
|
Filter by log datetime using logical operators |
|
|
ISO Datetime |
|
|
Filter by Item Type |
|
|
Filter by Action |
|
|
Filter by Actor ID |
|
|
Filter by Team ID |
|
|
Filter by IP Address This supports both IPv4 (1.1.1.1) and IPv6 (2001:db8:3333:4444:5555:6666:7777:8888) |
|
|
Page number |
|
|
Records per page |
|
|
(Required) Account ID |
|
|
Expected response content type. |
|
|
The response format expected from the API (e.g. application/json). |
Channels
POST Connect a new device channel
/v2/devices/channels
We can connect a new channel with the following request
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
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/ |
|
|
Expected response content type. |
|
|
The response format expected from the API (e.g. application/json). |
Options (2)
|
Option Name |
Description |
|---|---|
|
|
Provide the unique identifier of the client to associate with the device channel. |
|
|
Specify the device model ID to identify the type of device being connected. |
Children (2)
POST Create an Asset
/v2/assets/{asset_id}/children
Create a new asset.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
(Required) |
|
|
Expected response content type. |
|
|
The response format expected from the API (e.g. application/json). |
Options (8)
|
Option Name |
Description |
|---|---|
|
|
Set the asset type for the new child asset, e.g., "file" or "folder". |
|
|
The filename for the asset. |
|
|
The file extension (e.g., "jpg"). |
|
|
The MIME type of the file. |
|
|
Whether the asset is uploaded in real time. |
|
|
An optional description explaining the action's purpose. |
|
|
The size of the file in bytes. |
|
|
Provide a JSON string of custom properties to assign to the new child asset. |
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 |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Include deleted files by passing true |
|
|
Include additional "pre-loads" for related resources |
|
|
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. |
|
|
The current page number in this Paginated Response |
|
|
Number of pages in this Paginated Response |
|
|
(Required) |
|
|
Expected response content type. |
|
|
The response format expected from the API (e.g. application/json). |
Code
POST Request device code
/v2/device/code
Request a device code to initiate the OAuth device authorization flow for authentication.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
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/ |
|
|
Set the Content-Type header to specify the media type of the request body, typically "application/json". |
|
|
Expected response content type. |
|
|
The response format expected from the API (e.g. application/json). |
Options (3)
|
Option Name |
Description |
|---|---|
|
|
(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. |
|
|
(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 |
|
|
(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 |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Include additional "pre-loads" for this resource |
|
|
(Required) |
|
|
Expected response content type. |
|
|
The response format expected from the API (e.g. application/json). |
Options (1)
|
Option Name |
Description |
|---|---|
|
|
Enter the email address of the user to be added as a collaborator to the project. |
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 |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
(Required) |
|
|
Expected response content type. |
|
|
The response format expected from the API (e.g. application/json). |
Options (2)
|
Option Name |
Description |
|---|---|
|
|
Provide a default message to include in invitation emails sent to new collaborators. |
|
|
Set to "true" to send invitation emails to the newly created collaborators; "false" to skip email notifications. |
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 |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
(Required) |
|
|
Expected response content type. |
|
|
The response format expected from the API (e.g. application/json). |
GET Get Project Collaborators
/v2/projects/{project_id}/collaborators
Fetch the list of Collaborators with access to a Project.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
(Required) Project ID |
|
|
Expected response content type. |
|
|
The response format expected from the API (e.g. application/json). |
Comments (2)
POST Create a Comment
/v2/assets/{asset_id}/comments
Leave a Comment on an Asset
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
(Required) |
|
|
Expected response content type. |
|
|
The response format expected from the API (e.g. application/json). |
Options (8)
|
Option Name |
Description |
|---|---|
|
|
The textual content of the comment. |
|
|
An annotation identifier to attach to the comment, such as a shape or region reference. |
|
|
Specify the page number of results to retrieve for paginated responses. |
|
|
The pitch angle (in degrees) for a spatial comment, measured from the camera's forward direction. |
|
|
A timestamp value indicating a specific point in time for a time‑based comment. |
|
|
The yaw angle (in degrees) for a spatial comment, measured from the camera's forward direction. |
|
|
The duration (in seconds) for a time‑based comment to remain visible or active. |
|
|
A flag indicating whether the comment should be visible only to the comment author; expects a string like "true" or "false". |
GET Get all the Comments and Replies from a Comment thread
/v2/assets/{asset_id}/comments
This endpoint will return all comments and replies in a flat list.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional data to embed in the results. |
|
|
(Required) |
|
|
Expected response content type. |
|
|
The response format expected from the API (e.g. application/json). |
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 |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
(Required) |
|
|
Expected response content type. |
|
|
The response format expected from the API (e.g. application/json). |
POST Mark completed
/v2/comments/{comment_id}/complete
Complete a "Task" on a given Comment
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
(Required) |
|
|
Expected response content type. |
|
|
The response format expected from the API (e.g. application/json). |
Connect
POST Connect device
/v2/devices/connect
Connect to the provided C2C Project.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
The project_id you intend to connect to |
|
|
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/ |
|
|
Expected response content type. |
|
|
The response format expected from the API (e.g. application/json). |
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 |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
(Required) Destination folder id - must be in the same folder |
|
|
Expected response content type. |
|
|
The response format expected from the API (e.g. application/json). |
Options (1)
|
Option Name |
Description |
|---|---|
|
|
Whether to copy the comments associated with the assets; expects a string value such as "true" or "false". |
POST Copy asset
/v2/assets/{destination_folder}/copy
Copy an Asset to a new location
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
(Required) Destination folder id |
|
|
Expected response content type. |
|
|
The response format expected from the API (e.g. application/json). |
Options (1)
|
Option Name |
Description |
|---|---|
|
|
The unique identifier of the asset to be copied. |
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 |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
(Required) Device channel id |
|
|
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/ |
|
|
Expected response content type. |
|
|
The response format expected from the API (e.g. application/json). |
POST Disconnect all device channels
/v2/devices/channels/disconnect
Disconnects all connected device channels
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
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/ |
|
|
Expected response content type. |
|
|
The response format expected from the API (e.g. application/json). |
POST Disconnect device
/v2/devices/disconnect
Disconnect the device from the project it's currently connected to.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
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/ |
|
|
The response format expected from the API (e.g. application/json). |
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 |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Start ISO Date |
|
|
End ISO Date |
|
|
Filter by Resource Type |
|
|
Filter by Type of Activity |
|
|
Filter by Team ID |
|
|
Filter by Project ID |
|
|
Filter by resource ID (Asset ID, Project ID, User ID) |
|
|
Filter by User ID |
|
|
Filter by IP Address |
|
|
Page number |
|
|
Records per page |
|
|
(Required) User ID |
|
|
Expected response content type. |
|
|
The response format expected from the API (e.g. application/json). |
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 |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Start ISO Date |
|
|
End ISO Date |
|
|
Filter by Resource Type |
|
|
Filter by Type of Activity |
|
|
Filter by Team ID |
|
|
Filter by Project ID |
|
|
Filter by resource ID (Asset ID, Project ID, User ID) |
|
|
Filter by User ID |
|
|
Filter by IP Address This supports both IPv4 (1.1.1.1) and IPv6 (2001:db8:3333:4444:5555:6666:7777:8888) |
|
|
Page number |
|
|
Records per page |
|
|
(Required) Account ID |
|
|
Expected response content type. |
|
|
The response format expected from the API (e.g. application/json). |
Health
GET Status check
/health
Check status of the Frame.io API
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Expected response content type. |
|
|
The response format expected from the API (e.g. application/json). |
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 |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
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/ |
|
|
Expected response content type. |
|
|
The response format expected from the API (e.g. application/json). |
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 |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
(Required) |
|
|
Expected response content type. |
|
|
The response format expected from the API (e.g. application/json). |
Options (3)
|
Option Name |
Description |
|---|---|
|
|
The URL that the action will trigger. |
|
|
The filename for the asset. |
|
|
A JSON array of event type strings that will trigger the webhook. |
GET Get Webhooks for Account
/v2/accounts/{account_id}/hooks
Get Webhooks belonging to a given Account
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
(Required) |
|
|
Expected response content type. |
|
|
The response format expected from the API (e.g. application/json). |
Impressions
GET Get impressions
/v2/comments/{comment_id}/impressions
Fetch a list of who has 'seen' your comment
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional data to embed in the results. |
|
|
(Required) |
|
|
Expected response content type. |
|
|
The response format expected from the API (e.g. application/json). |
Library (2)
GET Advanced search for Assets
/v2/search/library
Advanced Asset Search
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Filter assets by the owning account's identifier. |
|
|
Flag to include soft-deleted records in results |
|
|
The page to retrieve |
|
|
The number of results to include in the page |
|
|
Search text |
|
|
Search text |
|
|
Sorting parameters |
|
|
Expected response content type. |
|
|
The response format expected from the API (e.g. application/json). |
POST Advanced search for Assets
/v2/search/library
Search using ElasticSearch key/value pairs
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Expected response content type. |
|
|
The response format expected from the API (e.g. application/json). |
Options (9)
|
Option Name |
Description |
|---|---|
|
|
Filter assets belonging to a specific account by providing its unique identifier. |
|
|
Apply a predefined filter to narrow down the asset search results. |
|
|
Set to "true" to include deleted assets in the search results. |
|
|
Provide additional options or flags to customize the search behavior. |
|
|
Specify the page number of results to retrieve for paginated responses. |
|
|
Set the number of assets to return per page, controlling the result set size. |
|
|
Enter a free-text query string to search asset names or descriptions. |
|
|
Provide a structured query string for more complex search criteria. |
|
|
Specify the field and order (e.g., "name:asc") to sort the search results. |
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 |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
(Required) |
|
|
Expected response content type. |
|
|
The response format expected from the API (e.g. application/json). |
DELETE Delete a like from a comment
/v2/comments/{comment_id}/like
Remove a Like from a Comment
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
(Required) |
|
|
Expected response content type. |
|
|
The response format expected from the API (e.g. application/json). |
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 |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
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/ |
|
|
Expected response content type. |
|
|
The response format expected from the API (e.g. application/json). |
GET Get the current authenticated User
/v2/me
Get information about the currently authenticated user
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Expected response content type. |
|
|
The response format expected from the API (e.g. application/json). |
Members (2)
POST Add a Team member
/v2/teams/{team_id}/members
Add a Team member to a given Team
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
(Required) |
|
|
Expected response content type. |
|
|
The response format expected from the API (e.g. application/json). |
Options (3)
|
Option Name |
Description |
|---|---|
|
|
Enter the email address of the user to be added as a collaborator to the project. |
|
|
Specifies the role to assign to the new team member, such as "admin" or "member". |
|
|
Identifies the user to add as a team member. |
GET Get Team Members
/v2/teams/{team_id}/members
List the members on a given Team
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
(Required) Team ID |
|
|
Expected response content type. |
|
|
The response format expected from the API (e.g. application/json). |
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 |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
(Required) |
|
|
Expected response content type. |
|
|
The response format expected from the API (e.g. application/json). |
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 |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Filters the membership information for the specified user; omit to get the current user's membership. |
|
|
(Required) |
|
|
Expected response content type. |
|
|
The response format expected from the API (e.g. application/json). |
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 |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
(Required) |
|
|
Expected response content type. |
|
|
The response format expected from the API (e.g. application/json). |
Move
POST Move asset
/v2/assets/{destination_folder}/move
Move an asset to a new location
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
(Required) Destination folder id |
|
|
Expected response content type. |
|
|
The response format expected from the API (e.g. application/json). |
Options (1)
|
Option Name |
Description |
|---|---|
|
|
The unique identifier of the asset to be copied. |
Notifications
GET Get Grouped Notifications
/v2/notifications
Retrieve a list of notifications grouped by category or type for the authenticated user.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Expected response content type. |
|
|
The response format expected from the API (e.g. application/json). |
Parts (2)
POST Request upload URLs for real-time upload
/v2/assets/{asset_id}/realtime_upload/parts
Register real-time upload parts and generate presigned AWS S3 upload PUT URLs.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
(Required) Asset ID |
|
|
Expected response content type. |
|
|
The response format expected from the API (e.g. application/json). |
Options (2)
|
Option Name |
Description |
|---|---|
|
|
The name of the asset file to be uploaded. |
|
|
The total size of the asset file in bytes. |
POST Request upload URLs for real-time upload
/v2/devices/assets/{asset_id}/realtime_upload/parts
Register real-time upload parts and generate presigned AWS S3 upload PUT URLs.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
(Required) Asset ID |
|
|
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/ |
|
|
Expected response content type. |
|
|
The response format expected from the API (e.g. application/json). |
Options (2)
|
Option Name |
Description |
|---|---|
|
|
The name of the asset file to be uploaded. |
|
|
The total size of the asset file in bytes. |
Presentations (4)
POST Create a Presentation Link for an asset
/v2/assets/{asset_id}/presentations
Create a new Presentation Link
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
(Required) |
|
|
Expected response content type. |
|
|
The response format expected from the API (e.g. application/json). |
Options (21)
|
Option Name |
Description |
|---|---|
|
|
Filter assets that belong to a specific project by supplying its project ID. |
|
|
The unique identifier of the owner associated with the presentation link. |
|
|
The unique identifier of the asset to create the presentation for, overriding the path parameter. |
|
|
Indicates whether the presentation should start playing automatically when opened; expects a string like true or false. |
|
|
The background color of the presentation, specified as a color value (e.g., hex code or named color). |
|
|
Indicates whether viewers are allowed to download the asset from the presentation; expects a string like true or false. |
|
|
A general color setting for the presentation, such as an accent or theme color. |
|
|
The timestamp indicating when the presentation link was marked as deleted, if applicable. |
|
|
An optional description explaining the action's purpose. |
|
|
Indicates whether the presentation link is currently active and accessible; expects a string like true or false. |
|
|
The timestamp after which the presentation link will no longer be valid. |
|
|
The output format for the presentation, such as html or pdf. |
|
|
Indicates whether the file extension should be included in the presentation; expects a string like true or false. |
|
|
Indicates whether the upload date of the asset should be displayed in the presentation; expects a string like true or false. |
|
|
The layout style for the presentation, such as grid or list. |
|
|
The filename for the asset. |
|
|
A password required to view the presentation, if access is restricted. |
|
|
Indicates whether the presentation link should be served over HTTPS; expects a string like true or false. |
|
|
The visual style or theme applied to the presentation, such as light or dark. |
|
|
The color of the text displayed in the presentation, specified as a color value. |
|
|
A custom title for the presentation, overriding the asset's default name. |
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 |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
(Required) |
|
|
Expected response content type. |
|
|
The response format expected from the API (e.g. application/json). |
GET Get a paginated list of Presentations
/v2/projects/{project_id}/presentations
Get a paginated list of Presentations
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
(Required) |
|
|
Expected response content type. |
|
|
The response format expected from the API (e.g. application/json). |
GET Get global presentation links
/v2/presentations
Get recently created Presentation Links across a user's account
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Expected response content type. |
|
|
The response format expected from the API (e.g. application/json). |
Projects (3)
POST Create a Project
/v2/teams/{team_id}/projects
Create a new Project belonging to a Team
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
(Required) |
|
|
Expected response content type. |
|
|
The response format expected from the API (e.g. application/json). |
Options (2)
|
Option Name |
Description |
|---|---|
|
|
The filename for the asset. |
|
|
A flag indicating whether the comment should be visible only to the comment author; expects a string like "true" or "false". |
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 |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Add this query param with the value all to return both archived and non-archived projects |
|
|
(Required) |
|
|
Expected response content type. |
|
|
The response format expected from the API (e.g. application/json). |
GET List projects for account
/v2/devices/accounts/{account_id}/projects
List available Projects to pair your C2C device with.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
(Required) Account ID |
|
|
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/ |
|
|
Expected response content type. |
|
|
The response format expected from the API (e.g. application/json). |
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 |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional data to embed in the results. |
|
|
(Required) |
|
|
Expected response content type. |
|
|
The response format expected from the API (e.g. application/json). |
POST Leave a Reply on a Comment
/v2/comments/{comment_id}/replies
Leave a Reply on a given Comment
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
(Required) |
|
|
Expected response content type. |
|
|
The response format expected from the API (e.g. application/json). |
Options (8)
|
Option Name |
Description |
|---|---|
|
|
The textual content of the comment. |
|
|
An annotation identifier to attach to the comment, such as a shape or region reference. |
|
|
Specify the page number of results to retrieve for paginated responses. |
|
|
The pitch angle (in degrees) for a spatial comment, measured from the camera's forward direction. |
|
|
A timestamp value indicating a specific point in time for a time‑based comment. |
|
|
The yaw angle (in degrees) for a spatial comment, measured from the camera's forward direction. |
|
|
The duration (in seconds) for a time‑based comment to remain visible or active. |
|
|
A flag indicating whether the comment should be visible only to the comment author; expects a string like "true" or "false". |
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 |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
(Required) |
|
|
Expected response content type. |
|
|
The response format expected from the API (e.g. application/json). |
Options (8)
|
Option Name |
Description |
|---|---|
|
|
The filename for the asset. |
|
|
Whether to allow approvals on this review link. |
|
|
Whether to include only the current version in the review. |
|
|
Controls if reviewers can download assets from the review link. |
|
|
Whether to allow comments on the review link. |
|
|
Whether the review link is active and accessible. |
|
|
A password required to view the presentation, if access is restricted. |
|
|
Custom watermark text displayed on reviewed assets. |
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 |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
(Required) |
|
|
Expected response content type. |
|
|
The response format expected from the API (e.g. application/json). |
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 |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
(Required) |
|
|
Expected response content type. |
|
|
The response format expected from the API (e.g. application/json). |
Options (2)
|
Option Name |
Description |
|---|---|
|
|
Enter the email address of the user to be added as a collaborator to the project. |
|
|
The message to include in the invitation to the reviewer. |
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 |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
(Required) |
|
|
Expected response content type. |
|
|
The response format expected from the API (e.g. application/json). |
Revoke
POST Revoke Device Authorization
/v2/auth/revoke
Revoke device authorization
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
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/ |
|
|
Set the Content-Type header to specify the media type of the request body, typically "application/json". |
|
|
Expected response content type. |
|
|
The response format expected from the API (e.g. application/json). |
Options (3)
|
Option Name |
Description |
|---|---|
|
|
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. |
|
|
A static string, provided by Frame.io to be embedded for a device manufacturer/model. Acts as an identifier within Frame.io. |
|
|
The authorization token to revoke. |
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 |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Filter projects to those belonging to the specified account |
|
|
Filter projects by archival status |
|
|
Filter projects by name |
|
|
The current page number in this Paginated Response |
|
|
Number of pages in this Paginated Response |
|
|
Expected response content type. |
|
|
The response format expected from the API (e.g. application/json). |
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 |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional data to embed in the results. |
|
|
(Required) |
|
|
Expected response content type. |
|
|
The response format expected from the API (e.g. application/json). |
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 |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
(Required) |
|
|
Expected response content type. |
|
|
The response format expected from the API (e.g. application/json). |
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 |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
(Required) |
|
|
Expected response content type. |
|
|
The response format expected from the API (e.g. application/json). |
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 |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
(Required) |
|
|
Expected response content type. |
|
|
The response format expected from the API (e.g. application/json). |
Options (16)
|
Option Name |
Description |
|---|---|
|
|
The access level or visibility of the team. |
|
|
Filter assets belonging to a specific account by providing its unique identifier. |
|
|
The background color of the presentation, specified as a color value (e.g., hex code or named color). |
|
|
A short biography or description of the team. |
|
|
A general color setting for the presentation, such as an accent or theme color. |
|
|
Array of color values for team branding. |
|
|
Whether to enable dark theme for the team interface. |
|
|
Identifier of the default watermark template for sessions. |
|
|
The font color used for team branding. |
|
|
A URL link associated with the team. |
|
|
The geographic location or timezone of the team. |
|
|
The maximum number of members allowed in the team. |
|
|
The filename for the asset. |
|
|
Webhook URL for Slack integration notifications. |
|
|
Whether the team is a solo team with a single member. |
|
|
The maximum storage capacity allocated to the team. |
GET Get Teams for User
/v2/teams
Return an array of all the Teams a user has access to
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Expected response content type. |
|
|
The response format expected from the API (e.g. application/json). |
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 |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional data to embed in the results. |
|
|
(Required) |
|
|
Expected response content type. |
|
|
The response format expected from the API (e.g. application/json). |
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 |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
(Required) Device channel id |
|
|
(Required) An 0-indexed integer that will be used to identify the input |
|
|
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/ |
|
|
Expected response content type. |
|
|
The response format expected from the API (e.g. application/json). |
Options (2)
|
Option Name |
Description |
|---|---|
|
|
The type of action to trigger, such as 'start' or 'stop'. |
|
|
The byte offset for chunked uploads. |
Unversion
DELETE Unversion an Asset
/v2/assets/{asset_id}/unversion
Unversion an Asset from a Version Stack
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
(Required) |
|
|
Expected response content type. |
|
|
The response format expected from the API (e.g. application/json). |
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 |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
(Required) |
|
|
Expected response content type. |
|
|
The response format expected from the API (e.g. application/json). |
Options (1)
|
Option Name |
Description |
|---|---|
|
|
The ID of the asset to use as the next version. |
{account_id}
GET Get Account
/v2/accounts/{account_id}
Fetch a particular account by ID
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
(Required) Account ID |
|
|
Expected response content type. |
|
|
The response format expected from the API (e.g. application/json). |
{action_id} (3)
DELETE Delete a Custom Action
/v2/actions/{action_id}
Delete a given Custom Action via its ID
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
(Required) Custom Action ID |
|
|
Expected response content type. |
|
|
The response format expected from the API (e.g. application/json). |
GET Get a Custom Action by ID
/v2/actions/{action_id}
Get a Custom Action via its ID
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
(Required) Custom Action ID |
|
|
Expected response content type. |
|
|
The response format expected from the API (e.g. application/json). |
PUT Update a Custom Action
/v2/actions/{action_id}
Update a given Custom Action via its ID
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
(Required) Custom Action ID |
|
|
Expected response content type. |
|
|
The response format expected from the API (e.g. application/json). |
Options (6)
|
Option Name |
Description |
|---|---|
|
|
The URL that the action will trigger. |
|
|
The filename for the asset. |
|
|
The event that triggers this action. |
|
|
An optional description explaining the action's purpose. |
|
|
Whether collaborators on the team are allowed to use this action. |
|
|
Additional data to include in the action request. |
{asset_id} (3)
DELETE Delete an Asset
/v2/assets/{asset_id}
Delete the referenced Asset ID
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
(Required) |
|
|
Expected response content type. |
|
|
The response format expected from the API (e.g. application/json). |
GET Get an Asset
/v2/assets/{asset_id}
Fetch the full Asset manifest
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Whether to include deleted assets in the response. |
|
|
Filter by asset type (e.g., "image", "video"). |
|
|
(Required) |
|
|
Expected response content type. |
|
|
The response format expected from the API (e.g. application/json). |
PUT Update an Asset
/v2/assets/{asset_id}
Update the manifest on an Asset
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
(Required) |
|
|
Expected response content type. |
|
|
The response format expected from the API (e.g. application/json). |
{comment_id} (3)
DELETE Delete a Comment
/v2/comments/{comment_id}
Delete a Comment or Reply using its ID
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
(Required) Comment ID |
|
|
Expected response content type. |
|
|
The response format expected from the API (e.g. application/json). |
GET Get a Comment by ID
/v2/comments/{comment_id}
Fetch a Comment by its ID
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional data to embed in the results. |
|
|
(Required) Comment ID |
|
|
Expected response content type. |
|
|
The response format expected from the API (e.g. application/json). |
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 |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
(Required) Comment ID |
|
|
Expected response content type. |
|
|
The response format expected from the API (e.g. application/json). |
Options (8)
|
Option Name |
Description |
|---|---|
|
|
The textual content of the comment. |
|
|
An annotation identifier to attach to the comment, such as a shape or region reference. |
|
|
Specify the page number of results to retrieve for paginated responses. |
|
|
The pitch angle (in degrees) for a spatial comment, measured from the camera's forward direction. |
|
|
A timestamp value indicating a specific point in time for a time‑based comment. |
|
|
The yaw angle (in degrees) for a spatial comment, measured from the camera's forward direction. |
|
|
The duration (in seconds) for a time‑based comment to remain visible or active. |
|
|
A flag indicating whether the comment should be visible only to the comment author; expects a string like "true" or "false". |
{hook_id} (3)
DELETE Delete webhook
/v2/hooks/{hook_id}
Delete a given Webhook via its ID
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
(Required) Webhook ID |
|
|
Expected response content type. |
|
|
The response format expected from the API (e.g. application/json). |
GET Get Webhook by ID
/v2/hooks/{hook_id}
Get the information about a given Webhook
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
(Required) Webhook ID |
|
|
Expected response content type. |
|
|
The response format expected from the API (e.g. application/json). |
PUT Update webhook
/v2/hooks/{hook_id}
Update the settings for a given Webhook via its ID
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
(Required) Webhook ID |
|
|
Expected response content type. |
|
|
The response format expected from the API (e.g. application/json). |
Options (3)
|
Option Name |
Description |
|---|---|
|
|
The URL that the action will trigger. |
|
|
The filename for the asset. |
|
|
A JSON array of event type strings that will trigger the webhook. |
{presentation_id} (3)
DELETE Delete a Presentation
/v2/presentations/{presentation_id}
Delete a given Presentation Link
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
(Required) Presentation Link ID |
|
|
Expected response content type. |
|
|
The response format expected from the API (e.g. application/json). |
GET Show a Presentation
/v2/presentations/{presentation_id}
Fetch a particular presentaiton link's id
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
(Required) Presentation Link ID |
|
|
Expected response content type. |
|
|
The response format expected from the API (e.g. application/json). |
PUT Update a Presentation
/v2/presentations/{presentation_id}
Update a Presentation Link via it's ID
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
(Required) Presentation Link ID |
|
|
Expected response content type. |
|
|
The response format expected from the API (e.g. application/json). |
Options (21)
|
Option Name |
Description |
|---|---|
|
|
The unique identifier of the asset to create the presentation for, overriding the path parameter. |
|
|
Indicates whether the presentation should start playing automatically when opened; expects a string like true or false. |
|
|
The background color of the presentation, specified as a color value (e.g., hex code or named color). |
|
|
Indicates whether viewers are allowed to download the asset from the presentation; expects a string like true or false. |
|
|
A general color setting for the presentation, such as an accent or theme color. |
|
|
The timestamp indicating when the presentation link was marked as deleted, if applicable. |
|
|
An optional description explaining the action's purpose. |
|
|
Indicates whether the presentation link is currently active and accessible; expects a string like true or false. |
|
|
The timestamp after which the presentation link will no longer be valid. |
|
|
The output format for the presentation, such as html or pdf. |
|
|
Indicates whether the file extension should be included in the presentation; expects a string like true or false. |
|
|
Indicates whether the upload date of the asset should be displayed in the presentation; expects a string like true or false. |
|
|
The layout style for the presentation, such as grid or list. |
|
|
The filename for the asset. |
|
|
The unique identifier of the owner associated with the presentation link. |
|
|
A password required to view the presentation, if access is restricted. |
|
|
Filter assets that belong to a specific project by supplying its project ID. |
|
|
Indicates whether the presentation link should be served over HTTPS; expects a string like true or false. |
|
|
The visual style or theme applied to the presentation, such as light or dark. |
|
|
The color of the text displayed in the presentation, specified as a color value. |
|
|
A custom title for the presentation, overriding the asset's default name. |
{project_id} (3)
DELETE Delete Project by ID
/v2/projects/{project_id}
Delete a Project via its ID
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
(Required) Project ID |
|
|
Expected response content type. |
|
|
The response format expected from the API (e.g. application/json). |
GET Get Project by ID
/v2/projects/{project_id}
Fetch a Project via its ID
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional data to embed in the results. |
|
|
(Required) Project ID |
|
|
Expected response content type. |
|
|
The response format expected from the API (e.g. application/json). |
PUT Update a Project
/v2/projects/{project_id}
Update a Project ID with only the fields provided (overwrite)
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
(Required) Project ID |
|
|
Expected response content type. |
|
|
The response format expected from the API (e.g. application/json). |
Options (2)
|
Option Name |
Description |
|---|---|
|
|
The filename for the asset. |
|
|
A flag indicating whether the comment should be visible only to the comment author; expects a string like "true" or "false". |
{review_link_id} (3)
DELETE Delete a Review Link
/v2/review_links/{review_link_id}
Delete a given Review Link
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
(Required) |
|
|
Expected response content type. |
|
|
The response format expected from the API (e.g. application/json). |
GET Get a Review Link
/v2/review_links/{review_link_id}
Get a full Review Link manifest
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional data to embed in the results. |
|
|
(Required) |
|
|
Expected response content type. |
|
|
The response format expected from the API (e.g. application/json). |
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 |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
(Required) |
|
|
Expected response content type. |
|
|
The response format expected from the API (e.g. application/json). |
Options (8)
|
Option Name |
Description |
|---|---|
|
|
The filename for the asset. |
|
|
Whether to allow approvals on this review link. |
|
|
Whether to include only the current version in the review. |
|
|
Controls if reviewers can download assets from the review link. |
|
|
Whether to allow comments on the review link. |
|
|
Whether the review link is active and accessible. |
|
|
A password required to view the presentation, if access is restricted. |
|
|
Custom watermark text displayed on reviewed assets. |
{team_id}
GET Get a Team
/v2/teams/{team_id}
Fetch a given Team's information by ID
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional data to embed in the results. |
|
|
(Required) Team ID |
|
|
Expected response content type. |
|
|
The response format expected from the API (e.g. application/json). |