Skip to main content
Frame.io V4 logo
  • Category: video & audio
  • Auth: OAUTH2
  • Composio-managed OAuth available? No
  • Tools: 97
  • Triggers: 0
  • Slug: FRAME_IO_V4
  • Version: 00000000_00

Tools

Slug: FRAME_IO_V4_ADD_ASSET_TO_SHAREAdd a file, folder, or version stack to an existing externally visible Frame.io share.

Input Parameters

string
required
File, folder, or version-stack ID to add to the share.
string
required
Share ID to add the asset to.
string
required
Frame.io account ID that owns the share.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FRAME_IO_V4_ADD_SHARE_REVIEWERSGrant reviewers access to a secure Frame.io share or email recipients of a public share.

Input Parameters

array
Email addresses to add or notify.
string
required
Message included in reviewer email notifications.
string
required
Share ID to grant reviewer access to or notify.
array
Frame.io user IDs to add.
string
required
Frame.io account ID that owns the share.
array
Adobe user IDs to add.
array
Share-list IDs whose members to add.
boolean
Whether to send email notifications.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FRAME_IO_V4_BULK_UPDATE_METADATASet metadata field values across multiple files in one Frame.io project.

Input Parameters

array
required
Metadata field IDs and replacement values.
array
required
File IDs whose metadata values to update.
string
required
Frame.io account ID that owns the project.
string
required
Project ID containing the target files.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FRAME_IO_V4_COPY_FILECopy one Frame.io file to a destination folder, optionally copying metadata or comments.

Input Parameters

string
required
File ID to copy.
string
Destination folder ID; omit to use the current parent.
string
required
Frame.io account ID that owns the file.
string ("none" | "internal" | "public" | "all")
Which comments to copy with the file.
boolean
Whether to copy the file’s metadata values.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FRAME_IO_V4_COPY_FILESCopy between one and 100 Frame.io files into one destination folder.

Input Parameters

array
required
One to 100 unique file IDs to copy.
string
required
Destination folder ID for all copied files.
string
required
Frame.io account ID that owns the files.
string ("none" | "internal" | "public" | "all")
Which comments to copy with the files.
boolean
Whether to copy metadata values with the files.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FRAME_IO_V4_COPY_FOLDERCopy one Frame.io folder to an optional destination folder, optionally retaining metadata values.

Input Parameters

string
required
ID of the folder to copy.
string
Destination folder ID; omit to use the source folder’s parent.
string
required
Frame.io account ID that owns the folder.
boolean
Whether to copy metadata values with the folder.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FRAME_IO_V4_COPY_FOLDERSCopy 1 to 100 Frame.io folders into one destination folder, optionally retaining metadata and selected comments.

Input Parameters

string
required
Destination folder ID for every copied folder.
string
required
Frame.io account ID that owns the folders.
array
required
One to 100 unique source folder IDs.
string ("none" | "internal" | "public" | "all")
Which comments to copy.
boolean
Whether to copy metadata values.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FRAME_IO_V4_COPY_VERSION_STACKCreate a copy of a Frame.io version stack in its current or a selected destination folder.

Input Parameters

string
Destination folder ID; omit to use the current parent.
string
required
Frame.io account ID that owns the version stack.
boolean
Whether to copy metadata values.
string
required
Version-stack ID to copy.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FRAME_IO_V4_CREATE_COMMENTCreate a text, frame, page, drawing, or text-review comment on a Frame.io file.

Input Parameters

integer
Document page for a PDF comment.
string
required
Comment text.
Optional comment text links.
object
Optional normalized on-screen anchor.
string
required
File ID on which to create the comment.
integer
Duration in frames.
boolean
Optional completion status.
string
Optional nonnegative frame number or HH:MM:SS:FF timecode.
string
required
Frame.io account ID that owns the file.
string
Optional stringified drawing geometry.
array
Optional attachments to create with the comment.
boolean
Interpret a string timestamp as a timecode when true.
object
Optional text-document review annotation.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FRAME_IO_V4_CREATE_COMMENT_ATTACHMENTCreate an attachment record and upload URLs for an existing Frame.io comment.

Input Parameters

string
required
Attachment file name.
integer
required
Attachment size in bytes.
string
required
Frame.io account ID that owns the comment.
string
required
Comment ID to attach a file to.
string
required
Attachment media type.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FRAME_IO_V4_CREATE_CUSTOM_ACTIONCreate a workspace custom action and return its one-time webhook validation secret with the created action.

Input Parameters

string
required
URL to which Frame.io sends the event.
string
required
Custom action name.
string
required
Event name sent to the action URL.
integer
Request timeout in seconds.
string
required
Frame.io account ID.
string
required
Custom action description.
boolean
Whether the action can trigger on multiple assets.
string
required
Workspace in which to create the custom action.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FRAME_IO_V4_CREATE_FOLDERCreate a named child folder under an existing Frame.io folder and return its new ID.

Input Parameters

string
required
Name for the new folder.
string
required
Frame.io account ID that owns the parent folder.
string
required
Folder ID under which to create the child folder.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FRAME_IO_V4_CREATE_GROUPCreate an account group that can later receive shared resource access; this changes the account’s access-management structure and may require the user-groups plan feature.

Input Parameters

string
required
Group name.
string
required
Group emoji for UI display.
string
required
Frame.io or Adobe account ID in which to create the group.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FRAME_IO_V4_CREATE_LOCAL_UPLOADCreate a Frame.io file record and obtain presigned URLs for uploading local file bytes.

Input Parameters

string
required
File name.
integer
required
File size in bytes.
string
required
Destination folder ID for the new file.
string
required
Frame.io account ID that owns the folder.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FRAME_IO_V4_CREATE_METADATA_FIELDCreate an account-level Frame.io metadata field definition with type-specific configuration.

Input Parameters

string
required
Metadata field definition name.
string
required
Frame.io account ID whose metadata schema to extend.
string ("date" | "long_text" | "number" | "rating" | "select" | "select_multi" | "text" | "toggle" | "user_multi" | "user_single")
required
Type of values accepted by the metadata field.
object
Type-specific configuration; required by date, number, rating, select, and user field types.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FRAME_IO_V4_CREATE_PROJECTCreate a Frame.io project in a specific workspace.

Input Parameters

string
required
Project name.
string
required
Frame.io account ID.
boolean
Whether the new project is restricted.
string
required
Workspace in which to create the project.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FRAME_IO_V4_CREATE_REMOTE_UPLOADStart an asynchronous Frame.io upload from a source URL and return its file and status links.

Input Parameters

string
required
File name.
string
required
Destination folder ID for the new file.
string
required
Frame.io account ID that owns the folder.
string
required
Publicly reachable URL from which Frame.io should import bytes.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FRAME_IO_V4_CREATE_SHARECreate an externally accessible Frame.io review share for selected project assets.

Input Parameters

string
required
Share name.
string
required
Share discriminator; stable V4 accepts asset.
string ("dark" | "light" | "neutral")
Share color theme.
string ("public" | "secure")
required
Whether the share is public or secure.
string ("grid" | "list" | "reel")
Share layout.
boolean
Whether the share link is active.
object
Metadata field and direction used to sort shared assets.
array
File, folder, or version-stack IDs to share.
string ("small" | "medium" | "large")
Card size for grid layout.
string
required
Frame.io account ID that owns the project.
string
ISO 8601 expiration timestamp, or null for no expiration.
string
required
Project ID in which to create the share.
string
Optional share description; custom branding may be required.
boolean
Whether digital rights management is enabled.
string
Hex accent color for the share.
string ("small" | "medium" | "large")
Row size for list layout.
string ("fit" | "fill")
Whether thumbnails fit or fill their cards.
boolean
Whether reviewers can view captions.
integer
One or two title lines on grid cards.
string ("horizontal" | "square" | "vertical")
Card aspect ratio for grid or reel layouts.
boolean
Whether grid cards show metadata.
integer
Name-column width in pixels for list layout.
boolean
Whether watermarking is enabled.
boolean
Whether reviewers can comment.
boolean
Whether reviewers can download assets.
boolean
Whether reel thumbnails fill rather than fit their cards.
boolean
Whether reviewers can view transcripts.
boolean
Whether list rows show visible-field icons.
boolean
Whether a single asset opens in the larger viewer.
string ("horizontal" | "square" | "vertical")
Card aspect ratio for reel layout.
boolean
Whether recipients can edit all visible non-system fields.
boolean
Whether reviewers can see every version in a shared stack.
boolean
Whether forensic watermarking is enabled.
Metadata field definition featured for recipients.
array
Metadata field definition IDs visible in the active layout.
boolean
Whether reel cards display asset names.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FRAME_IO_V4_CREATE_VERSION_STACKCombine two to ten existing files in one folder into a new ordered Frame.io version stack.

Input Parameters

array
required
Two to ten file IDs ordered from oldest/bottom to newest/top version.
string
required
Folder containing every file to stack.
string
required
Frame.io account ID that owns the parent folder.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FRAME_IO_V4_CREATE_WEBHOOKRegister a Frame.io workspace webhook for selected events and return its one-time validation secret.

Input Parameters

string
required
Callback URL that receives webhook events.
string
required
Webhook name.
array
required
Frame.io event types to deliver to the callback.
string
required
Frame.io account ID that owns the workspace.
string
required
Workspace ID in which to register the webhook.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FRAME_IO_V4_CREATE_WORKSPACECreate a Frame.io workspace in an account.

Input Parameters

string
Workspace name.
string
required
Frame.io account ID.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FRAME_IO_V4_DELETE_COMMENTPermanently delete a Frame.io comment by ID.

Input Parameters

string
required
Frame.io account ID that owns the comment.
string
required
Comment ID to delete.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FRAME_IO_V4_DELETE_COMMENT_ATTACHMENTPermanently delete one attachment from a Frame.io comment.

Input Parameters

string
required
Frame.io account ID that owns the comment.
string
required
Comment ID containing the attachment.
string
required
Attachment ID to delete.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FRAME_IO_V4_DELETE_CUSTOM_ACTIONDelete a Frame.io custom action by ID.

Input Parameters

string
required
Custom action ID.
string
required
Frame.io account ID.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FRAME_IO_V4_DELETE_FILEPermanently delete a Frame.io file by ID.

Input Parameters

string
required
File ID to delete.
string
required
Frame.io account ID that owns the file.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FRAME_IO_V4_DELETE_FOLDERDelete a Frame.io folder by ID; use only when the folder and its contents are no longer needed.

Input Parameters

string
required
Folder ID to delete; do not pass a project root folder.
string
required
Frame.io account ID that owns the folder.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FRAME_IO_V4_DELETE_METADATA_FIELDDelete a mutable account-level Frame.io custom metadata field definition.

Input Parameters

string
required
Frame.io account ID that owns the metadata field.
string
required
Custom metadata field definition ID to delete.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FRAME_IO_V4_DELETE_PROJECTDelete a Frame.io project by ID.

Input Parameters

string
required
Frame.io account ID that owns the project.
string
required
Frame.io project ID.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FRAME_IO_V4_DELETE_SHAREPermanently delete a Frame.io review share and disable its externally visible link.

Input Parameters

string
required
Share ID to permanently delete.
string
required
Frame.io account ID that owns the share.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FRAME_IO_V4_DELETE_WEBHOOKPermanently delete a Frame.io webhook registration by ID.

Input Parameters

string
required
Frame.io account ID that owns the webhook.
string
required
Webhook ID to delete.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FRAME_IO_V4_DELETE_WORKSPACEDelete a Frame.io workspace from its account by ID.

Input Parameters

string
required
Frame.io account ID.
string
required
Frame.io workspace ID.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FRAME_IO_V4_GET_COLLECTIONReturn current details for one Frame.io collection by ID.

Input Parameters

string
Optional provider-supported collection relationship to include.
string
required
Frame.io account ID.
string
required
Collection ID to retrieve.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FRAME_IO_V4_GET_COMMENTReturn one Frame.io comment by ID, optionally including its owner or replies.

Input Parameters

string ("owner" | "replies")
Optionally include the comment owner or replies.
string
required
Frame.io account ID that owns the comment.
string
required
Comment ID to retrieve.
boolean
Return the timestamp as a timecode when true.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FRAME_IO_V4_GET_CURRENT_USERReturn the Frame.io user connected through OAuth, including the user ID needed to interpret access and ownership.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FRAME_IO_V4_GET_CUSTOM_ACTIONReturn current details for one Frame.io custom action by ID.

Input Parameters

string
Set to creator to include action creator details.
string
required
Custom action ID.
string
required
Frame.io account ID.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FRAME_IO_V4_GET_FILEReturn one Frame.io file by ID, optionally including creator, project, metadata, or media links.

Input Parameters

string
required
File ID to retrieve.
string ("media_links.original" | "media_links.thumbnail" | "media_links.thumbnail_high_quality" | "media_links.video_h264_180" | "media_links.high_quality" | "media_links.efficient" | "media_links.scrub_sheet" | "creator" | "project" | "metadata")
Optional related data or media-link representation to include.
string
required
Frame.io account ID that owns the file.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FRAME_IO_V4_GET_FILE_UPLOAD_STATUSReturn the current completion or failure status of a Frame.io file upload.

Input Parameters

string
required
File ID whose upload status to retrieve.
string
required
Frame.io account ID that owns the file.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FRAME_IO_V4_GET_FOLDERReturn one folder’s current details by ID, optionally including creator, project, or metadata data.

Input Parameters

string ("creator" | "project" | "metadata")
Optional related data to include in the folder response.
string
required
Folder ID to retrieve.
string
required
Frame.io account ID that owns the folder.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FRAME_IO_V4_GET_GROUPGet an account group’s details without changing access; this endpoint may require the user-groups plan feature.

Input Parameters

string
Set to creator to include creator details.
string
required
Group ID to retrieve.
string
required
Frame.io or Adobe account ID that owns the group.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FRAME_IO_V4_GET_PROJECTReturn current details for one Frame.io project by ID.

Input Parameters

string
Set to owner to include project owner details.
string
required
Frame.io account ID that owns the project.
string
required
Frame.io project ID.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FRAME_IO_V4_GET_SHARERetrieve a Frame.io share’s current access, appearance, and review settings without changing it.

Input Parameters

string
required
Share ID to retrieve.
string
required
Frame.io account ID that owns the share.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FRAME_IO_V4_GET_VERSION_STACKRetrieve a Frame.io version stack and optionally include related data or media links without changing it.

Input Parameters

string ("media_links.original" | "media_links.thumbnail" | "media_links.thumbnail_high_quality" | "media_links.video_h264_180" | "media_links.high_quality" | "media_links.efficient" | "media_links.scrub_sheet" | "creator" | "project" | "metadata")
Optional related data or media links to include.
string
required
Frame.io account ID that owns the version stack.
string
required
Version-stack ID to retrieve.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FRAME_IO_V4_GET_WORKSPACEReturn current details for one Frame.io workspace by ID.

Input Parameters

string
Set to creator to include workspace creator details.
string
required
Frame.io account ID.
string
required
Frame.io workspace ID.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FRAME_IO_V4_IMPORT_FILEImport a file from a storage location already configured on the Frame.io account.

Input Parameters

string
required
File key or path within the configured filespace.
string
required
Imported file name.
string
required
Destination folder ID for the imported file.
string
required
Frame.io account ID that owns the folder.
string
required
Configured storage location ID, optionally prefixed by an account ID.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FRAME_IO_V4_LIST_ACCOUNTSList Frame.io accounts available to the connected user and return account IDs for downstream discovery.

Input Parameters

string ("display_name_asc" | "created_at_asc" | "display_name_desc" | "created_at_desc")
Order accounts by display name or creation time.
integer
Maximum accounts to return in this page.
string
Opaque cursor returned by a previous call; omit for the first page.
boolean
Whether to include the total matching account count.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FRAME_IO_V4_LIST_ACCOUNT_USERSList users and their roles in an account, optionally including deactivated users, without changing permissions.

Input Parameters

string ("role_asc" | "role_desc" | "name_asc" | "name_desc" | "email_asc" | "email_desc")
Order users by role, name, or email.
integer
Maximum user-role records to return in this page.
string
required
Frame.io account ID whose users and roles to list.
string
Opaque cursor returned by a previous call; omit for the first page.
boolean
Whether to include deactivated users.
boolean
Whether to include the total matching user count.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FRAME_IO_V4_LIST_AUDIT_LOGSList account audit events using Frame.io’s experimental audit API, optionally expanding the acting user.

Input Parameters

object
Optional audit filters by event type, date range, IP, project, resource, user, or workspace. Dates use YYYY-MM-DD.
integer
Maximum audit events to return in this page.
string
required
Frame.io account ID whose audit events to list.
string
Opaque cursor returned by a previous call; omit for the first page and pass it back unchanged to fetch the next page.
boolean
Whether to include acting-user details for each audit event.
boolean
Whether to include the total matching audit event count.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FRAME_IO_V4_LIST_COLLECTIONSList saved collections in a project, including default review-oriented collections and their root folder IDs.

Input Parameters

string
Optional provider-supported collection relationship to include.
integer
Maximum collections to return in this page.
string
required
Frame.io account ID that owns the project.
string
required
Project ID whose collections to list.
string
Opaque cursor returned by a previous call; omit for the first page and pass it back unchanged to fetch the next page.
boolean
Whether to include the total matching collection count.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FRAME_IO_V4_LIST_COMMENTSList one page of comments on a file, with optional owners, replies, and a next_cursor.

Input Parameters

string ("owner_asc" | "owner_desc" | "completed_at_asc" | "completed_at_desc" | "created_at_asc" | "created_at_desc")
Optional comment ordering. Owner sorting requires include=owner.
string
required
File ID whose comments to list.
string ("owner" | "replies")
Optionally include comment owners or replies.
integer
Maximum comments to return in this page.
string
required
Frame.io account ID that owns the file.
string
Opaque cursor returned by a previous call.
boolean
Whether to include the total matching comment count.
boolean
Return timestamps as timecodes when true.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FRAME_IO_V4_LIST_CUSTOM_ACTIONSList one page of custom actions configured in a Frame.io workspace. Use next_cursor to retrieve subsequent pages.

Input Parameters

string
Set to creator to include action creator details.
integer
Maximum custom actions to return in this page.
string
required
Frame.io account ID.
string
Opaque cursor returned by a previous call; omit for the first page.
string
required
Workspace whose custom actions to list.
boolean
Whether to include the total matching action count.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FRAME_IO_V4_LIST_FILESList one page of files in a folder, with optional media links and a next_cursor.

Input Parameters

string ("name_asc" | "created_at_asc" | "updated_at_asc" | "file_size_asc" | "name_desc" | "created_at_desc" | "updated_at_desc" | "file_size_desc")
Optional file ordering.
string ("media_links.original" | "media_links.thumbnail" | "media_links.thumbnail_high_quality" | "media_links.video_h264_180" | "media_links.high_quality" | "media_links.efficient" | "media_links.scrub_sheet" | "creator" | "project" | "metadata")
Optional related data or media-link representation to include.
string
required
Folder ID whose files to list.
integer
Maximum files to return in this page.
string
required
Frame.io account ID that owns the folder.
string
Opaque cursor returned by a previous call.
boolean
Whether to include the total matching file count.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FRAME_IO_V4_LIST_FOLDER_CHILDRENList files, folders, and version stacks directly inside a folder, with optional type filtering and media-link expansion.

Input Parameters

string ("name_asc" | "created_at_asc" | "updated_at_asc" | "name_desc" | "created_at_desc" | "updated_at_desc")
Order children by name, creation time, or update time.
string
Optional provider asset-type filter; omit to return mixed children.
string ("media_links.original" | "media_links.thumbnail" | "media_links.thumbnail_high_quality" | "media_links.video_h264_180" | "media_links.high_quality" | "media_links.efficient" | "media_links.scrub_sheet" | "creator" | "project" | "metadata")
Optional related data or media-link representation to include.
string
required
Folder ID to traverse; use a project’s root_folder_id to start at the project root.
integer
Maximum child assets to return in this page.
string
required
Frame.io account ID that owns the folder.
string
Opaque cursor returned by a previous call. Omit for the first page and pass it back unchanged to fetch the next page.
boolean
Whether to include the total matching child count.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FRAME_IO_V4_LIST_FOLDERSList only the folders directly inside a Frame.io folder, one cursor-controlled page at a time.

Input Parameters

string ("name_asc" | "created_at_asc" | "updated_at_asc" | "name_desc" | "created_at_desc" | "updated_at_desc")
Optional folder sort order.
string ("creator" | "project" | "metadata")
Optional related data to include.
string
required
Parent folder ID whose direct subfolders to list.
integer
Maximum folders to return in this page.
string
required
Frame.io account ID that owns the parent folder.
string
Opaque cursor from a previous call; omit for the first page.
boolean
Whether to include the total matching folder count.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FRAME_IO_V4_LIST_FOLDER_USER_ROLESList one page of users with direct access roles on a folder without changing access.

Input Parameters

string
required
Folder ID whose direct user roles to list.
integer
Page size.
string
required
Frame.io account ID that owns the folder.
string
Opaque cursor from a previous page.
boolean
Whether to include deactivated users.
boolean
Whether to include the total matching role count.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FRAME_IO_V4_LIST_GROUPSList one page of account groups and membership counts without changing access; this endpoint may require the user-groups plan feature.

Input Parameters

string ("creator_asc" | "creator_desc" | "name_asc" | "name_desc" | "created_at_asc" | "created_at_desc")
Optional group ordering.
string
Set to creator to include creator details.
integer
Page size.
string
required
Frame.io or Adobe account ID whose groups to list.
string
Opaque cursor from a previous page.
boolean
Whether to include the total group count.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FRAME_IO_V4_LIST_INVITED_PROJECTSList projects where the connected user has project-specific collaborator access but no workspace-level access.

Input Parameters

string ("name_asc" | "created_at_asc" | "name_desc" | "created_at_desc")
Optional project sort order.
string
Set to owner to include project owner details.
integer
Maximum projects to return in this page.
string
required
Frame.io account ID.
string
Opaque cursor returned by a previous call; omit for the first page.
boolean
Whether to include the total matching project count.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FRAME_IO_V4_LIST_METADATA_FIELDSList account metadata field definitions so an agent can discover valid field IDs, types, configuration, and mutability.

Input Parameters

string ("name_asc" | "created_at_asc" | "name_desc" | "created_at_desc")
Order field definitions by name or creation time.
object
Optional filters for excluding read-only or inactive field definitions.
integer
Maximum field definitions to return in this page.
string
required
Frame.io account ID whose metadata schema to inspect.
string
Opaque cursor returned by a previous call; omit for the first page and pass it back unchanged to fetch the next page.
boolean
Whether to include creator details for each field definition.
boolean
Whether to include the total matching definition count.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FRAME_IO_V4_LIST_PROJECTSList a page of projects visible in a Frame.io account, including each project ID and root folder ID for asset traversal. Use next_cursor to retrieve subsequent pages.

Input Parameters

string ("name_asc" | "created_at_asc" | "name_desc" | "created_at_desc")
Order projects by name or creation time.
integer
Maximum projects to return in this page.
string
required
Frame.io account ID from List Accounts; Adobe-backed IDs must retain the adobe: prefix.
string
Opaque cursor returned by a previous call. Repeat the same account and options when continuing; omit for the first page.
boolean
Whether to include owner details for each project.
boolean
Whether to include the total matching project count.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FRAME_IO_V4_LIST_PROJECT_USER_ROLESList one page of users with direct project access roles without changing access.

Input Parameters

string ("role_asc" | "role_desc" | "name_asc" | "name_desc" | "email_asc" | "email_desc")
Optional user-role ordering.
integer
Page size.
string
required
Frame.io or Adobe account ID.
string
required
Frame.io or Adobe project ID whose roles to list.
string
Opaque cursor from a previous page.
boolean
Whether to include deactivated users.
boolean
Whether to include the total role count.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FRAME_IO_V4_LIST_RECENTLY_DELETED_ASSETSList one page of recently deleted files, folders, and version stacks in a project, ordered by the requested deletion or name sort.

Input Parameters

string ("deleted_at_asc" | "deleted_at_desc" | "name_asc" | "name_desc")
Optional deleted-asset sort order.
integer
Maximum deleted assets to return in this page.
string
required
Frame.io account ID.
string
required
Project whose deleted assets to list.
string
Opaque cursor returned by a previous call; omit for the first page.
boolean
Whether to request a total matching asset count.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FRAME_IO_V4_LIST_SHARE_ACTIVITIESReturn one page of view, download, and comment activity recorded for a Frame.io share.

Input Parameters

string
Include full user details.
string
required
Share ID whose activity to list.
integer
Maximum activity records to return in this page.
string
required
Frame.io account ID that owns the share.
string
Opaque cursor from a previous response; omit for the first page.
boolean
Whether to request the total activity count.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FRAME_IO_V4_LIST_SHARE_ASSETSReturn one page of every direct and recursively nested asset exposed by a Frame.io share.

Input Parameters

string ("name_asc" | "created_at_asc" | "updated_at_asc" | "name_desc" | "created_at_desc" | "updated_at_desc")
Optional asset sort order.
string ("media_links.original" | "media_links.thumbnail" | "media_links.thumbnail_high_quality" | "media_links.video_h264_180" | "media_links.high_quality" | "media_links.efficient" | "media_links.scrub_sheet" | "creator" | "project" | "metadata")
Optional related data or media-link representation to include.
string
required
Share ID whose recursively expanded assets to list.
integer
Maximum assets to return in this page.
string
required
Frame.io account ID that owns the share.
string
Opaque cursor from a previous response; omit for the first page.
boolean
Whether to include the total matching asset count.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FRAME_IO_V4_LIST_SHARE_REVIEWERSReturn one page of reviewers currently associated with a Frame.io share without changing access.

Input Parameters

string ("name_asc" | "active" | "name_desc" | "inactive")
Optional reviewer sort order.
string
required
Share ID whose reviewers to list.
integer
Maximum reviewers to return in this page.
string
required
Frame.io account ID that owns the share.
string
Opaque cursor from a previous response; omit for the first page.
boolean
Whether to include the total reviewer count.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FRAME_IO_V4_LIST_SHARESList review shares for a project without creating or changing externally visible review links.

Input Parameters

string ("name_asc" | "created_at_asc" | "name_desc" | "created_at_desc")
Order shares by name or creation time.
integer
Maximum shares to return in this page.
string
required
Frame.io account ID that owns the project.
string
required
Project ID whose shares to list.
string
Opaque cursor returned by a previous call. Repeat the same project and options when continuing; omit for the first page.
boolean
Whether to include the total matching share count.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FRAME_IO_V4_LIST_VERSION_STACK_CHILDRENReturn one page of files in a Frame.io version stack, with optional related data or media links.

Input Parameters

string ("name_asc" | "created_at_asc" | "updated_at_asc" | "file_size_asc" | "name_desc" | "created_at_desc" | "updated_at_desc" | "file_size_desc")
Optional child-file sort order.
string ("media_links.original" | "media_links.thumbnail" | "media_links.thumbnail_high_quality" | "media_links.video_h264_180" | "media_links.high_quality" | "media_links.efficient" | "media_links.scrub_sheet" | "creator" | "project" | "metadata")
Optional related data or media-link representation to include.
integer
Maximum child files to return in this page.
string
required
Frame.io account ID that owns the version stack.
string
Opaque cursor from a previous response; omit for the first page.
string
required
Version-stack ID whose files to list.
boolean
Whether to include the total child-file count.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FRAME_IO_V4_LIST_VERSION_STACKSReturn one page of version stacks directly contained in a Frame.io folder without changing them.

Input Parameters

string ("name_asc" | "created_at_asc" | "updated_at_asc" | "name_desc" | "created_at_desc" | "updated_at_desc")
Optional version-stack sort order.
string ("media_links.original" | "media_links.thumbnail" | "media_links.thumbnail_high_quality" | "media_links.video_h264_180" | "media_links.high_quality" | "media_links.efficient" | "media_links.scrub_sheet" | "creator" | "project" | "metadata")
Optional related data or media-link representation to include.
string
required
Folder ID whose version stacks to list.
integer
Maximum version stacks to return in this page.
string
required
Frame.io account ID that owns the folder.
string
Opaque cursor from a previous response; omit for the first page.
boolean
Whether to include the total version-stack count.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FRAME_IO_V4_LIST_WEBHOOKSList webhook registrations in a workspace without creating callbacks or requiring external delivery infrastructure.

Input Parameters

string ("name_asc" | "created_at_asc" | "name_desc" | "created_at_desc")
Order webhooks by name or creation time.
integer
Maximum webhooks to return in this page.
string
required
Frame.io account ID that owns the workspace.
string
Opaque cursor returned by a previous call; omit for the first page.
string
required
Workspace ID whose webhook registrations to list.
boolean
Whether to include creator details for each webhook.
boolean
Whether to include the total matching webhook count.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FRAME_IO_V4_LIST_WORKSPACE_PROJECTSList one page of projects in a specific Frame.io workspace. Use next_cursor to retrieve subsequent pages.

Input Parameters

string ("name_asc" | "created_at_asc" | "name_desc" | "created_at_desc")
Optional project sort order.
string
Set to owner to include project owner details.
integer
Maximum projects to return in this page.
string
required
Frame.io account ID.
string
Opaque cursor returned by a previous call; omit for the first page.
string
required
Workspace whose projects to list.
boolean
Whether to include the total matching project count.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FRAME_IO_V4_LIST_WORKSPACESList workspaces in an account and return workspace IDs used by project, webhook, and collaboration workflows.

Input Parameters

string ("name_asc" | "created_at_asc" | "name_desc" | "created_at_desc")
Order workspaces by name or creation time.
integer
Maximum workspaces to return in this page.
string
required
Frame.io account ID from List Accounts; Adobe-backed IDs must retain the adobe: prefix.
string
Opaque cursor returned by a previous call; omit for the first page.
boolean
Whether to include creator details for each workspace.
boolean
Whether to include the total matching workspace count.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FRAME_IO_V4_LIST_WORKSPACE_USER_ROLESList one page of users with workspace access roles without changing access.

Input Parameters

string ("role_asc" | "role_desc" | "name_asc" | "name_desc" | "email_asc" | "email_desc")
Optional user-role ordering.
integer
Page size.
string
required
Frame.io or Adobe account ID.
string
Opaque cursor from a previous page.
string
required
Workspace ID whose roles to list.
boolean
Whether to include deactivated users.
boolean
Whether to include the total role count.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FRAME_IO_V4_MOVE_FILEMove one Frame.io file to a folder or version stack.

Input Parameters

string
required
File ID to move.
string
Optional destination folder or version stack ID.
string
required
Frame.io account ID that owns the file.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FRAME_IO_V4_MOVE_FILESMove between one and 100 Frame.io files into one destination folder.

Input Parameters

array
required
One to 100 unique file IDs to move.
string
required
Destination folder ID for all files.
string
required
Frame.io account ID that owns the files.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FRAME_IO_V4_MOVE_FOLDERMove one Frame.io folder to a destination folder and return its updated details.

Input Parameters

string
required
ID of the folder to move.
string
Destination folder ID.
string
required
Frame.io account ID that owns the folder.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FRAME_IO_V4_MOVE_FOLDERSMove 1 to 100 Frame.io folders into one destination folder and return their updated details.

Input Parameters

string
required
Destination folder ID for every moved folder.
string
required
Frame.io account ID that owns the folders.
array
required
One to 100 unique folder IDs to move.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FRAME_IO_V4_MOVE_VERSION_STACKMove a Frame.io version stack to a destination folder, changing its parent location.

Input Parameters

string
Destination folder ID.
string
required
Frame.io account ID that owns the version stack.
string
required
Version-stack ID to move.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FRAME_IO_V4_REMOVE_ASSET_FROM_SHARERemove an asset from a Frame.io share without deleting the underlying file, folder, or version stack.

Input Parameters

string
required
Asset ID to remove from the share.
string
required
Share ID to remove the asset from.
string
required
Frame.io account ID that owns the share.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FRAME_IO_V4_REMOVE_FOLDER_USERRemove a user’s direct role from a folder, revoking that folder access.

Input Parameters

string
required
User whose folder access will be removed.
string
required
Folder from which access will be removed.
string
required
Frame.io account ID that owns the folder.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FRAME_IO_V4_REMOVE_PROJECT_USERRemove a user’s direct role from a project, revoking that project access.

Input Parameters

string
required
User whose project access will be removed.
string
required
Frame.io or Adobe account ID.
string
required
Project from which access will be removed.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FRAME_IO_V4_REMOVE_SHARE_REVIEWERSRevoke selected reviewers’ access to a secure Frame.io share.

Input Parameters

array
Reviewer email addresses to remove.
string
required
Secure share ID to revoke reviewer access from.
array
Frame.io user IDs to remove.
string
required
Frame.io account ID that owns the share.
array
Adobe user IDs to remove.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FRAME_IO_V4_REMOVE_WORKSPACE_USERRemove a user’s role from a workspace, revoking that workspace access.

Input Parameters

string
required
User whose workspace access will be removed.
string
required
Frame.io or Adobe account ID.
string
required
Workspace from which access will be removed.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FRAME_IO_V4_SEARCH_ACCOUNTSearch visible projects, folders, files, and version stacks across a Frame.io account by text.

Input Parameters

string
required
Text to search for in visible Frame.io resources.
string ("lexical" | "nlp")
Use lexical for exact term matching or nlp for natural-language search.
integer
Maximum search results to return in this page.
string
required
Frame.io account ID to search.
string
Opaque cursor returned by a previous search call; omit for the first page.
boolean
Whether folder results may be returned.
boolean
Whether project results may be returned.
boolean
Whether to include the total matching result count.
boolean
Whether file and version-stack results may be returned.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FRAME_IO_V4_SHOW_METADATAReturn one Frame.io file’s metadata values and definitions, optionally including fields with null values.

Input Parameters

string
required
File ID whose metadata values to retrieve.
boolean
Whether to include metadata fields whose current value is null.
string
required
Frame.io account ID that owns the file.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FRAME_IO_V4_SHOW_WEBHOOKReturn one Frame.io webhook’s current callback, event, status, and optional creator details.

Input Parameters

string
Pass creator to include webhook creator details.
string
required
Frame.io account ID that owns the webhook.
string
required
Webhook ID to retrieve.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FRAME_IO_V4_UPDATE_ACCOUNT_USER_ROLEChange a user’s account-level access to member or admin. This immediately changes what the user can administer across the Frame.io account.

Input Parameters

string ("member" | "admin")
required
New account role: member or admin.
string
required
Frame.io user ID whose role will change.
string
required
Frame.io or Adobe account ID whose account-level access will change.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FRAME_IO_V4_UPDATE_COMMENTUpdate the text, location, annotation, timing, or completion state of a Frame.io comment.

Input Parameters

integer
Optional PDF document page.
string
Optional new comment text.
Optional comment text links.
object
Optional normalized on-screen anchor.
integer
Optional duration in frames.
boolean
Optional completion status.
string
Optional frame number or timecode.
string
required
Frame.io account ID that owns the comment.
string
Optional stringified drawing geometry.
string
required
Comment ID to update.
boolean
Interpret a string timestamp as a timecode when true.
object
Optional text review annotation changes.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FRAME_IO_V4_UPDATE_CUSTOM_ACTIONUpdate the configuration or active state of a Frame.io custom action.

Input Parameters

string
New action URL.
string
New action name.
string
New event name.
boolean
Whether the custom action is active.
integer
New request timeout in seconds.
string
required
Custom action ID.
string
required
Frame.io account ID.
string
New action description.
boolean
Whether the action can trigger on multiple assets.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FRAME_IO_V4_UPDATE_FILEUpdate a Frame.io file’s name and return its current details.

Input Parameters

string
Optional new file name.
string
required
File ID to update.
string
required
Frame.io account ID that owns the file.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FRAME_IO_V4_UPDATE_FOLDERRename an existing Frame.io folder and return its updated details.

Input Parameters

string
required
New name for the folder.
string
required
Folder ID to rename.
string
required
Frame.io account ID that owns the folder.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FRAME_IO_V4_UPDATE_FOLDER_USER_ROLEAdd a user to a folder with the selected role, or replace the role if access already exists. This immediately changes the user’s folder access.

Input Parameters

string ("full_access" | "editor" | "edit_only" | "commenter" | "viewer")
required
New folder role for the user.
string
required
User to add or whose role to replace.
string
required
Folder whose access will change.
string
required
Frame.io account ID that owns the folder.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FRAME_IO_V4_UPDATE_GROUPChange an account group’s name and/or emoji, altering the group used to organize access; this endpoint may require the user-groups plan feature.

Input Parameters

string
New group name; omit to leave unchanged.
string
New group emoji; omit to leave unchanged.
string
required
Group ID to update.
string
required
Frame.io or Adobe account ID that owns the group.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FRAME_IO_V4_UPDATE_METADATA_FIELDUpdate the name or type-specific configuration of a mutable account-level Frame.io metadata field definition.

Input Parameters

string
Optional replacement field name.
string
required
Frame.io account ID that owns the metadata field.
string ("date" | "long_text" | "number" | "rating" | "select" | "select_multi" | "text" | "toggle" | "user_multi" | "user_single")
required
Current type of the field definition being updated.
object
Optional replacement type-specific configuration.
string
required
Metadata field definition ID to update.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FRAME_IO_V4_UPDATE_PROJECTUpdate a Frame.io project’s name, restricted state, or status.

Input Parameters

string
New project name.
string ("active" | "inactive")
New project status.
string
required
Frame.io account ID that owns the project.
string
required
Frame.io project ID.
boolean
Whether the project is restricted.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FRAME_IO_V4_UPDATE_PROJECT_USER_ROLEAdd a user to a project with the selected role, or replace an existing role, immediately changing project access.

Input Parameters

string ("full_access" | "editor" | "edit_only" | "commenter" | "viewer")
required
New project role for the user.
string
required
User to add or whose role to replace.
string
required
Frame.io or Adobe account ID.
string
required
Project whose access will change.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FRAME_IO_V4_UPDATE_SHAREChange a Frame.io share’s access, review, appearance, or expiration settings.

Input Parameters

string
New share name, or null when supported by Frame.io.
string ("dark" | "light" | "neutral")
Share color theme.
string ("public" | "secure")
Share access mode.
string ("grid" | "list" | "reel")
Share layout.
boolean
Whether the share link is active.
object
Metadata field and direction used to sort shared assets.
string
required
Share ID to update.
string ("small" | "medium" | "large")
Card size for grid layout.
string
required
Frame.io account ID that owns the share.
string
ISO 8601 expiration timestamp, or null for no expiration.
string
Share description, or null to clear it.
boolean
Whether digital rights management is enabled.
string
Hex accent color for the share.
string ("small" | "medium" | "large")
Row size for list layout.
string ("fit" | "fill")
Whether thumbnails fit or fill their cards.
boolean
Whether reviewers can view captions.
integer
One or two title lines on grid cards.
string ("horizontal" | "square" | "vertical")
Card aspect ratio for grid or reel layouts.
boolean
Whether grid cards show metadata.
integer
Name-column width in pixels for list layout.
boolean
Whether watermarking is enabled.
boolean
Whether reviewers can comment.
boolean
Whether reviewers can download assets.
boolean
Whether reel thumbnails fill rather than fit their cards.
boolean
Whether reviewers can view transcripts.
boolean
Whether list rows show visible-field icons.
boolean
Whether a single asset opens in the larger viewer.
string ("horizontal" | "square" | "vertical")
Card aspect ratio for reel layout.
boolean
Whether recipients can edit all visible non-system fields.
boolean
Whether reviewers can see every version in a shared stack.
boolean
Whether forensic watermarking is enabled.
Metadata field definition featured for recipients.
array
Metadata field definition IDs visible in the active layout.
boolean
Whether reel cards display asset names.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FRAME_IO_V4_UPDATE_WEBHOOKUpdate a Frame.io webhook’s active state, subscribed events, name, or callback URL.

Input Parameters

string
Replacement callback URL.
string
Replacement webhook name.
boolean
Whether the webhook should be active.
array
Replacement Frame.io event types.
string
required
Frame.io account ID that owns the webhook.
string
required
Webhook ID to update.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FRAME_IO_V4_UPDATE_WORKSPACEUpdate the name of an existing Frame.io workspace.

Input Parameters

string
New workspace name.
string
required
Frame.io account ID.
string
required
Frame.io workspace ID.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FRAME_IO_V4_UPDATE_WORKSPACE_USER_ROLEAdd a user to a workspace with the selected role, or replace an existing role, immediately changing workspace access.

Input Parameters

string ("workspace_admin" | "full_access" | "editor" | "edit_only" | "commenter" | "viewer")
required
New workspace role for the user.
string
required
User to add or whose role to replace.
string
required
Frame.io or Adobe account ID.
string
required
Workspace whose access will change.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not