--- canonical_url: "https://docs.composio.dev/toolkits/frame_io_v4" markdown_url: "https://docs.composio.dev/toolkits/frame_io_v4.md" product: "platform" version: null last_updated: null --- # Frame.io V4 Frame.io V4 provides collaborative media review, project, asset, comment, sharing, metadata, and workspace management through Adobe IMS user authorization. - **Category:** video & audio - **Auth:** OAUTH2 - **Composio-managed OAuth available?** No - **Tools:** 97 - **Triggers:** 0 - **Slug:** `FRAME_IO_V4` - **Version:** 00000000_00 ## Tools ### Add Asset to Share **Slug:** `FRAME_IO_V4_ADD_ASSET_TO_SHARE` Add a file, folder, or version stack to an existing externally visible Frame.io share. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `asset_id` | string | Yes | File, folder, or version-stack ID to add to the share. | | `share_id` | string | Yes | Share ID to add the asset to. | | `account_id` | string | Yes | Frame.io account ID that owns the share. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Add Share Reviewers **Slug:** `FRAME_IO_V4_ADD_SHARE_REVIEWERS` Grant reviewers access to a secure Frame.io share or email recipients of a public share. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `emails` | array | No | Email addresses to add or notify. | | `message` | string | Yes | Message included in reviewer email notifications. | | `share_id` | string | Yes | Share ID to grant reviewer access to or notify. | | `user_ids` | array | No | Frame.io user IDs to add. | | `account_id` | string | Yes | Frame.io account ID that owns the share. | | `adobe_user_ids` | array | No | Adobe user IDs to add. | | `share_list_ids` | array | No | Share-list IDs whose members to add. | | `notify_by_email` | boolean | No | Whether to send email notifications. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Bulk Update Metadata **Slug:** `FRAME_IO_V4_BULK_UPDATE_METADATA` Set metadata field values across multiple files in one Frame.io project. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `values` | array | Yes | Metadata field IDs and replacement values. | | `file_ids` | array | Yes | File IDs whose metadata values to update. | | `account_id` | string | Yes | Frame.io account ID that owns the project. | | `project_id` | string | Yes | Project ID containing the target files. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Copy File **Slug:** `FRAME_IO_V4_COPY_FILE` Copy one Frame.io file to a destination folder, optionally copying metadata or comments. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `file_id` | string | Yes | File ID to copy. | | `parent_id` | string | No | Destination folder ID; omit to use the current parent. | | `account_id` | string | Yes | Frame.io account ID that owns the file. | | `copy_comments` | string ("none" | "internal" | "public" | "all") | No | Which comments to copy with the file. | | `copy_metadata` | boolean | No | Whether to copy the file's metadata values. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Copy Files **Slug:** `FRAME_IO_V4_COPY_FILES` Copy between one and 100 Frame.io files into one destination folder. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `file_ids` | array | Yes | One to 100 unique file IDs to copy. | | `parent_id` | string | Yes | Destination folder ID for all copied files. | | `account_id` | string | Yes | Frame.io account ID that owns the files. | | `copy_comments` | string ("none" | "internal" | "public" | "all") | No | Which comments to copy with the files. | | `copy_metadata` | boolean | No | Whether to copy metadata values with the files. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Copy Folder **Slug:** `FRAME_IO_V4_COPY_FOLDER` Copy one Frame.io folder to an optional destination folder, optionally retaining metadata values. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `folder_id` | string | Yes | ID of the folder to copy. | | `parent_id` | string | No | Destination folder ID; omit to use the source folder's parent. | | `account_id` | string | Yes | Frame.io account ID that owns the folder. | | `copy_metadata` | boolean | No | Whether to copy metadata values with the folder. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Copy Folders **Slug:** `FRAME_IO_V4_COPY_FOLDERS` Copy 1 to 100 Frame.io folders into one destination folder, optionally retaining metadata and selected comments. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `parent_id` | string | Yes | Destination folder ID for every copied folder. | | `account_id` | string | Yes | Frame.io account ID that owns the folders. | | `folder_ids` | array | Yes | One to 100 unique source folder IDs. | | `copy_comments` | string ("none" | "internal" | "public" | "all") | No | Which comments to copy. | | `copy_metadata` | boolean | No | Whether to copy metadata values. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Copy Version Stack **Slug:** `FRAME_IO_V4_COPY_VERSION_STACK` Create a copy of a Frame.io version stack in its current or a selected destination folder. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `parent_id` | string | No | Destination folder ID; omit to use the current parent. | | `account_id` | string | Yes | Frame.io account ID that owns the version stack. | | `copy_metadata` | boolean | No | Whether to copy metadata values. | | `version_stack_id` | string | Yes | Version-stack ID to copy. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Create Comment **Slug:** `FRAME_IO_V4_CREATE_COMMENT` Create a text, frame, page, drawing, or text-review comment on a Frame.io file. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `page` | integer | No | Document page for a PDF comment. | | `text` | string | Yes | Comment text. | | `links` | array | No | Optional comment text links. | | `anchor` | object | No | Optional normalized on-screen anchor. | | `file_id` | string | Yes | File ID on which to create the comment. | | `duration` | integer | No | Duration in frames. | | `completed` | boolean | No | Optional completion status. | | `timestamp` | string | No | Optional nonnegative frame number or HH:MM:SS:FF timecode. | | `account_id` | string | Yes | Frame.io account ID that owns the file. | | `annotation` | string | No | Optional stringified drawing geometry. | | `attachments` | array | No | Optional attachments to create with the comment. | | `timestamp_as_timecode` | boolean | No | Interpret a string timestamp as a timecode when true. | | `text_review_annotation` | object | No | Optional text-document review annotation. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Create Comment Attachment **Slug:** `FRAME_IO_V4_CREATE_COMMENT_ATTACHMENT` Create an attachment record and upload URLs for an existing Frame.io comment. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `name` | string | Yes | Attachment file name. | | `file_size` | integer | Yes | Attachment size in bytes. | | `account_id` | string | Yes | Frame.io account ID that owns the comment. | | `comment_id` | string | Yes | Comment ID to attach a file to. | | `media_type` | string | Yes | Attachment media type. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Create Custom Action **Slug:** `FRAME_IO_V4_CREATE_CUSTOM_ACTION` Create a workspace custom action and return its one-time webhook validation secret with the created action. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `url` | string | Yes | URL to which Frame.io sends the event. | | `name` | string | Yes | Custom action name. | | `event` | string | Yes | Event name sent to the action URL. | | `timeout` | integer | No | Request timeout in seconds. | | `account_id` | string | Yes | Frame.io account ID. | | `description` | string | Yes | Custom action description. | | `multi_asset` | boolean | No | Whether the action can trigger on multiple assets. | | `workspace_id` | string | Yes | Workspace in which to create the custom action. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Create Folder **Slug:** `FRAME_IO_V4_CREATE_FOLDER` Create a named child folder under an existing Frame.io folder and return its new ID. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `name` | string | Yes | Name for the new folder. | | `account_id` | string | Yes | Frame.io account ID that owns the parent folder. | | `parent_folder_id` | string | Yes | Folder ID under which to create the child folder. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Create Group **Slug:** `FRAME_IO_V4_CREATE_GROUP` Create 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 | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `name` | string | Yes | Group name. | | `emoji` | string | Yes | Group emoji for UI display. | | `account_id` | string | Yes | Frame.io or Adobe account ID in which to create the group. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Create Local Upload **Slug:** `FRAME_IO_V4_CREATE_LOCAL_UPLOAD` Create a Frame.io file record and obtain presigned URLs for uploading local file bytes. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `name` | string | Yes | File name. | | `file_size` | integer | Yes | File size in bytes. | | `folder_id` | string | Yes | Destination folder ID for the new file. | | `account_id` | string | Yes | Frame.io account ID that owns the folder. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Create Metadata Field **Slug:** `FRAME_IO_V4_CREATE_METADATA_FIELD` Create an account-level Frame.io metadata field definition with type-specific configuration. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `name` | string | Yes | Metadata field definition name. | | `account_id` | string | Yes | Frame.io account ID whose metadata schema to extend. | | `field_type` | string ("date" | "long_text" | "number" | "rating" | "select" | "select_multi" | "text" | "toggle" | "user_multi" | "user_single") | Yes | Type of values accepted by the metadata field. | | `field_configuration` | object | No | Type-specific configuration; required by date, number, rating, select, and user field types. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Create Project **Slug:** `FRAME_IO_V4_CREATE_PROJECT` Create a Frame.io project in a specific workspace. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `name` | string | Yes | Project name. | | `account_id` | string | Yes | Frame.io account ID. | | `restricted` | boolean | No | Whether the new project is restricted. | | `workspace_id` | string | Yes | Workspace in which to create the project. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Create Remote Upload **Slug:** `FRAME_IO_V4_CREATE_REMOTE_UPLOAD` Start an asynchronous Frame.io upload from a source URL and return its file and status links. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `name` | string | Yes | File name. | | `folder_id` | string | Yes | Destination folder ID for the new file. | | `account_id` | string | Yes | Frame.io account ID that owns the folder. | | `source_url` | string | Yes | Publicly reachable URL from which Frame.io should import bytes. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Create Share **Slug:** `FRAME_IO_V4_CREATE_SHARE` Create an externally accessible Frame.io review share for selected project assets. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `name` | string | Yes | Share name. | | `type` | string | Yes | Share discriminator; stable V4 accepts asset. | | `theme` | string ("dark" | "light" | "neutral") | No | Share color theme. | | `access` | string ("public" | "secure") | Yes | Whether the share is public or secure. | | `layout` | string ("grid" | "list" | "reel") | No | Share layout. | | `enabled` | boolean | No | Whether the share link is active. | | `sort_by` | object | No | Metadata field and direction used to sort shared assets. | | `asset_ids` | array | No | File, folder, or version-stack IDs to share. | | `card_size` | string ("small" | "medium" | "large") | No | Card size for grid layout. | | `account_id` | string | Yes | Frame.io account ID that owns the project. | | `expiration` | string | No | ISO 8601 expiration timestamp, or null for no expiration. | | `project_id` | string | Yes | Project ID in which to create the share. | | `description` | string | No | Optional share description; custom branding may be required. | | `drm_enabled` | boolean | No | Whether digital rights management is enabled. | | `accent_color` | string | No | Hex accent color for the share. | | `list_row_size` | string ("small" | "medium" | "large") | No | Row size for list layout. | | `thumbnail_scale` | string ("fit" | "fill") | No | Whether thumbnails fit or fill their cards. | | `captions_enabled` | boolean | No | Whether reviewers can view captions. | | `title_line_count` | integer | No | One or two title lines on grid cards. | | `card_aspect_ratio` | string ("horizontal" | "square" | "vertical") | No | Card aspect ratio for grid or reel layouts. | | `card_info_enabled` | boolean | No | Whether grid cards show metadata. | | `name_column_width` | integer | No | Name-column width in pixels for list layout. | | `watermark_enabled` | boolean | No | Whether watermarking is enabled. | | `commenting_enabled` | boolean | No | Whether reviewers can comment. | | `downloading_enabled` | boolean | No | Whether reviewers can download assets. | | `reel_card_fit_image` | boolean | No | Whether reel thumbnails fill rather than fit their cards. | | `transcripts_enabled` | boolean | No | Whether reviewers can view transcripts. | | `icons_visible_on_list` | boolean | No | Whether list rows show visible-field icons. | | `open_in_viewer_enabled` | boolean | No | Whether a single asset opens in the larger viewer. | | `reel_card_aspect_ratio` | string ("horizontal" | "square" | "vertical") | No | Card aspect ratio for reel layout. | | `editable_fields_enabled` | boolean | No | Whether recipients can edit all visible non-system fields. | | `show_all_asset_versions` | boolean | No | Whether reviewers can see every version in a shared stack. | | `forensic_watermark_enabled` | boolean | No | Whether forensic watermarking is enabled. | | `featured_field_definition_id` | string | No | Metadata field definition featured for recipients. | | `visible_field_definition_ids` | array | No | Metadata field definition IDs visible in the active layout. | | `show_asset_name_in_reel_layout` | boolean | No | Whether reel cards display asset names. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Create Version Stack **Slug:** `FRAME_IO_V4_CREATE_VERSION_STACK` Combine two to ten existing files in one folder into a new ordered Frame.io version stack. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `file_ids` | array | Yes | Two to ten file IDs ordered from oldest/bottom to newest/top version. | | `folder_id` | string | Yes | Folder containing every file to stack. | | `account_id` | string | Yes | Frame.io account ID that owns the parent folder. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Create Webhook **Slug:** `FRAME_IO_V4_CREATE_WEBHOOK` Register a Frame.io workspace webhook for selected events and return its one-time validation secret. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `url` | string | Yes | Callback URL that receives webhook events. | | `name` | string | Yes | Webhook name. | | `events` | array | Yes | Frame.io event types to deliver to the callback. | | `account_id` | string | Yes | Frame.io account ID that owns the workspace. | | `workspace_id` | string | Yes | Workspace ID in which to register the webhook. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Create Workspace **Slug:** `FRAME_IO_V4_CREATE_WORKSPACE` Create a Frame.io workspace in an account. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `name` | string | No | Workspace name. | | `account_id` | string | Yes | Frame.io account ID. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Delete Comment **Slug:** `FRAME_IO_V4_DELETE_COMMENT` Permanently delete a Frame.io comment by ID. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `account_id` | string | Yes | Frame.io account ID that owns the comment. | | `comment_id` | string | Yes | Comment ID to delete. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Delete Comment Attachment **Slug:** `FRAME_IO_V4_DELETE_COMMENT_ATTACHMENT` Permanently delete one attachment from a Frame.io comment. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `account_id` | string | Yes | Frame.io account ID that owns the comment. | | `comment_id` | string | Yes | Comment ID containing the attachment. | | `attachment_id` | string | Yes | Attachment ID to delete. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Delete Custom Action **Slug:** `FRAME_IO_V4_DELETE_CUSTOM_ACTION` Delete a Frame.io custom action by ID. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `action_id` | string | Yes | Custom action ID. | | `account_id` | string | Yes | Frame.io account ID. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Delete File **Slug:** `FRAME_IO_V4_DELETE_FILE` Permanently delete a Frame.io file by ID. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `file_id` | string | Yes | File ID to delete. | | `account_id` | string | Yes | Frame.io account ID that owns the file. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Delete Folder **Slug:** `FRAME_IO_V4_DELETE_FOLDER` Delete a Frame.io folder by ID; use only when the folder and its contents are no longer needed. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `folder_id` | string | Yes | Folder ID to delete; do not pass a project root folder. | | `account_id` | string | Yes | Frame.io account ID that owns the folder. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Delete Metadata Field **Slug:** `FRAME_IO_V4_DELETE_METADATA_FIELD` Delete a mutable account-level Frame.io custom metadata field definition. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `account_id` | string | Yes | Frame.io account ID that owns the metadata field. | | `field_definition_id` | string | Yes | Custom metadata field definition ID to delete. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Delete Project **Slug:** `FRAME_IO_V4_DELETE_PROJECT` Delete a Frame.io project by ID. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `account_id` | string | Yes | Frame.io account ID that owns the project. | | `project_id` | string | Yes | Frame.io project ID. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Delete Share **Slug:** `FRAME_IO_V4_DELETE_SHARE` Permanently delete a Frame.io review share and disable its externally visible link. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `share_id` | string | Yes | Share ID to permanently delete. | | `account_id` | string | Yes | Frame.io account ID that owns the share. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Delete Webhook **Slug:** `FRAME_IO_V4_DELETE_WEBHOOK` Permanently delete a Frame.io webhook registration by ID. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `account_id` | string | Yes | Frame.io account ID that owns the webhook. | | `webhook_id` | string | Yes | Webhook ID to delete. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Delete Workspace **Slug:** `FRAME_IO_V4_DELETE_WORKSPACE` Delete a Frame.io workspace from its account by ID. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `account_id` | string | Yes | Frame.io account ID. | | `workspace_id` | string | Yes | Frame.io workspace ID. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get Collection **Slug:** `FRAME_IO_V4_GET_COLLECTION` Return current details for one Frame.io collection by ID. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `include` | string | No | Optional provider-supported collection relationship to include. | | `account_id` | string | Yes | Frame.io account ID. | | `collection_id` | string | Yes | Collection ID to retrieve. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get Comment **Slug:** `FRAME_IO_V4_GET_COMMENT` Return one Frame.io comment by ID, optionally including its owner or replies. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `include` | string ("owner" | "replies") | No | Optionally include the comment owner or replies. | | `account_id` | string | Yes | Frame.io account ID that owns the comment. | | `comment_id` | string | Yes | Comment ID to retrieve. | | `timestamp_as_timecode` | boolean | No | Return the timestamp as a timecode when true. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get Current User **Slug:** `FRAME_IO_V4_GET_CURRENT_USER` Return the Frame.io user connected through OAuth, including the user ID needed to interpret access and ownership. #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get Custom Action **Slug:** `FRAME_IO_V4_GET_CUSTOM_ACTION` Return current details for one Frame.io custom action by ID. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `include` | string | No | Set to creator to include action creator details. | | `action_id` | string | Yes | Custom action ID. | | `account_id` | string | Yes | Frame.io account ID. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get File **Slug:** `FRAME_IO_V4_GET_FILE` Return one Frame.io file by ID, optionally including creator, project, metadata, or media links. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `file_id` | string | Yes | File ID to retrieve. | | `include` | 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") | No | Optional related data or media-link representation to include. | | `account_id` | string | Yes | Frame.io account ID that owns the file. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get File Upload Status **Slug:** `FRAME_IO_V4_GET_FILE_UPLOAD_STATUS` Return the current completion or failure status of a Frame.io file upload. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `file_id` | string | Yes | File ID whose upload status to retrieve. | | `account_id` | string | Yes | Frame.io account ID that owns the file. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get Folder **Slug:** `FRAME_IO_V4_GET_FOLDER` Return one folder's current details by ID, optionally including creator, project, or metadata data. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `include` | string ("creator" | "project" | "metadata") | No | Optional related data to include in the folder response. | | `folder_id` | string | Yes | Folder ID to retrieve. | | `account_id` | string | Yes | Frame.io account ID that owns the folder. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get Group **Slug:** `FRAME_IO_V4_GET_GROUP` Get an account group's details without changing access; this endpoint may require the user-groups plan feature. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `include` | string | No | Set to creator to include creator details. | | `group_id` | string | Yes | Group ID to retrieve. | | `account_id` | string | Yes | Frame.io or Adobe account ID that owns the group. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get Project **Slug:** `FRAME_IO_V4_GET_PROJECT` Return current details for one Frame.io project by ID. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `include` | string | No | Set to owner to include project owner details. | | `account_id` | string | Yes | Frame.io account ID that owns the project. | | `project_id` | string | Yes | Frame.io project ID. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get Share **Slug:** `FRAME_IO_V4_GET_SHARE` Retrieve a Frame.io share's current access, appearance, and review settings without changing it. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `share_id` | string | Yes | Share ID to retrieve. | | `account_id` | string | Yes | Frame.io account ID that owns the share. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get Version Stack **Slug:** `FRAME_IO_V4_GET_VERSION_STACK` Retrieve a Frame.io version stack and optionally include related data or media links without changing it. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `include` | 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") | No | Optional related data or media links to include. | | `account_id` | string | Yes | Frame.io account ID that owns the version stack. | | `version_stack_id` | string | Yes | Version-stack ID to retrieve. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get Workspace **Slug:** `FRAME_IO_V4_GET_WORKSPACE` Return current details for one Frame.io workspace by ID. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `include` | string | No | Set to creator to include workspace creator details. | | `account_id` | string | Yes | Frame.io account ID. | | `workspace_id` | string | Yes | Frame.io workspace ID. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Import File **Slug:** `FRAME_IO_V4_IMPORT_FILE` Import a file from a storage location already configured on the Frame.io account. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `key` | string | Yes | File key or path within the configured filespace. | | `name` | string | Yes | Imported file name. | | `folder_id` | string | Yes | Destination folder ID for the imported file. | | `account_id` | string | Yes | Frame.io account ID that owns the folder. | | `storage_location` | string | Yes | Configured storage location ID, optionally prefixed by an account ID. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### List Accounts **Slug:** `FRAME_IO_V4_LIST_ACCOUNTS` List Frame.io accounts available to the connected user and return account IDs for downstream discovery. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `sort` | string ("display_name_asc" | "created_at_asc" | "display_name_desc" | "created_at_desc") | No | Order accounts by display name or creation time. | | `page_size` | integer | No | Maximum accounts to return in this page. | | `next_cursor` | string | No | Opaque cursor returned by a previous call; omit for the first page. | | `include_total_count` | boolean | No | Whether to include the total matching account count. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### List Account Users **Slug:** `FRAME_IO_V4_LIST_ACCOUNT_USERS` List users and their roles in an account, optionally including deactivated users, without changing permissions. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `sort` | string ("role_asc" | "role_desc" | "name_asc" | "name_desc" | "email_asc" | "email_desc") | No | Order users by role, name, or email. | | `page_size` | integer | No | Maximum user-role records to return in this page. | | `account_id` | string | Yes | Frame.io account ID whose users and roles to list. | | `next_cursor` | string | No | Opaque cursor returned by a previous call; omit for the first page. | | `include_deactivated` | boolean | No | Whether to include deactivated users. | | `include_total_count` | boolean | No | Whether to include the total matching user count. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### List Audit Logs **Slug:** `FRAME_IO_V4_LIST_AUDIT_LOGS` List account audit events using Frame.io's experimental audit API, optionally expanding the acting user. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `filters` | object | No | Optional audit filters by event type, date range, IP, project, resource, user, or workspace. Dates use YYYY-MM-DD. | | `page_size` | integer | No | Maximum audit events to return in this page. | | `account_id` | string | Yes | Frame.io account ID whose audit events to list. | | `next_cursor` | string | No | Opaque cursor returned by a previous call; omit for the first page and pass it back unchanged to fetch the next page. | | `include_user` | boolean | No | Whether to include acting-user details for each audit event. | | `include_total_count` | boolean | No | Whether to include the total matching audit event count. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### List Collections **Slug:** `FRAME_IO_V4_LIST_COLLECTIONS` List saved collections in a project, including default review-oriented collections and their root folder IDs. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `include` | string | No | Optional provider-supported collection relationship to include. | | `page_size` | integer | No | Maximum collections to return in this page. | | `account_id` | string | Yes | Frame.io account ID that owns the project. | | `project_id` | string | Yes | Project ID whose collections to list. | | `next_cursor` | string | No | Opaque cursor returned by a previous call; omit for the first page and pass it back unchanged to fetch the next page. | | `include_total_count` | boolean | No | Whether to include the total matching collection count. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### List Comments **Slug:** `FRAME_IO_V4_LIST_COMMENTS` List one page of comments on a file, with optional owners, replies, and a next_cursor. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `sort` | string ("owner_asc" | "owner_desc" | "completed_at_asc" | "completed_at_desc" | "created_at_asc" | "created_at_desc") | No | Optional comment ordering. Owner sorting requires include=owner. | | `file_id` | string | Yes | File ID whose comments to list. | | `include` | string ("owner" | "replies") | No | Optionally include comment owners or replies. | | `page_size` | integer | No | Maximum comments to return in this page. | | `account_id` | string | Yes | Frame.io account ID that owns the file. | | `next_cursor` | string | No | Opaque cursor returned by a previous call. | | `include_total_count` | boolean | No | Whether to include the total matching comment count. | | `timestamp_as_timecode` | boolean | No | Return timestamps as timecodes when true. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### List Custom Actions **Slug:** `FRAME_IO_V4_LIST_CUSTOM_ACTIONS` List one page of custom actions configured in a Frame.io workspace. Use next_cursor to retrieve subsequent pages. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `include` | string | No | Set to creator to include action creator details. | | `page_size` | integer | No | Maximum custom actions to return in this page. | | `account_id` | string | Yes | Frame.io account ID. | | `next_cursor` | string | No | Opaque cursor returned by a previous call; omit for the first page. | | `workspace_id` | string | Yes | Workspace whose custom actions to list. | | `include_total_count` | boolean | No | Whether to include the total matching action count. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### List Files **Slug:** `FRAME_IO_V4_LIST_FILES` List one page of files in a folder, with optional media links and a next_cursor. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `sort` | string ("name_asc" | "created_at_asc" | "updated_at_asc" | "file_size_asc" | "name_desc" | "created_at_desc" | "updated_at_desc" | "file_size_desc") | No | Optional file ordering. | | `include` | 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") | No | Optional related data or media-link representation to include. | | `folder_id` | string | Yes | Folder ID whose files to list. | | `page_size` | integer | No | Maximum files to return in this page. | | `account_id` | string | Yes | Frame.io account ID that owns the folder. | | `next_cursor` | string | No | Opaque cursor returned by a previous call. | | `include_total_count` | boolean | No | Whether to include the total matching file count. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### List Folder Children **Slug:** `FRAME_IO_V4_LIST_FOLDER_CHILDREN` List files, folders, and version stacks directly inside a folder, with optional type filtering and media-link expansion. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `sort` | string ("name_asc" | "created_at_asc" | "updated_at_asc" | "name_desc" | "created_at_desc" | "updated_at_desc") | No | Order children by name, creation time, or update time. | | `type` | string | No | Optional provider asset-type filter; omit to return mixed children. | | `include` | 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") | No | Optional related data or media-link representation to include. | | `folder_id` | string | Yes | Folder ID to traverse; use a project's root_folder_id to start at the project root. | | `page_size` | integer | No | Maximum child assets to return in this page. | | `account_id` | string | Yes | Frame.io account ID that owns the folder. | | `next_cursor` | string | No | Opaque cursor returned by a previous call. Omit for the first page and pass it back unchanged to fetch the next page. | | `include_total_count` | boolean | No | Whether to include the total matching child count. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### List Folders **Slug:** `FRAME_IO_V4_LIST_FOLDERS` List only the folders directly inside a Frame.io folder, one cursor-controlled page at a time. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `sort` | string ("name_asc" | "created_at_asc" | "updated_at_asc" | "name_desc" | "created_at_desc" | "updated_at_desc") | No | Optional folder sort order. | | `include` | string ("creator" | "project" | "metadata") | No | Optional related data to include. | | `folder_id` | string | Yes | Parent folder ID whose direct subfolders to list. | | `page_size` | integer | No | Maximum folders to return in this page. | | `account_id` | string | Yes | Frame.io account ID that owns the parent folder. | | `next_cursor` | string | No | Opaque cursor from a previous call; omit for the first page. | | `include_total_count` | boolean | No | Whether to include the total matching folder count. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### List Folder User Roles **Slug:** `FRAME_IO_V4_LIST_FOLDER_USER_ROLES` List one page of users with direct access roles on a folder without changing access. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `folder_id` | string | Yes | Folder ID whose direct user roles to list. | | `page_size` | integer | No | Page size. | | `account_id` | string | Yes | Frame.io account ID that owns the folder. | | `next_cursor` | string | No | Opaque cursor from a previous page. | | `include_deactivated` | boolean | No | Whether to include deactivated users. | | `include_total_count` | boolean | No | Whether to include the total matching role count. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### List Groups **Slug:** `FRAME_IO_V4_LIST_GROUPS` List one page of account groups and membership counts without changing access; this endpoint may require the user-groups plan feature. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `sort` | string ("creator_asc" | "creator_desc" | "name_asc" | "name_desc" | "created_at_asc" | "created_at_desc") | No | Optional group ordering. | | `include` | string | No | Set to creator to include creator details. | | `page_size` | integer | No | Page size. | | `account_id` | string | Yes | Frame.io or Adobe account ID whose groups to list. | | `next_cursor` | string | No | Opaque cursor from a previous page. | | `include_total_count` | boolean | No | Whether to include the total group count. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### List Invited Projects **Slug:** `FRAME_IO_V4_LIST_INVITED_PROJECTS` List projects where the connected user has project-specific collaborator access but no workspace-level access. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `sort` | string ("name_asc" | "created_at_asc" | "name_desc" | "created_at_desc") | No | Optional project sort order. | | `include` | string | No | Set to owner to include project owner details. | | `page_size` | integer | No | Maximum projects to return in this page. | | `account_id` | string | Yes | Frame.io account ID. | | `next_cursor` | string | No | Opaque cursor returned by a previous call; omit for the first page. | | `include_total_count` | boolean | No | Whether to include the total matching project count. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### List Metadata Fields **Slug:** `FRAME_IO_V4_LIST_METADATA_FIELDS` List account metadata field definitions so an agent can discover valid field IDs, types, configuration, and mutability. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `sort` | string ("name_asc" | "created_at_asc" | "name_desc" | "created_at_desc") | No | Order field definitions by name or creation time. | | `filters` | object | No | Optional filters for excluding read-only or inactive field definitions. | | `page_size` | integer | No | Maximum field definitions to return in this page. | | `account_id` | string | Yes | Frame.io account ID whose metadata schema to inspect. | | `next_cursor` | string | No | Opaque cursor returned by a previous call; omit for the first page and pass it back unchanged to fetch the next page. | | `include_creator` | boolean | No | Whether to include creator details for each field definition. | | `include_total_count` | boolean | No | Whether to include the total matching definition count. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### List Projects **Slug:** `FRAME_IO_V4_LIST_PROJECTS` List 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 | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `sort` | string ("name_asc" | "created_at_asc" | "name_desc" | "created_at_desc") | No | Order projects by name or creation time. | | `page_size` | integer | No | Maximum projects to return in this page. | | `account_id` | string | Yes | Frame.io account ID from List Accounts; Adobe-backed IDs must retain the adobe: prefix. | | `next_cursor` | string | No | Opaque cursor returned by a previous call. Repeat the same account and options when continuing; omit for the first page. | | `include_owner` | boolean | No | Whether to include owner details for each project. | | `include_total_count` | boolean | No | Whether to include the total matching project count. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### List Project User Roles **Slug:** `FRAME_IO_V4_LIST_PROJECT_USER_ROLES` List one page of users with direct project access roles without changing access. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `sort` | string ("role_asc" | "role_desc" | "name_asc" | "name_desc" | "email_asc" | "email_desc") | No | Optional user-role ordering. | | `page_size` | integer | No | Page size. | | `account_id` | string | Yes | Frame.io or Adobe account ID. | | `project_id` | string | Yes | Frame.io or Adobe project ID whose roles to list. | | `next_cursor` | string | No | Opaque cursor from a previous page. | | `include_deactivated` | boolean | No | Whether to include deactivated users. | | `include_total_count` | boolean | No | Whether to include the total role count. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### List Recently Deleted Assets **Slug:** `FRAME_IO_V4_LIST_RECENTLY_DELETED_ASSETS` List one page of recently deleted files, folders, and version stacks in a project, ordered by the requested deletion or name sort. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `sort` | string ("deleted_at_asc" | "deleted_at_desc" | "name_asc" | "name_desc") | No | Optional deleted-asset sort order. | | `page_size` | integer | No | Maximum deleted assets to return in this page. | | `account_id` | string | Yes | Frame.io account ID. | | `project_id` | string | Yes | Project whose deleted assets to list. | | `next_cursor` | string | No | Opaque cursor returned by a previous call; omit for the first page. | | `include_total_count` | boolean | No | Whether to request a total matching asset count. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### List Share Activities **Slug:** `FRAME_IO_V4_LIST_SHARE_ACTIVITIES` Return one page of view, download, and comment activity recorded for a Frame.io share. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `include` | string | No | Include full user details. | | `share_id` | string | Yes | Share ID whose activity to list. | | `page_size` | integer | No | Maximum activity records to return in this page. | | `account_id` | string | Yes | Frame.io account ID that owns the share. | | `next_cursor` | string | No | Opaque cursor from a previous response; omit for the first page. | | `include_total_count` | boolean | No | Whether to request the total activity count. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### List Share Assets **Slug:** `FRAME_IO_V4_LIST_SHARE_ASSETS` Return one page of every direct and recursively nested asset exposed by a Frame.io share. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `sort` | string ("name_asc" | "created_at_asc" | "updated_at_asc" | "name_desc" | "created_at_desc" | "updated_at_desc") | No | Optional asset sort order. | | `include` | 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") | No | Optional related data or media-link representation to include. | | `share_id` | string | Yes | Share ID whose recursively expanded assets to list. | | `page_size` | integer | No | Maximum assets to return in this page. | | `account_id` | string | Yes | Frame.io account ID that owns the share. | | `next_cursor` | string | No | Opaque cursor from a previous response; omit for the first page. | | `include_total_count` | boolean | No | Whether to include the total matching asset count. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### List Share Reviewers **Slug:** `FRAME_IO_V4_LIST_SHARE_REVIEWERS` Return one page of reviewers currently associated with a Frame.io share without changing access. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `sort` | string ("name_asc" | "active" | "name_desc" | "inactive") | No | Optional reviewer sort order. | | `share_id` | string | Yes | Share ID whose reviewers to list. | | `page_size` | integer | No | Maximum reviewers to return in this page. | | `account_id` | string | Yes | Frame.io account ID that owns the share. | | `next_cursor` | string | No | Opaque cursor from a previous response; omit for the first page. | | `include_total_count` | boolean | No | Whether to include the total reviewer count. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### List Shares **Slug:** `FRAME_IO_V4_LIST_SHARES` List review shares for a project without creating or changing externally visible review links. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `sort` | string ("name_asc" | "created_at_asc" | "name_desc" | "created_at_desc") | No | Order shares by name or creation time. | | `page_size` | integer | No | Maximum shares to return in this page. | | `account_id` | string | Yes | Frame.io account ID that owns the project. | | `project_id` | string | Yes | Project ID whose shares to list. | | `next_cursor` | string | No | Opaque cursor returned by a previous call. Repeat the same project and options when continuing; omit for the first page. | | `include_total_count` | boolean | No | Whether to include the total matching share count. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### List Version Stack Children **Slug:** `FRAME_IO_V4_LIST_VERSION_STACK_CHILDREN` Return one page of files in a Frame.io version stack, with optional related data or media links. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `sort` | string ("name_asc" | "created_at_asc" | "updated_at_asc" | "file_size_asc" | "name_desc" | "created_at_desc" | "updated_at_desc" | "file_size_desc") | No | Optional child-file sort order. | | `include` | 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") | No | Optional related data or media-link representation to include. | | `page_size` | integer | No | Maximum child files to return in this page. | | `account_id` | string | Yes | Frame.io account ID that owns the version stack. | | `next_cursor` | string | No | Opaque cursor from a previous response; omit for the first page. | | `version_stack_id` | string | Yes | Version-stack ID whose files to list. | | `include_total_count` | boolean | No | Whether to include the total child-file count. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### List Version Stacks **Slug:** `FRAME_IO_V4_LIST_VERSION_STACKS` Return one page of version stacks directly contained in a Frame.io folder without changing them. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `sort` | string ("name_asc" | "created_at_asc" | "updated_at_asc" | "name_desc" | "created_at_desc" | "updated_at_desc") | No | Optional version-stack sort order. | | `include` | 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") | No | Optional related data or media-link representation to include. | | `folder_id` | string | Yes | Folder ID whose version stacks to list. | | `page_size` | integer | No | Maximum version stacks to return in this page. | | `account_id` | string | Yes | Frame.io account ID that owns the folder. | | `next_cursor` | string | No | Opaque cursor from a previous response; omit for the first page. | | `include_total_count` | boolean | No | Whether to include the total version-stack count. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### List Webhooks **Slug:** `FRAME_IO_V4_LIST_WEBHOOKS` List webhook registrations in a workspace without creating callbacks or requiring external delivery infrastructure. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `sort` | string ("name_asc" | "created_at_asc" | "name_desc" | "created_at_desc") | No | Order webhooks by name or creation time. | | `page_size` | integer | No | Maximum webhooks to return in this page. | | `account_id` | string | Yes | Frame.io account ID that owns the workspace. | | `next_cursor` | string | No | Opaque cursor returned by a previous call; omit for the first page. | | `workspace_id` | string | Yes | Workspace ID whose webhook registrations to list. | | `include_creator` | boolean | No | Whether to include creator details for each webhook. | | `include_total_count` | boolean | No | Whether to include the total matching webhook count. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### List Workspace Projects **Slug:** `FRAME_IO_V4_LIST_WORKSPACE_PROJECTS` List one page of projects in a specific Frame.io workspace. Use next_cursor to retrieve subsequent pages. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `sort` | string ("name_asc" | "created_at_asc" | "name_desc" | "created_at_desc") | No | Optional project sort order. | | `include` | string | No | Set to owner to include project owner details. | | `page_size` | integer | No | Maximum projects to return in this page. | | `account_id` | string | Yes | Frame.io account ID. | | `next_cursor` | string | No | Opaque cursor returned by a previous call; omit for the first page. | | `workspace_id` | string | Yes | Workspace whose projects to list. | | `include_total_count` | boolean | No | Whether to include the total matching project count. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### List Workspaces **Slug:** `FRAME_IO_V4_LIST_WORKSPACES` List workspaces in an account and return workspace IDs used by project, webhook, and collaboration workflows. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `sort` | string ("name_asc" | "created_at_asc" | "name_desc" | "created_at_desc") | No | Order workspaces by name or creation time. | | `page_size` | integer | No | Maximum workspaces to return in this page. | | `account_id` | string | Yes | Frame.io account ID from List Accounts; Adobe-backed IDs must retain the adobe: prefix. | | `next_cursor` | string | No | Opaque cursor returned by a previous call; omit for the first page. | | `include_creator` | boolean | No | Whether to include creator details for each workspace. | | `include_total_count` | boolean | No | Whether to include the total matching workspace count. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### List Workspace User Roles **Slug:** `FRAME_IO_V4_LIST_WORKSPACE_USER_ROLES` List one page of users with workspace access roles without changing access. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `sort` | string ("role_asc" | "role_desc" | "name_asc" | "name_desc" | "email_asc" | "email_desc") | No | Optional user-role ordering. | | `page_size` | integer | No | Page size. | | `account_id` | string | Yes | Frame.io or Adobe account ID. | | `next_cursor` | string | No | Opaque cursor from a previous page. | | `workspace_id` | string | Yes | Workspace ID whose roles to list. | | `include_deactivated` | boolean | No | Whether to include deactivated users. | | `include_total_count` | boolean | No | Whether to include the total role count. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Move File **Slug:** `FRAME_IO_V4_MOVE_FILE` Move one Frame.io file to a folder or version stack. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `file_id` | string | Yes | File ID to move. | | `parent_id` | string | No | Optional destination folder or version stack ID. | | `account_id` | string | Yes | Frame.io account ID that owns the file. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Move Files **Slug:** `FRAME_IO_V4_MOVE_FILES` Move between one and 100 Frame.io files into one destination folder. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `file_ids` | array | Yes | One to 100 unique file IDs to move. | | `parent_id` | string | Yes | Destination folder ID for all files. | | `account_id` | string | Yes | Frame.io account ID that owns the files. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Move Folder **Slug:** `FRAME_IO_V4_MOVE_FOLDER` Move one Frame.io folder to a destination folder and return its updated details. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `folder_id` | string | Yes | ID of the folder to move. | | `parent_id` | string | No | Destination folder ID. | | `account_id` | string | Yes | Frame.io account ID that owns the folder. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Move Folders **Slug:** `FRAME_IO_V4_MOVE_FOLDERS` Move 1 to 100 Frame.io folders into one destination folder and return their updated details. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `parent_id` | string | Yes | Destination folder ID for every moved folder. | | `account_id` | string | Yes | Frame.io account ID that owns the folders. | | `folder_ids` | array | Yes | One to 100 unique folder IDs to move. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Move Version Stack **Slug:** `FRAME_IO_V4_MOVE_VERSION_STACK` Move a Frame.io version stack to a destination folder, changing its parent location. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `parent_id` | string | No | Destination folder ID. | | `account_id` | string | Yes | Frame.io account ID that owns the version stack. | | `version_stack_id` | string | Yes | Version-stack ID to move. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Remove Asset From Share **Slug:** `FRAME_IO_V4_REMOVE_ASSET_FROM_SHARE` Remove an asset from a Frame.io share without deleting the underlying file, folder, or version stack. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `asset_id` | string | Yes | Asset ID to remove from the share. | | `share_id` | string | Yes | Share ID to remove the asset from. | | `account_id` | string | Yes | Frame.io account ID that owns the share. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Remove Folder User **Slug:** `FRAME_IO_V4_REMOVE_FOLDER_USER` Remove a user's direct role from a folder, revoking that folder access. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `user_id` | string | Yes | User whose folder access will be removed. | | `folder_id` | string | Yes | Folder from which access will be removed. | | `account_id` | string | Yes | Frame.io account ID that owns the folder. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Remove Project User **Slug:** `FRAME_IO_V4_REMOVE_PROJECT_USER` Remove a user's direct role from a project, revoking that project access. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `user_id` | string | Yes | User whose project access will be removed. | | `account_id` | string | Yes | Frame.io or Adobe account ID. | | `project_id` | string | Yes | Project from which access will be removed. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Remove Share Reviewers **Slug:** `FRAME_IO_V4_REMOVE_SHARE_REVIEWERS` Revoke selected reviewers' access to a secure Frame.io share. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `emails` | array | No | Reviewer email addresses to remove. | | `share_id` | string | Yes | Secure share ID to revoke reviewer access from. | | `user_ids` | array | No | Frame.io user IDs to remove. | | `account_id` | string | Yes | Frame.io account ID that owns the share. | | `adobe_user_ids` | array | No | Adobe user IDs to remove. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Remove Workspace User **Slug:** `FRAME_IO_V4_REMOVE_WORKSPACE_USER` Remove a user's role from a workspace, revoking that workspace access. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `user_id` | string | Yes | User whose workspace access will be removed. | | `account_id` | string | Yes | Frame.io or Adobe account ID. | | `workspace_id` | string | Yes | Workspace from which access will be removed. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Search Account **Slug:** `FRAME_IO_V4_SEARCH_ACCOUNT` Search visible projects, folders, files, and version stacks across a Frame.io account by text. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `query` | string | Yes | Text to search for in visible Frame.io resources. | | `engine` | string ("lexical" | "nlp") | No | Use lexical for exact term matching or nlp for natural-language search. | | `page_size` | integer | No | Maximum search results to return in this page. | | `account_id` | string | Yes | Frame.io account ID to search. | | `next_cursor` | string | No | Opaque cursor returned by a previous search call; omit for the first page. | | `include_folders` | boolean | No | Whether folder results may be returned. | | `include_projects` | boolean | No | Whether project results may be returned. | | `include_total_count` | boolean | No | Whether to include the total matching result count. | | `include_files_and_version_stacks` | boolean | No | Whether file and version-stack results may be returned. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Show Metadata **Slug:** `FRAME_IO_V4_SHOW_METADATA` Return one Frame.io file's metadata values and definitions, optionally including fields with null values. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `file_id` | string | Yes | File ID whose metadata values to retrieve. | | `show_null` | boolean | No | Whether to include metadata fields whose current value is null. | | `account_id` | string | Yes | Frame.io account ID that owns the file. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Show Webhook **Slug:** `FRAME_IO_V4_SHOW_WEBHOOK` Return one Frame.io webhook's current callback, event, status, and optional creator details. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `include` | string | No | Pass creator to include webhook creator details. | | `account_id` | string | Yes | Frame.io account ID that owns the webhook. | | `webhook_id` | string | Yes | Webhook ID to retrieve. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Update Account User Role **Slug:** `FRAME_IO_V4_UPDATE_ACCOUNT_USER_ROLE` Change 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 | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `role` | string ("member" | "admin") | Yes | New account role: member or admin. | | `user_id` | string | Yes | Frame.io user ID whose role will change. | | `account_id` | string | Yes | Frame.io or Adobe account ID whose account-level access will change. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Update Comment **Slug:** `FRAME_IO_V4_UPDATE_COMMENT` Update the text, location, annotation, timing, or completion state of a Frame.io comment. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `page` | integer | No | Optional PDF document page. | | `text` | string | No | Optional new comment text. | | `links` | array | No | Optional comment text links. | | `anchor` | object | No | Optional normalized on-screen anchor. | | `duration` | integer | No | Optional duration in frames. | | `completed` | boolean | No | Optional completion status. | | `timestamp` | string | No | Optional frame number or timecode. | | `account_id` | string | Yes | Frame.io account ID that owns the comment. | | `annotation` | string | No | Optional stringified drawing geometry. | | `comment_id` | string | Yes | Comment ID to update. | | `timestamp_as_timecode` | boolean | No | Interpret a string timestamp as a timecode when true. | | `text_review_annotation` | object | No | Optional text review annotation changes. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Update Custom Action **Slug:** `FRAME_IO_V4_UPDATE_CUSTOM_ACTION` Update the configuration or active state of a Frame.io custom action. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `url` | string | No | New action URL. | | `name` | string | No | New action name. | | `event` | string | No | New event name. | | `active` | boolean | No | Whether the custom action is active. | | `timeout` | integer | No | New request timeout in seconds. | | `action_id` | string | Yes | Custom action ID. | | `account_id` | string | Yes | Frame.io account ID. | | `description` | string | No | New action description. | | `multi_asset` | boolean | No | Whether the action can trigger on multiple assets. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Update File **Slug:** `FRAME_IO_V4_UPDATE_FILE` Update a Frame.io file's name and return its current details. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `name` | string | No | Optional new file name. | | `file_id` | string | Yes | File ID to update. | | `account_id` | string | Yes | Frame.io account ID that owns the file. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Update Folder **Slug:** `FRAME_IO_V4_UPDATE_FOLDER` Rename an existing Frame.io folder and return its updated details. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `name` | string | Yes | New name for the folder. | | `folder_id` | string | Yes | Folder ID to rename. | | `account_id` | string | Yes | Frame.io account ID that owns the folder. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Update Folder User Role **Slug:** `FRAME_IO_V4_UPDATE_FOLDER_USER_ROLE` Add 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 | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `role` | string ("full_access" | "editor" | "edit_only" | "commenter" | "viewer") | Yes | New folder role for the user. | | `user_id` | string | Yes | User to add or whose role to replace. | | `folder_id` | string | Yes | Folder whose access will change. | | `account_id` | string | Yes | Frame.io account ID that owns the folder. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Update Group **Slug:** `FRAME_IO_V4_UPDATE_GROUP` Change 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 | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `name` | string | No | New group name; omit to leave unchanged. | | `emoji` | string | No | New group emoji; omit to leave unchanged. | | `group_id` | string | Yes | Group ID to update. | | `account_id` | string | Yes | Frame.io or Adobe account ID that owns the group. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Update Metadata Field **Slug:** `FRAME_IO_V4_UPDATE_METADATA_FIELD` Update the name or type-specific configuration of a mutable account-level Frame.io metadata field definition. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `name` | string | No | Optional replacement field name. | | `account_id` | string | Yes | Frame.io account ID that owns the metadata field. | | `field_type` | string ("date" | "long_text" | "number" | "rating" | "select" | "select_multi" | "text" | "toggle" | "user_multi" | "user_single") | Yes | Current type of the field definition being updated. | | `field_configuration` | object | No | Optional replacement type-specific configuration. | | `field_definition_id` | string | Yes | Metadata field definition ID to update. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Update Project **Slug:** `FRAME_IO_V4_UPDATE_PROJECT` Update a Frame.io project's name, restricted state, or status. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `name` | string | No | New project name. | | `status` | string ("active" | "inactive") | No | New project status. | | `account_id` | string | Yes | Frame.io account ID that owns the project. | | `project_id` | string | Yes | Frame.io project ID. | | `restricted` | boolean | No | Whether the project is restricted. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Update Project User Role **Slug:** `FRAME_IO_V4_UPDATE_PROJECT_USER_ROLE` Add a user to a project with the selected role, or replace an existing role, immediately changing project access. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `role` | string ("full_access" | "editor" | "edit_only" | "commenter" | "viewer") | Yes | New project role for the user. | | `user_id` | string | Yes | User to add or whose role to replace. | | `account_id` | string | Yes | Frame.io or Adobe account ID. | | `project_id` | string | Yes | Project whose access will change. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Update Share **Slug:** `FRAME_IO_V4_UPDATE_SHARE` Change a Frame.io share's access, review, appearance, or expiration settings. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `name` | string | No | New share name, or null when supported by Frame.io. | | `theme` | string ("dark" | "light" | "neutral") | No | Share color theme. | | `access` | string ("public" | "secure") | No | Share access mode. | | `layout` | string ("grid" | "list" | "reel") | No | Share layout. | | `enabled` | boolean | No | Whether the share link is active. | | `sort_by` | object | No | Metadata field and direction used to sort shared assets. | | `share_id` | string | Yes | Share ID to update. | | `card_size` | string ("small" | "medium" | "large") | No | Card size for grid layout. | | `account_id` | string | Yes | Frame.io account ID that owns the share. | | `expiration` | string | No | ISO 8601 expiration timestamp, or null for no expiration. | | `description` | string | No | Share description, or null to clear it. | | `drm_enabled` | boolean | No | Whether digital rights management is enabled. | | `accent_color` | string | No | Hex accent color for the share. | | `list_row_size` | string ("small" | "medium" | "large") | No | Row size for list layout. | | `thumbnail_scale` | string ("fit" | "fill") | No | Whether thumbnails fit or fill their cards. | | `captions_enabled` | boolean | No | Whether reviewers can view captions. | | `title_line_count` | integer | No | One or two title lines on grid cards. | | `card_aspect_ratio` | string ("horizontal" | "square" | "vertical") | No | Card aspect ratio for grid or reel layouts. | | `card_info_enabled` | boolean | No | Whether grid cards show metadata. | | `name_column_width` | integer | No | Name-column width in pixels for list layout. | | `watermark_enabled` | boolean | No | Whether watermarking is enabled. | | `commenting_enabled` | boolean | No | Whether reviewers can comment. | | `downloading_enabled` | boolean | No | Whether reviewers can download assets. | | `reel_card_fit_image` | boolean | No | Whether reel thumbnails fill rather than fit their cards. | | `transcripts_enabled` | boolean | No | Whether reviewers can view transcripts. | | `icons_visible_on_list` | boolean | No | Whether list rows show visible-field icons. | | `open_in_viewer_enabled` | boolean | No | Whether a single asset opens in the larger viewer. | | `reel_card_aspect_ratio` | string ("horizontal" | "square" | "vertical") | No | Card aspect ratio for reel layout. | | `editable_fields_enabled` | boolean | No | Whether recipients can edit all visible non-system fields. | | `show_all_asset_versions` | boolean | No | Whether reviewers can see every version in a shared stack. | | `forensic_watermark_enabled` | boolean | No | Whether forensic watermarking is enabled. | | `featured_field_definition_id` | string | No | Metadata field definition featured for recipients. | | `visible_field_definition_ids` | array | No | Metadata field definition IDs visible in the active layout. | | `show_asset_name_in_reel_layout` | boolean | No | Whether reel cards display asset names. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Update Webhook **Slug:** `FRAME_IO_V4_UPDATE_WEBHOOK` Update a Frame.io webhook's active state, subscribed events, name, or callback URL. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `url` | string | No | Replacement callback URL. | | `name` | string | No | Replacement webhook name. | | `active` | boolean | No | Whether the webhook should be active. | | `events` | array | No | Replacement Frame.io event types. | | `account_id` | string | Yes | Frame.io account ID that owns the webhook. | | `webhook_id` | string | Yes | Webhook ID to update. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Update Workspace **Slug:** `FRAME_IO_V4_UPDATE_WORKSPACE` Update the name of an existing Frame.io workspace. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `name` | string | No | New workspace name. | | `account_id` | string | Yes | Frame.io account ID. | | `workspace_id` | string | Yes | Frame.io workspace ID. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Update Workspace User Role **Slug:** `FRAME_IO_V4_UPDATE_WORKSPACE_USER_ROLE` Add a user to a workspace with the selected role, or replace an existing role, immediately changing workspace access. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `role` | string ("workspace_admin" | "full_access" | "editor" | "edit_only" | "commenter" | "viewer") | Yes | New workspace role for the user. | | `user_id` | string | Yes | User to add or whose role to replace. | | `account_id` | string | Yes | Frame.io or Adobe account ID. | | `workspace_id` | string | Yes | Workspace whose access will change. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not |