> ## Documentation Index
> Fetch the complete documentation index at: https://composio-preview.mintlify.site/llms.txt
> Use this file to discover all available pages before exploring further.

# Frame.io V4

> Frame.io V4 provides collaborative media review, project, asset, comment, sharing, metadata, and workspace management through Adobe IMS user authorization.

![Frame.io V4 logo](https://mintcdn.com/composio-preview/GL28i3tBlbEbBd-f/images/toolkits/frame_io_v4.svg?fit=max\&auto=format\&n=GL28i3tBlbEbBd-f\&q=85\&s=57b243730706fb7c837b22cfa6285183)

* **Category:** video & audio
* **Auth:** OAUTH2
* **Composio-managed OAuth available?** No
* **Tools:** 97
* **Triggers:** 0
* **Slug:** `FRAME_IO_V4`
* **Version:** 00000000\_00

## Tools

> [accordion] 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
>
> **asset\_id** `string` *required*
>
> File, folder, or version-stack ID to add to the share.
>
> **share\_id** `string` *required*
>
> Share ID to add the asset to.
>
> **account\_id** `string` *required*
>
> Frame.io account ID that owns the share.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] 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
>
> **emails** `array`
>
> Email addresses to add or notify.
>
> **message** `string` *required*
>
> Message included in reviewer email notifications.
>
> **share\_id** `string` *required*
>
> Share ID to grant reviewer access to or notify.
>
> **user\_ids** `array`
>
> Frame.io user IDs to add.
>
> **account\_id** `string` *required*
>
> Frame.io account ID that owns the share.
>
> **adobe\_user\_ids** `array`
>
> Adobe user IDs to add.
>
> **share\_list\_ids** `array`
>
> Share-list IDs whose members to add.
>
> **notify\_by\_email** `boolean`
>
> Whether to send email notifications.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Bulk Update Metadata
>
> **Slug:** `FRAME_IO_V4_BULK_UPDATE_METADATA`
>
> Set metadata field values across multiple files in one Frame.io project.
>
> #### Input Parameters
>
> **values** `array` *required*
>
> Metadata field IDs and replacement values.
>
> **file\_ids** `array` *required*
>
> File IDs whose metadata values to update.
>
> **account\_id** `string` *required*
>
> Frame.io account ID that owns the project.
>
> **project\_id** `string` *required*
>
> Project ID containing the target files.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Copy File
>
> **Slug:** `FRAME_IO_V4_COPY_FILE`
>
> Copy one Frame.io file to a destination folder, optionally copying metadata or comments.
>
> #### Input Parameters
>
> **file\_id** `string` *required*
>
> File ID to copy.
>
> **parent\_id** `string`
>
> Destination folder ID; omit to use the current parent.
>
> **account\_id** `string` *required*
>
> Frame.io account ID that owns the file.
>
> **copy\_comments** `string ("none" | "internal" | "public" | "all")`
>
> Which comments to copy with the file.
>
> **copy\_metadata** `boolean`
>
> Whether to copy the file's metadata values.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Copy Files
>
> **Slug:** `FRAME_IO_V4_COPY_FILES`
>
> Copy between one and 100 Frame.io files into one destination folder.
>
> #### Input Parameters
>
> **file\_ids** `array` *required*
>
> One to 100 unique file IDs to copy.
>
> **parent\_id** `string` *required*
>
> Destination folder ID for all copied files.
>
> **account\_id** `string` *required*
>
> Frame.io account ID that owns the files.
>
> **copy\_comments** `string ("none" | "internal" | "public" | "all")`
>
> Which comments to copy with the files.
>
> **copy\_metadata** `boolean`
>
> Whether to copy metadata values with the files.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Copy Folder
>
> **Slug:** `FRAME_IO_V4_COPY_FOLDER`
>
> Copy one Frame.io folder to an optional destination folder, optionally retaining metadata values.
>
> #### Input Parameters
>
> **folder\_id** `string` *required*
>
> ID of the folder to copy.
>
> **parent\_id** `string`
>
> Destination folder ID; omit to use the source folder's parent.
>
> **account\_id** `string` *required*
>
> Frame.io account ID that owns the folder.
>
> **copy\_metadata** `boolean`
>
> Whether to copy metadata values with the folder.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] 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
>
> **parent\_id** `string` *required*
>
> Destination folder ID for every copied folder.
>
> **account\_id** `string` *required*
>
> Frame.io account ID that owns the folders.
>
> **folder\_ids** `array` *required*
>
> One to 100 unique source folder IDs.
>
> **copy\_comments** `string ("none" | "internal" | "public" | "all")`
>
> Which comments to copy.
>
> **copy\_metadata** `boolean`
>
> Whether to copy metadata values.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] 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
>
> **parent\_id** `string`
>
> Destination folder ID; omit to use the current parent.
>
> **account\_id** `string` *required*
>
> Frame.io account ID that owns the version stack.
>
> **copy\_metadata** `boolean`
>
> Whether to copy metadata values.
>
> **version\_stack\_id** `string` *required*
>
> Version-stack ID to copy.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] 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
>
> **page** `integer`
>
> Document page for a PDF comment.
>
> **text** `string` *required*
>
> Comment text.
>
> **links** `array`
>
> Optional comment text links.
>
> **anchor** `object`
>
> Optional normalized on-screen anchor.
>
> **file\_id** `string` *required*
>
> File ID on which to create the comment.
>
> **duration** `integer`
>
> Duration in frames.
>
> **completed** `boolean`
>
> Optional completion status.
>
> **timestamp** `string`
>
> Optional nonnegative frame number or HH:MM:SS:FF timecode.
>
> **account\_id** `string` *required*
>
> Frame.io account ID that owns the file.
>
> **annotation** `string`
>
> Optional stringified drawing geometry.
>
> **attachments** `array`
>
> Optional attachments to create with the comment.
>
> **timestamp\_as\_timecode** `boolean`
>
> Interpret a string timestamp as a timecode when true.
>
> **text\_review\_annotation** `object`
>
> Optional text-document review annotation.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] 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
>
> **name** `string` *required*
>
> Attachment file name.
>
> **file\_size** `integer` *required*
>
> Attachment size in bytes.
>
> **account\_id** `string` *required*
>
> Frame.io account ID that owns the comment.
>
> **comment\_id** `string` *required*
>
> Comment ID to attach a file to.
>
> **media\_type** `string` *required*
>
> Attachment media type.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] 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
>
> **url** `string` *required*
>
> URL to which Frame.io sends the event.
>
> **name** `string` *required*
>
> Custom action name.
>
> **event** `string` *required*
>
> Event name sent to the action URL.
>
> **timeout** `integer`
>
> Request timeout in seconds.
>
> **account\_id** `string` *required*
>
> Frame.io account ID.
>
> **description** `string` *required*
>
> Custom action description.
>
> **multi\_asset** `boolean`
>
> Whether the action can trigger on multiple assets.
>
> **workspace\_id** `string` *required*
>
> Workspace in which to create the custom action.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] 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
>
> **name** `string` *required*
>
> Name for the new folder.
>
> **account\_id** `string` *required*
>
> Frame.io account ID that owns the parent folder.
>
> **parent\_folder\_id** `string` *required*
>
> Folder ID under which to create the child folder.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] 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
>
> **name** `string` *required*
>
> Group name.
>
> **emoji** `string` *required*
>
> Group emoji for UI display.
>
> **account\_id** `string` *required*
>
> Frame.io or Adobe account ID in which to create the group.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] 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
>
> **name** `string` *required*
>
> File name.
>
> **file\_size** `integer` *required*
>
> File size in bytes.
>
> **folder\_id** `string` *required*
>
> Destination folder ID for the new file.
>
> **account\_id** `string` *required*
>
> Frame.io account ID that owns the folder.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] 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
>
> **name** `string` *required*
>
> Metadata field definition name.
>
> **account\_id** `string` *required*
>
> 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")` *required*
>
> Type of values accepted by the metadata field.
>
> **field\_configuration** `object`
>
> Type-specific configuration; required by date, number, rating, select, and user field types.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Create Project
>
> **Slug:** `FRAME_IO_V4_CREATE_PROJECT`
>
> Create a Frame.io project in a specific workspace.
>
> #### Input Parameters
>
> **name** `string` *required*
>
> Project name.
>
> **account\_id** `string` *required*
>
> Frame.io account ID.
>
> **restricted** `boolean`
>
> Whether the new project is restricted.
>
> **workspace\_id** `string` *required*
>
> Workspace in which to create the project.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] 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
>
> **name** `string` *required*
>
> File name.
>
> **folder\_id** `string` *required*
>
> Destination folder ID for the new file.
>
> **account\_id** `string` *required*
>
> Frame.io account ID that owns the folder.
>
> **source\_url** `string` *required*
>
> Publicly reachable URL from which Frame.io should import bytes.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Create Share
>
> **Slug:** `FRAME_IO_V4_CREATE_SHARE`
>
> Create an externally accessible Frame.io review share for selected project assets.
>
> #### Input Parameters
>
> **name** `string` *required*
>
> Share name.
>
> **type** `string` *required*
>
> Share discriminator; stable V4 accepts asset.
>
> **theme** `string ("dark" | "light" | "neutral")`
>
> Share color theme.
>
> **access** `string ("public" | "secure")` *required*
>
> Whether the share is public or secure.
>
> **layout** `string ("grid" | "list" | "reel")`
>
> Share layout.
>
> **enabled** `boolean`
>
> Whether the share link is active.
>
> **sort\_by** `object`
>
> Metadata field and direction used to sort shared assets.
>
> **asset\_ids** `array`
>
> File, folder, or version-stack IDs to share.
>
> **card\_size** `string ("small" | "medium" | "large")`
>
> Card size for grid layout.
>
> **account\_id** `string` *required*
>
> Frame.io account ID that owns the project.
>
> **expiration** `string`
>
> ISO 8601 expiration timestamp, or null for no expiration.
>
> **project\_id** `string` *required*
>
> Project ID in which to create the share.
>
> **description** `string`
>
> Optional share description; custom branding may be required.
>
> **drm\_enabled** `boolean`
>
> Whether digital rights management is enabled.
>
> **accent\_color** `string`
>
> Hex accent color for the share.
>
> **list\_row\_size** `string ("small" | "medium" | "large")`
>
> Row size for list layout.
>
> **thumbnail\_scale** `string ("fit" | "fill")`
>
> Whether thumbnails fit or fill their cards.
>
> **captions\_enabled** `boolean`
>
> Whether reviewers can view captions.
>
> **title\_line\_count** `integer`
>
> One or two title lines on grid cards.
>
> **card\_aspect\_ratio** `string ("horizontal" | "square" | "vertical")`
>
> Card aspect ratio for grid or reel layouts.
>
> **card\_info\_enabled** `boolean`
>
> Whether grid cards show metadata.
>
> **name\_column\_width** `integer`
>
> Name-column width in pixels for list layout.
>
> **watermark\_enabled** `boolean`
>
> Whether watermarking is enabled.
>
> **commenting\_enabled** `boolean`
>
> Whether reviewers can comment.
>
> **downloading\_enabled** `boolean`
>
> Whether reviewers can download assets.
>
> **reel\_card\_fit\_image** `boolean`
>
> Whether reel thumbnails fill rather than fit their cards.
>
> **transcripts\_enabled** `boolean`
>
> Whether reviewers can view transcripts.
>
> **icons\_visible\_on\_list** `boolean`
>
> Whether list rows show visible-field icons.
>
> **open\_in\_viewer\_enabled** `boolean`
>
> Whether a single asset opens in the larger viewer.
>
> **reel\_card\_aspect\_ratio** `string ("horizontal" | "square" | "vertical")`
>
> Card aspect ratio for reel layout.
>
> **editable\_fields\_enabled** `boolean`
>
> Whether recipients can edit all visible non-system fields.
>
> **show\_all\_asset\_versions** `boolean`
>
> Whether reviewers can see every version in a shared stack.
>
> **forensic\_watermark\_enabled** `boolean`
>
> Whether forensic watermarking is enabled.
>
> **featured\_field\_definition\_id** `string`
>
> Metadata field definition featured for recipients.
>
> **visible\_field\_definition\_ids** `array`
>
> Metadata field definition IDs visible in the active layout.
>
> **show\_asset\_name\_in\_reel\_layout** `boolean`
>
> Whether reel cards display asset names.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] 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
>
> **file\_ids** `array` *required*
>
> Two to ten file IDs ordered from oldest/bottom to newest/top version.
>
> **folder\_id** `string` *required*
>
> Folder containing every file to stack.
>
> **account\_id** `string` *required*
>
> Frame.io account ID that owns the parent folder.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] 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
>
> **url** `string` *required*
>
> Callback URL that receives webhook events.
>
> **name** `string` *required*
>
> Webhook name.
>
> **events** `array` *required*
>
> Frame.io event types to deliver to the callback.
>
> **account\_id** `string` *required*
>
> Frame.io account ID that owns the workspace.
>
> **workspace\_id** `string` *required*
>
> Workspace ID in which to register the webhook.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Create Workspace
>
> **Slug:** `FRAME_IO_V4_CREATE_WORKSPACE`
>
> Create a Frame.io workspace in an account.
>
> #### Input Parameters
>
> **name** `string`
>
> Workspace name.
>
> **account\_id** `string` *required*
>
> Frame.io account ID.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Delete Comment
>
> **Slug:** `FRAME_IO_V4_DELETE_COMMENT`
>
> Permanently delete a Frame.io comment by ID.
>
> #### Input Parameters
>
> **account\_id** `string` *required*
>
> Frame.io account ID that owns the comment.
>
> **comment\_id** `string` *required*
>
> Comment ID to delete.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Delete Comment Attachment
>
> **Slug:** `FRAME_IO_V4_DELETE_COMMENT_ATTACHMENT`
>
> Permanently delete one attachment from a Frame.io comment.
>
> #### Input Parameters
>
> **account\_id** `string` *required*
>
> Frame.io account ID that owns the comment.
>
> **comment\_id** `string` *required*
>
> Comment ID containing the attachment.
>
> **attachment\_id** `string` *required*
>
> Attachment ID to delete.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Delete Custom Action
>
> **Slug:** `FRAME_IO_V4_DELETE_CUSTOM_ACTION`
>
> Delete a Frame.io custom action by ID.
>
> #### Input Parameters
>
> **action\_id** `string` *required*
>
> Custom action ID.
>
> **account\_id** `string` *required*
>
> Frame.io account ID.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Delete File
>
> **Slug:** `FRAME_IO_V4_DELETE_FILE`
>
> Permanently delete a Frame.io file by ID.
>
> #### Input Parameters
>
> **file\_id** `string` *required*
>
> File ID to delete.
>
> **account\_id** `string` *required*
>
> Frame.io account ID that owns the file.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] 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
>
> **folder\_id** `string` *required*
>
> Folder ID to delete; do not pass a project root folder.
>
> **account\_id** `string` *required*
>
> Frame.io account ID that owns the folder.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Delete Metadata Field
>
> **Slug:** `FRAME_IO_V4_DELETE_METADATA_FIELD`
>
> Delete a mutable account-level Frame.io custom metadata field definition.
>
> #### Input Parameters
>
> **account\_id** `string` *required*
>
> Frame.io account ID that owns the metadata field.
>
> **field\_definition\_id** `string` *required*
>
> Custom metadata field definition ID to delete.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Delete Project
>
> **Slug:** `FRAME_IO_V4_DELETE_PROJECT`
>
> Delete a Frame.io project by ID.
>
> #### Input Parameters
>
> **account\_id** `string` *required*
>
> Frame.io account ID that owns the project.
>
> **project\_id** `string` *required*
>
> Frame.io project ID.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Delete Share
>
> **Slug:** `FRAME_IO_V4_DELETE_SHARE`
>
> Permanently delete a Frame.io review share and disable its externally visible link.
>
> #### Input Parameters
>
> **share\_id** `string` *required*
>
> Share ID to permanently delete.
>
> **account\_id** `string` *required*
>
> Frame.io account ID that owns the share.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Delete Webhook
>
> **Slug:** `FRAME_IO_V4_DELETE_WEBHOOK`
>
> Permanently delete a Frame.io webhook registration by ID.
>
> #### Input Parameters
>
> **account\_id** `string` *required*
>
> Frame.io account ID that owns the webhook.
>
> **webhook\_id** `string` *required*
>
> Webhook ID to delete.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Delete Workspace
>
> **Slug:** `FRAME_IO_V4_DELETE_WORKSPACE`
>
> Delete a Frame.io workspace from its account by ID.
>
> #### Input Parameters
>
> **account\_id** `string` *required*
>
> Frame.io account ID.
>
> **workspace\_id** `string` *required*
>
> Frame.io workspace ID.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Collection
>
> **Slug:** `FRAME_IO_V4_GET_COLLECTION`
>
> Return current details for one Frame.io collection by ID.
>
> #### Input Parameters
>
> **include** `string`
>
> Optional provider-supported collection relationship to include.
>
> **account\_id** `string` *required*
>
> Frame.io account ID.
>
> **collection\_id** `string` *required*
>
> Collection ID to retrieve.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Comment
>
> **Slug:** `FRAME_IO_V4_GET_COMMENT`
>
> Return one Frame.io comment by ID, optionally including its owner or replies.
>
> #### Input Parameters
>
> **include** `string ("owner" | "replies")`
>
> Optionally include the comment owner or replies.
>
> **account\_id** `string` *required*
>
> Frame.io account ID that owns the comment.
>
> **comment\_id** `string` *required*
>
> Comment ID to retrieve.
>
> **timestamp\_as\_timecode** `boolean`
>
> Return the timestamp as a timecode when true.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] 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
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Custom Action
>
> **Slug:** `FRAME_IO_V4_GET_CUSTOM_ACTION`
>
> Return current details for one Frame.io custom action by ID.
>
> #### Input Parameters
>
> **include** `string`
>
> Set to creator to include action creator details.
>
> **action\_id** `string` *required*
>
> Custom action ID.
>
> **account\_id** `string` *required*
>
> Frame.io account ID.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] 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
>
> **file\_id** `string` *required*
>
> 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")`
>
> Optional related data or media-link representation to include.
>
> **account\_id** `string` *required*
>
> Frame.io account ID that owns the file.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] 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
>
> **file\_id** `string` *required*
>
> File ID whose upload status to retrieve.
>
> **account\_id** `string` *required*
>
> Frame.io account ID that owns the file.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] 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
>
> **include** `string ("creator" | "project" | "metadata")`
>
> Optional related data to include in the folder response.
>
> **folder\_id** `string` *required*
>
> Folder ID to retrieve.
>
> **account\_id** `string` *required*
>
> Frame.io account ID that owns the folder.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] 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
>
> **include** `string`
>
> Set to creator to include creator details.
>
> **group\_id** `string` *required*
>
> Group ID to retrieve.
>
> **account\_id** `string` *required*
>
> Frame.io or Adobe account ID that owns the group.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Project
>
> **Slug:** `FRAME_IO_V4_GET_PROJECT`
>
> Return current details for one Frame.io project by ID.
>
> #### Input Parameters
>
> **include** `string`
>
> Set to owner to include project owner details.
>
> **account\_id** `string` *required*
>
> Frame.io account ID that owns the project.
>
> **project\_id** `string` *required*
>
> Frame.io project ID.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] 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
>
> **share\_id** `string` *required*
>
> Share ID to retrieve.
>
> **account\_id** `string` *required*
>
> Frame.io account ID that owns the share.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] 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
>
> **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")`
>
> Optional related data or media links to include.
>
> **account\_id** `string` *required*
>
> Frame.io account ID that owns the version stack.
>
> **version\_stack\_id** `string` *required*
>
> Version-stack ID to retrieve.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Workspace
>
> **Slug:** `FRAME_IO_V4_GET_WORKSPACE`
>
> Return current details for one Frame.io workspace by ID.
>
> #### Input Parameters
>
> **include** `string`
>
> Set to creator to include workspace creator details.
>
> **account\_id** `string` *required*
>
> Frame.io account ID.
>
> **workspace\_id** `string` *required*
>
> Frame.io workspace ID.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Import File
>
> **Slug:** `FRAME_IO_V4_IMPORT_FILE`
>
> Import a file from a storage location already configured on the Frame.io account.
>
> #### Input Parameters
>
> **key** `string` *required*
>
> File key or path within the configured filespace.
>
> **name** `string` *required*
>
> Imported file name.
>
> **folder\_id** `string` *required*
>
> Destination folder ID for the imported file.
>
> **account\_id** `string` *required*
>
> Frame.io account ID that owns the folder.
>
> **storage\_location** `string` *required*
>
> Configured storage location ID, optionally prefixed by an account ID.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] 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
>
> **sort** `string ("display_name_asc" | "created_at_asc" | "display_name_desc" | "created_at_desc")`
>
> Order accounts by display name or creation time.
>
> **page\_size** `integer`
>
> Maximum accounts to return in this page.
>
> **next\_cursor** `string`
>
> Opaque cursor returned by a previous call; omit for the first page.
>
> **include\_total\_count** `boolean`
>
> Whether to include the total matching account count.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] 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
>
> **sort** `string ("role_asc" | "role_desc" | "name_asc" | "name_desc" | "email_asc" | "email_desc")`
>
> Order users by role, name, or email.
>
> **page\_size** `integer`
>
> Maximum user-role records to return in this page.
>
> **account\_id** `string` *required*
>
> Frame.io account ID whose users and roles to list.
>
> **next\_cursor** `string`
>
> Opaque cursor returned by a previous call; omit for the first page.
>
> **include\_deactivated** `boolean`
>
> Whether to include deactivated users.
>
> **include\_total\_count** `boolean`
>
> Whether to include the total matching user count.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] 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
>
> **filters** `object`
>
> Optional audit filters by event type, date range, IP, project, resource, user, or workspace. Dates use YYYY-MM-DD.
>
> **page\_size** `integer`
>
> Maximum audit events to return in this page.
>
> **account\_id** `string` *required*
>
> Frame.io account ID whose audit events to list.
>
> **next\_cursor** `string`
>
> 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`
>
> Whether to include acting-user details for each audit event.
>
> **include\_total\_count** `boolean`
>
> Whether to include the total matching audit event count.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] 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
>
> **include** `string`
>
> Optional provider-supported collection relationship to include.
>
> **page\_size** `integer`
>
> Maximum collections to return in this page.
>
> **account\_id** `string` *required*
>
> Frame.io account ID that owns the project.
>
> **project\_id** `string` *required*
>
> Project ID whose collections to list.
>
> **next\_cursor** `string`
>
> 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`
>
> Whether to include the total matching collection count.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] 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
>
> **sort** `string ("owner_asc" | "owner_desc" | "completed_at_asc" | "completed_at_desc" | "created_at_asc" | "created_at_desc")`
>
> Optional comment ordering. Owner sorting requires include=owner.
>
> **file\_id** `string` *required*
>
> File ID whose comments to list.
>
> **include** `string ("owner" | "replies")`
>
> Optionally include comment owners or replies.
>
> **page\_size** `integer`
>
> Maximum comments to return in this page.
>
> **account\_id** `string` *required*
>
> Frame.io account ID that owns the file.
>
> **next\_cursor** `string`
>
> Opaque cursor returned by a previous call.
>
> **include\_total\_count** `boolean`
>
> Whether to include the total matching comment count.
>
> **timestamp\_as\_timecode** `boolean`
>
> Return timestamps as timecodes when true.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] 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
>
> **include** `string`
>
> Set to creator to include action creator details.
>
> **page\_size** `integer`
>
> Maximum custom actions to return in this page.
>
> **account\_id** `string` *required*
>
> Frame.io account ID.
>
> **next\_cursor** `string`
>
> Opaque cursor returned by a previous call; omit for the first page.
>
> **workspace\_id** `string` *required*
>
> Workspace whose custom actions to list.
>
> **include\_total\_count** `boolean`
>
> Whether to include the total matching action count.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] 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
>
> **sort** `string ("name_asc" | "created_at_asc" | "updated_at_asc" | "file_size_asc" | "name_desc" | "created_at_desc" | "updated_at_desc" | "file_size_desc")`
>
> Optional file ordering.
>
> **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")`
>
> Optional related data or media-link representation to include.
>
> **folder\_id** `string` *required*
>
> Folder ID whose files to list.
>
> **page\_size** `integer`
>
> Maximum files to return in this page.
>
> **account\_id** `string` *required*
>
> Frame.io account ID that owns the folder.
>
> **next\_cursor** `string`
>
> Opaque cursor returned by a previous call.
>
> **include\_total\_count** `boolean`
>
> Whether to include the total matching file count.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] 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
>
> **sort** `string ("name_asc" | "created_at_asc" | "updated_at_asc" | "name_desc" | "created_at_desc" | "updated_at_desc")`
>
> Order children by name, creation time, or update time.
>
> **type** `string`
>
> 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")`
>
> Optional related data or media-link representation to include.
>
> **folder\_id** `string` *required*
>
> Folder ID to traverse; use a project's root\_folder\_id to start at the project root.
>
> **page\_size** `integer`
>
> Maximum child assets to return in this page.
>
> **account\_id** `string` *required*
>
> Frame.io account ID that owns the folder.
>
> **next\_cursor** `string`
>
> 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`
>
> Whether to include the total matching child count.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] 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
>
> **sort** `string ("name_asc" | "created_at_asc" | "updated_at_asc" | "name_desc" | "created_at_desc" | "updated_at_desc")`
>
> Optional folder sort order.
>
> **include** `string ("creator" | "project" | "metadata")`
>
> Optional related data to include.
>
> **folder\_id** `string` *required*
>
> Parent folder ID whose direct subfolders to list.
>
> **page\_size** `integer`
>
> Maximum folders to return in this page.
>
> **account\_id** `string` *required*
>
> Frame.io account ID that owns the parent folder.
>
> **next\_cursor** `string`
>
> Opaque cursor from a previous call; omit for the first page.
>
> **include\_total\_count** `boolean`
>
> Whether to include the total matching folder count.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] 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
>
> **folder\_id** `string` *required*
>
> Folder ID whose direct user roles to list.
>
> **page\_size** `integer`
>
> Page size.
>
> **account\_id** `string` *required*
>
> Frame.io account ID that owns the folder.
>
> **next\_cursor** `string`
>
> Opaque cursor from a previous page.
>
> **include\_deactivated** `boolean`
>
> Whether to include deactivated users.
>
> **include\_total\_count** `boolean`
>
> Whether to include the total matching role count.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] 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
>
> **sort** `string ("creator_asc" | "creator_desc" | "name_asc" | "name_desc" | "created_at_asc" | "created_at_desc")`
>
> Optional group ordering.
>
> **include** `string`
>
> Set to creator to include creator details.
>
> **page\_size** `integer`
>
> Page size.
>
> **account\_id** `string` *required*
>
> Frame.io or Adobe account ID whose groups to list.
>
> **next\_cursor** `string`
>
> Opaque cursor from a previous page.
>
> **include\_total\_count** `boolean`
>
> Whether to include the total group count.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] 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
>
> **sort** `string ("name_asc" | "created_at_asc" | "name_desc" | "created_at_desc")`
>
> Optional project sort order.
>
> **include** `string`
>
> Set to owner to include project owner details.
>
> **page\_size** `integer`
>
> Maximum projects to return in this page.
>
> **account\_id** `string` *required*
>
> Frame.io account ID.
>
> **next\_cursor** `string`
>
> Opaque cursor returned by a previous call; omit for the first page.
>
> **include\_total\_count** `boolean`
>
> Whether to include the total matching project count.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] 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
>
> **sort** `string ("name_asc" | "created_at_asc" | "name_desc" | "created_at_desc")`
>
> Order field definitions by name or creation time.
>
> **filters** `object`
>
> Optional filters for excluding read-only or inactive field definitions.
>
> **page\_size** `integer`
>
> Maximum field definitions to return in this page.
>
> **account\_id** `string` *required*
>
> Frame.io account ID whose metadata schema to inspect.
>
> **next\_cursor** `string`
>
> 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`
>
> Whether to include creator details for each field definition.
>
> **include\_total\_count** `boolean`
>
> Whether to include the total matching definition count.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] 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
>
> **sort** `string ("name_asc" | "created_at_asc" | "name_desc" | "created_at_desc")`
>
> Order projects by name or creation time.
>
> **page\_size** `integer`
>
> Maximum projects to return in this page.
>
> **account\_id** `string` *required*
>
> Frame.io account ID from List Accounts; Adobe-backed IDs must retain the adobe: prefix.
>
> **next\_cursor** `string`
>
> Opaque cursor returned by a previous call. Repeat the same account and options when continuing; omit for the first page.
>
> **include\_owner** `boolean`
>
> Whether to include owner details for each project.
>
> **include\_total\_count** `boolean`
>
> Whether to include the total matching project count.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] 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
>
> **sort** `string ("role_asc" | "role_desc" | "name_asc" | "name_desc" | "email_asc" | "email_desc")`
>
> Optional user-role ordering.
>
> **page\_size** `integer`
>
> Page size.
>
> **account\_id** `string` *required*
>
> Frame.io or Adobe account ID.
>
> **project\_id** `string` *required*
>
> Frame.io or Adobe project ID whose roles to list.
>
> **next\_cursor** `string`
>
> Opaque cursor from a previous page.
>
> **include\_deactivated** `boolean`
>
> Whether to include deactivated users.
>
> **include\_total\_count** `boolean`
>
> Whether to include the total role count.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] 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
>
> **sort** `string ("deleted_at_asc" | "deleted_at_desc" | "name_asc" | "name_desc")`
>
> Optional deleted-asset sort order.
>
> **page\_size** `integer`
>
> Maximum deleted assets to return in this page.
>
> **account\_id** `string` *required*
>
> Frame.io account ID.
>
> **project\_id** `string` *required*
>
> Project whose deleted assets to list.
>
> **next\_cursor** `string`
>
> Opaque cursor returned by a previous call; omit for the first page.
>
> **include\_total\_count** `boolean`
>
> Whether to request a total matching asset count.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] 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
>
> **include** `string`
>
> Include full user details.
>
> **share\_id** `string` *required*
>
> Share ID whose activity to list.
>
> **page\_size** `integer`
>
> Maximum activity records to return in this page.
>
> **account\_id** `string` *required*
>
> Frame.io account ID that owns the share.
>
> **next\_cursor** `string`
>
> Opaque cursor from a previous response; omit for the first page.
>
> **include\_total\_count** `boolean`
>
> Whether to request the total activity count.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] 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
>
> **sort** `string ("name_asc" | "created_at_asc" | "updated_at_asc" | "name_desc" | "created_at_desc" | "updated_at_desc")`
>
> 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")`
>
> Optional related data or media-link representation to include.
>
> **share\_id** `string` *required*
>
> Share ID whose recursively expanded assets to list.
>
> **page\_size** `integer`
>
> Maximum assets to return in this page.
>
> **account\_id** `string` *required*
>
> Frame.io account ID that owns the share.
>
> **next\_cursor** `string`
>
> Opaque cursor from a previous response; omit for the first page.
>
> **include\_total\_count** `boolean`
>
> Whether to include the total matching asset count.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] 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
>
> **sort** `string ("name_asc" | "active" | "name_desc" | "inactive")`
>
> Optional reviewer sort order.
>
> **share\_id** `string` *required*
>
> Share ID whose reviewers to list.
>
> **page\_size** `integer`
>
> Maximum reviewers to return in this page.
>
> **account\_id** `string` *required*
>
> Frame.io account ID that owns the share.
>
> **next\_cursor** `string`
>
> Opaque cursor from a previous response; omit for the first page.
>
> **include\_total\_count** `boolean`
>
> Whether to include the total reviewer count.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List Shares
>
> **Slug:** `FRAME_IO_V4_LIST_SHARES`
>
> List review shares for a project without creating or changing externally visible review links.
>
> #### Input Parameters
>
> **sort** `string ("name_asc" | "created_at_asc" | "name_desc" | "created_at_desc")`
>
> Order shares by name or creation time.
>
> **page\_size** `integer`
>
> Maximum shares to return in this page.
>
> **account\_id** `string` *required*
>
> Frame.io account ID that owns the project.
>
> **project\_id** `string` *required*
>
> Project ID whose shares to list.
>
> **next\_cursor** `string`
>
> Opaque cursor returned by a previous call. Repeat the same project and options when continuing; omit for the first page.
>
> **include\_total\_count** `boolean`
>
> Whether to include the total matching share count.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] 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
>
> **sort** `string ("name_asc" | "created_at_asc" | "updated_at_asc" | "file_size_asc" | "name_desc" | "created_at_desc" | "updated_at_desc" | "file_size_desc")`
>
> Optional child-file sort order.
>
> **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")`
>
> Optional related data or media-link representation to include.
>
> **page\_size** `integer`
>
> Maximum child files to return in this page.
>
> **account\_id** `string` *required*
>
> Frame.io account ID that owns the version stack.
>
> **next\_cursor** `string`
>
> Opaque cursor from a previous response; omit for the first page.
>
> **version\_stack\_id** `string` *required*
>
> Version-stack ID whose files to list.
>
> **include\_total\_count** `boolean`
>
> Whether to include the total child-file count.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] 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
>
> **sort** `string ("name_asc" | "created_at_asc" | "updated_at_asc" | "name_desc" | "created_at_desc" | "updated_at_desc")`
>
> 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")`
>
> Optional related data or media-link representation to include.
>
> **folder\_id** `string` *required*
>
> Folder ID whose version stacks to list.
>
> **page\_size** `integer`
>
> Maximum version stacks to return in this page.
>
> **account\_id** `string` *required*
>
> Frame.io account ID that owns the folder.
>
> **next\_cursor** `string`
>
> Opaque cursor from a previous response; omit for the first page.
>
> **include\_total\_count** `boolean`
>
> Whether to include the total version-stack count.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List Webhooks
>
> **Slug:** `FRAME_IO_V4_LIST_WEBHOOKS`
>
> List webhook registrations in a workspace without creating callbacks or requiring external delivery infrastructure.
>
> #### Input Parameters
>
> **sort** `string ("name_asc" | "created_at_asc" | "name_desc" | "created_at_desc")`
>
> Order webhooks by name or creation time.
>
> **page\_size** `integer`
>
> Maximum webhooks to return in this page.
>
> **account\_id** `string` *required*
>
> Frame.io account ID that owns the workspace.
>
> **next\_cursor** `string`
>
> Opaque cursor returned by a previous call; omit for the first page.
>
> **workspace\_id** `string` *required*
>
> Workspace ID whose webhook registrations to list.
>
> **include\_creator** `boolean`
>
> Whether to include creator details for each webhook.
>
> **include\_total\_count** `boolean`
>
> Whether to include the total matching webhook count.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] 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
>
> **sort** `string ("name_asc" | "created_at_asc" | "name_desc" | "created_at_desc")`
>
> Optional project sort order.
>
> **include** `string`
>
> Set to owner to include project owner details.
>
> **page\_size** `integer`
>
> Maximum projects to return in this page.
>
> **account\_id** `string` *required*
>
> Frame.io account ID.
>
> **next\_cursor** `string`
>
> Opaque cursor returned by a previous call; omit for the first page.
>
> **workspace\_id** `string` *required*
>
> Workspace whose projects to list.
>
> **include\_total\_count** `boolean`
>
> Whether to include the total matching project count.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] 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
>
> **sort** `string ("name_asc" | "created_at_asc" | "name_desc" | "created_at_desc")`
>
> Order workspaces by name or creation time.
>
> **page\_size** `integer`
>
> Maximum workspaces to return in this page.
>
> **account\_id** `string` *required*
>
> Frame.io account ID from List Accounts; Adobe-backed IDs must retain the adobe: prefix.
>
> **next\_cursor** `string`
>
> Opaque cursor returned by a previous call; omit for the first page.
>
> **include\_creator** `boolean`
>
> Whether to include creator details for each workspace.
>
> **include\_total\_count** `boolean`
>
> Whether to include the total matching workspace count.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] 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
>
> **sort** `string ("role_asc" | "role_desc" | "name_asc" | "name_desc" | "email_asc" | "email_desc")`
>
> Optional user-role ordering.
>
> **page\_size** `integer`
>
> Page size.
>
> **account\_id** `string` *required*
>
> Frame.io or Adobe account ID.
>
> **next\_cursor** `string`
>
> Opaque cursor from a previous page.
>
> **workspace\_id** `string` *required*
>
> Workspace ID whose roles to list.
>
> **include\_deactivated** `boolean`
>
> Whether to include deactivated users.
>
> **include\_total\_count** `boolean`
>
> Whether to include the total role count.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Move File
>
> **Slug:** `FRAME_IO_V4_MOVE_FILE`
>
> Move one Frame.io file to a folder or version stack.
>
> #### Input Parameters
>
> **file\_id** `string` *required*
>
> File ID to move.
>
> **parent\_id** `string`
>
> Optional destination folder or version stack ID.
>
> **account\_id** `string` *required*
>
> Frame.io account ID that owns the file.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Move Files
>
> **Slug:** `FRAME_IO_V4_MOVE_FILES`
>
> Move between one and 100 Frame.io files into one destination folder.
>
> #### Input Parameters
>
> **file\_ids** `array` *required*
>
> One to 100 unique file IDs to move.
>
> **parent\_id** `string` *required*
>
> Destination folder ID for all files.
>
> **account\_id** `string` *required*
>
> Frame.io account ID that owns the files.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Move Folder
>
> **Slug:** `FRAME_IO_V4_MOVE_FOLDER`
>
> Move one Frame.io folder to a destination folder and return its updated details.
>
> #### Input Parameters
>
> **folder\_id** `string` *required*
>
> ID of the folder to move.
>
> **parent\_id** `string`
>
> Destination folder ID.
>
> **account\_id** `string` *required*
>
> Frame.io account ID that owns the folder.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] 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
>
> **parent\_id** `string` *required*
>
> Destination folder ID for every moved folder.
>
> **account\_id** `string` *required*
>
> Frame.io account ID that owns the folders.
>
> **folder\_ids** `array` *required*
>
> One to 100 unique folder IDs to move.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] 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
>
> **parent\_id** `string`
>
> Destination folder ID.
>
> **account\_id** `string` *required*
>
> Frame.io account ID that owns the version stack.
>
> **version\_stack\_id** `string` *required*
>
> Version-stack ID to move.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] 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
>
> **asset\_id** `string` *required*
>
> Asset ID to remove from the share.
>
> **share\_id** `string` *required*
>
> Share ID to remove the asset from.
>
> **account\_id** `string` *required*
>
> Frame.io account ID that owns the share.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] 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
>
> **user\_id** `string` *required*
>
> User whose folder access will be removed.
>
> **folder\_id** `string` *required*
>
> Folder from which access will be removed.
>
> **account\_id** `string` *required*
>
> Frame.io account ID that owns the folder.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] 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
>
> **user\_id** `string` *required*
>
> User whose project access will be removed.
>
> **account\_id** `string` *required*
>
> Frame.io or Adobe account ID.
>
> **project\_id** `string` *required*
>
> Project from which access will be removed.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Remove Share Reviewers
>
> **Slug:** `FRAME_IO_V4_REMOVE_SHARE_REVIEWERS`
>
> Revoke selected reviewers' access to a secure Frame.io share.
>
> #### Input Parameters
>
> **emails** `array`
>
> Reviewer email addresses to remove.
>
> **share\_id** `string` *required*
>
> Secure share ID to revoke reviewer access from.
>
> **user\_ids** `array`
>
> Frame.io user IDs to remove.
>
> **account\_id** `string` *required*
>
> Frame.io account ID that owns the share.
>
> **adobe\_user\_ids** `array`
>
> Adobe user IDs to remove.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Remove Workspace User
>
> **Slug:** `FRAME_IO_V4_REMOVE_WORKSPACE_USER`
>
> Remove a user's role from a workspace, revoking that workspace access.
>
> #### Input Parameters
>
> **user\_id** `string` *required*
>
> User whose workspace access will be removed.
>
> **account\_id** `string` *required*
>
> Frame.io or Adobe account ID.
>
> **workspace\_id** `string` *required*
>
> Workspace from which access will be removed.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] 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
>
> **query** `string` *required*
>
> Text to search for in visible Frame.io resources.
>
> **engine** `string ("lexical" | "nlp")`
>
> Use lexical for exact term matching or nlp for natural-language search.
>
> **page\_size** `integer`
>
> Maximum search results to return in this page.
>
> **account\_id** `string` *required*
>
> Frame.io account ID to search.
>
> **next\_cursor** `string`
>
> Opaque cursor returned by a previous search call; omit for the first page.
>
> **include\_folders** `boolean`
>
> Whether folder results may be returned.
>
> **include\_projects** `boolean`
>
> Whether project results may be returned.
>
> **include\_total\_count** `boolean`
>
> Whether to include the total matching result count.
>
> **include\_files\_and\_version\_stacks** `boolean`
>
> Whether file and version-stack results may be returned.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] 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
>
> **file\_id** `string` *required*
>
> File ID whose metadata values to retrieve.
>
> **show\_null** `boolean`
>
> Whether to include metadata fields whose current value is null.
>
> **account\_id** `string` *required*
>
> Frame.io account ID that owns the file.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Show Webhook
>
> **Slug:** `FRAME_IO_V4_SHOW_WEBHOOK`
>
> Return one Frame.io webhook's current callback, event, status, and optional creator details.
>
> #### Input Parameters
>
> **include** `string`
>
> Pass creator to include webhook creator details.
>
> **account\_id** `string` *required*
>
> Frame.io account ID that owns the webhook.
>
> **webhook\_id** `string` *required*
>
> Webhook ID to retrieve.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] 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
>
> **role** `string ("member" | "admin")` *required*
>
> New account role: member or admin.
>
> **user\_id** `string` *required*
>
> Frame.io user ID whose role will change.
>
> **account\_id** `string` *required*
>
> Frame.io or Adobe account ID whose account-level access will change.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Update Comment
>
> **Slug:** `FRAME_IO_V4_UPDATE_COMMENT`
>
> Update the text, location, annotation, timing, or completion state of a Frame.io comment.
>
> #### Input Parameters
>
> **page** `integer`
>
> Optional PDF document page.
>
> **text** `string`
>
> Optional new comment text.
>
> **links** `array`
>
> Optional comment text links.
>
> **anchor** `object`
>
> Optional normalized on-screen anchor.
>
> **duration** `integer`
>
> Optional duration in frames.
>
> **completed** `boolean`
>
> Optional completion status.
>
> **timestamp** `string`
>
> Optional frame number or timecode.
>
> **account\_id** `string` *required*
>
> Frame.io account ID that owns the comment.
>
> **annotation** `string`
>
> Optional stringified drawing geometry.
>
> **comment\_id** `string` *required*
>
> Comment ID to update.
>
> **timestamp\_as\_timecode** `boolean`
>
> Interpret a string timestamp as a timecode when true.
>
> **text\_review\_annotation** `object`
>
> Optional text review annotation changes.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Update Custom Action
>
> **Slug:** `FRAME_IO_V4_UPDATE_CUSTOM_ACTION`
>
> Update the configuration or active state of a Frame.io custom action.
>
> #### Input Parameters
>
> **url** `string`
>
> New action URL.
>
> **name** `string`
>
> New action name.
>
> **event** `string`
>
> New event name.
>
> **active** `boolean`
>
> Whether the custom action is active.
>
> **timeout** `integer`
>
> New request timeout in seconds.
>
> **action\_id** `string` *required*
>
> Custom action ID.
>
> **account\_id** `string` *required*
>
> Frame.io account ID.
>
> **description** `string`
>
> New action description.
>
> **multi\_asset** `boolean`
>
> Whether the action can trigger on multiple assets.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Update File
>
> **Slug:** `FRAME_IO_V4_UPDATE_FILE`
>
> Update a Frame.io file's name and return its current details.
>
> #### Input Parameters
>
> **name** `string`
>
> Optional new file name.
>
> **file\_id** `string` *required*
>
> File ID to update.
>
> **account\_id** `string` *required*
>
> Frame.io account ID that owns the file.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Update Folder
>
> **Slug:** `FRAME_IO_V4_UPDATE_FOLDER`
>
> Rename an existing Frame.io folder and return its updated details.
>
> #### Input Parameters
>
> **name** `string` *required*
>
> New name for the folder.
>
> **folder\_id** `string` *required*
>
> Folder ID to rename.
>
> **account\_id** `string` *required*
>
> Frame.io account ID that owns the folder.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] 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
>
> **role** `string ("full_access" | "editor" | "edit_only" | "commenter" | "viewer")` *required*
>
> New folder role for the user.
>
> **user\_id** `string` *required*
>
> User to add or whose role to replace.
>
> **folder\_id** `string` *required*
>
> Folder whose access will change.
>
> **account\_id** `string` *required*
>
> Frame.io account ID that owns the folder.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] 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
>
> **name** `string`
>
> New group name; omit to leave unchanged.
>
> **emoji** `string`
>
> New group emoji; omit to leave unchanged.
>
> **group\_id** `string` *required*
>
> Group ID to update.
>
> **account\_id** `string` *required*
>
> Frame.io or Adobe account ID that owns the group.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] 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
>
> **name** `string`
>
> Optional replacement field name.
>
> **account\_id** `string` *required*
>
> 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")` *required*
>
> Current type of the field definition being updated.
>
> **field\_configuration** `object`
>
> Optional replacement type-specific configuration.
>
> **field\_definition\_id** `string` *required*
>
> Metadata field definition ID to update.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Update Project
>
> **Slug:** `FRAME_IO_V4_UPDATE_PROJECT`
>
> Update a Frame.io project's name, restricted state, or status.
>
> #### Input Parameters
>
> **name** `string`
>
> New project name.
>
> **status** `string ("active" | "inactive")`
>
> New project status.
>
> **account\_id** `string` *required*
>
> Frame.io account ID that owns the project.
>
> **project\_id** `string` *required*
>
> Frame.io project ID.
>
> **restricted** `boolean`
>
> Whether the project is restricted.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] 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
>
> **role** `string ("full_access" | "editor" | "edit_only" | "commenter" | "viewer")` *required*
>
> New project role for the user.
>
> **user\_id** `string` *required*
>
> User to add or whose role to replace.
>
> **account\_id** `string` *required*
>
> Frame.io or Adobe account ID.
>
> **project\_id** `string` *required*
>
> Project whose access will change.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Update Share
>
> **Slug:** `FRAME_IO_V4_UPDATE_SHARE`
>
> Change a Frame.io share's access, review, appearance, or expiration settings.
>
> #### Input Parameters
>
> **name** `string`
>
> New share name, or null when supported by Frame.io.
>
> **theme** `string ("dark" | "light" | "neutral")`
>
> Share color theme.
>
> **access** `string ("public" | "secure")`
>
> Share access mode.
>
> **layout** `string ("grid" | "list" | "reel")`
>
> Share layout.
>
> **enabled** `boolean`
>
> Whether the share link is active.
>
> **sort\_by** `object`
>
> Metadata field and direction used to sort shared assets.
>
> **share\_id** `string` *required*
>
> Share ID to update.
>
> **card\_size** `string ("small" | "medium" | "large")`
>
> Card size for grid layout.
>
> **account\_id** `string` *required*
>
> Frame.io account ID that owns the share.
>
> **expiration** `string`
>
> ISO 8601 expiration timestamp, or null for no expiration.
>
> **description** `string`
>
> Share description, or null to clear it.
>
> **drm\_enabled** `boolean`
>
> Whether digital rights management is enabled.
>
> **accent\_color** `string`
>
> Hex accent color for the share.
>
> **list\_row\_size** `string ("small" | "medium" | "large")`
>
> Row size for list layout.
>
> **thumbnail\_scale** `string ("fit" | "fill")`
>
> Whether thumbnails fit or fill their cards.
>
> **captions\_enabled** `boolean`
>
> Whether reviewers can view captions.
>
> **title\_line\_count** `integer`
>
> One or two title lines on grid cards.
>
> **card\_aspect\_ratio** `string ("horizontal" | "square" | "vertical")`
>
> Card aspect ratio for grid or reel layouts.
>
> **card\_info\_enabled** `boolean`
>
> Whether grid cards show metadata.
>
> **name\_column\_width** `integer`
>
> Name-column width in pixels for list layout.
>
> **watermark\_enabled** `boolean`
>
> Whether watermarking is enabled.
>
> **commenting\_enabled** `boolean`
>
> Whether reviewers can comment.
>
> **downloading\_enabled** `boolean`
>
> Whether reviewers can download assets.
>
> **reel\_card\_fit\_image** `boolean`
>
> Whether reel thumbnails fill rather than fit their cards.
>
> **transcripts\_enabled** `boolean`
>
> Whether reviewers can view transcripts.
>
> **icons\_visible\_on\_list** `boolean`
>
> Whether list rows show visible-field icons.
>
> **open\_in\_viewer\_enabled** `boolean`
>
> Whether a single asset opens in the larger viewer.
>
> **reel\_card\_aspect\_ratio** `string ("horizontal" | "square" | "vertical")`
>
> Card aspect ratio for reel layout.
>
> **editable\_fields\_enabled** `boolean`
>
> Whether recipients can edit all visible non-system fields.
>
> **show\_all\_asset\_versions** `boolean`
>
> Whether reviewers can see every version in a shared stack.
>
> **forensic\_watermark\_enabled** `boolean`
>
> Whether forensic watermarking is enabled.
>
> **featured\_field\_definition\_id** `string`
>
> Metadata field definition featured for recipients.
>
> **visible\_field\_definition\_ids** `array`
>
> Metadata field definition IDs visible in the active layout.
>
> **show\_asset\_name\_in\_reel\_layout** `boolean`
>
> Whether reel cards display asset names.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Update Webhook
>
> **Slug:** `FRAME_IO_V4_UPDATE_WEBHOOK`
>
> Update a Frame.io webhook's active state, subscribed events, name, or callback URL.
>
> #### Input Parameters
>
> **url** `string`
>
> Replacement callback URL.
>
> **name** `string`
>
> Replacement webhook name.
>
> **active** `boolean`
>
> Whether the webhook should be active.
>
> **events** `array`
>
> Replacement Frame.io event types.
>
> **account\_id** `string` *required*
>
> Frame.io account ID that owns the webhook.
>
> **webhook\_id** `string` *required*
>
> Webhook ID to update.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Update Workspace
>
> **Slug:** `FRAME_IO_V4_UPDATE_WORKSPACE`
>
> Update the name of an existing Frame.io workspace.
>
> #### Input Parameters
>
> **name** `string`
>
> New workspace name.
>
> **account\_id** `string` *required*
>
> Frame.io account ID.
>
> **workspace\_id** `string` *required*
>
> Frame.io workspace ID.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] 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
>
> **role** `string ("workspace_admin" | "full_access" | "editor" | "edit_only" | "commenter" | "viewer")` *required*
>
> New workspace role for the user.
>
> **user\_id** `string` *required*
>
> User to add or whose role to replace.
>
> **account\_id** `string` *required*
>
> Frame.io or Adobe account ID.
>
> **workspace\_id** `string` *required*
>
> Workspace whose access will change.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not
