Frame.io

App · 25 actions

Manage Frame.io V4 workspaces, projects, folders, files, comments, and webhooks.

Actions

ActionWhat it does
Create commentCreate comment
Create folderCreate folder
Create projectCreate project
Create webhookCreate webhook
Delete commentDelete comment
Delete fileDelete file
Delete folderDelete folder
Delete projectDelete project
Get commentShow comment
Get fileShow file
Get folderShow folder
Get my profileShow user
Get projectShow project
List accountsList accounts
List commentsList comments
List filesList files
List folder childrenList folder children
List foldersList folders
List projectsList projects
List webhooksList webhooks
List workspacesList workspaces
Update commentUpdate comment
Update fileUpdate file
Update folderUpdate folder
Update projectUpdate project

Create comment

Create comment

Inputs

Accountaccount_idtextRequired
A Frame.io or Adobe entity identifier. Typically a Frame.io UUID. But for accounts, projects, folders, files, and version stacks that reside in Adobe cloud storage, which is the case for Workfront-connected accounts and projects, an Adobe-assigned id may also be used interchangeably. These ids must be.
File idfile_idtextRequired
A Frame.io or Adobe entity identifier. Typically a Frame.io UUID. But for accounts, projects, folders, files, and version stacks that reside in Adobe cloud storage, which is the case for Workfront-connected accounts and projects, an Adobe-assigned id may also be used interchangeably. These ids must be.
Timestamp as timecodetimestamp_as_timecodetrue/false
Timestamp as timecode.
Anchoranchorobject
Comment anchor location. {(x, y) | 0 <= x <= 1, 0 <= y <= 1}.
Annotationannotationtext
JSON geometry for on-screen drawings. Allowed for document, image, video, or stream file types. JSON must be stringified
Attachmentsattachmentslist
Optional attachments to create with the comment (max 6 attachments)
Completedcompletedtrue/false
Comment completion status
Durationdurationnumber
Duration of comment in frames. Requires presence of timestamp parameterAt least 1.
Linkslinkslist
Comment text links.
Pagepagenumber
Document page. Only allowed when file type is a pdf documentAt least 1.
TexttexttextRequired
Comment text (required)
Text review annotationtext_review_annotationobject
Text review annotation details for comments left on text documents.
Timestamptimestampobject
Timestamp.

Outputs

dataobject
Frame.io response data.
Example output
{
  "data": {
    "data": {
      "anchor": {},
      "annotation": "example",
      "attachments": [],
      "completed_at": "example",
      "completer_id": "example",
      "created_at": "example",
      "duration": 1,
      "file_id": "example",
      "id": "example",
      "links": [],
      "mentions": [],
      "page": 1,
      "text": "example",
      "text_edited_at": "example",
      "text_review_annotation": {},
      "timestamp": {},
      "updated_at": "example"
    }
  }
}

Create folder

Create folder

Inputs

Accountaccount_idtextRequired
A Frame.io or Adobe entity identifier. Typically a Frame.io UUID. But for accounts, projects, folders, files, and version stacks that reside in Adobe cloud storage, which is the case for Workfront-connected accounts and projects, an Adobe-assigned id may also be used interchangeably. These ids must be.
Folder idfolder_idtextRequired
A Frame.io or Adobe entity identifier. Typically a Frame.io UUID. But for accounts, projects, folders, files, and version stacks that reside in Adobe cloud storage, which is the case for Workfront-connected accounts and projects, an Adobe-assigned id may also be used interchangeably. These ids must be.
Namenametext
Folder name

Outputs

dataobject
Frame.io response data.
Example output
{
  "data": {
    "data": {
      "adobe_id": "example",
      "cover_file_id": "example",
      "created_at": "example",
      "id": "example",
      "name": "example",
      "parent_id": "example",
      "project_id": "example",
      "restricted": false,
      "type": "file",
      "updated_at": "example",
      "view_url": "example"
    }
  }
}

Create project

Create project

Inputs

Accountaccount_idtextRequired
A Frame.io or Adobe entity identifier. Typically a Frame.io UUID. But for accounts, projects, folders, files, and version stacks that reside in Adobe cloud storage, which is the case for Workfront-connected accounts and projects, an Adobe-assigned id may also be used interchangeably. These ids must be.
Workspaceworkspace_idtextRequired
A UUID string that uniquely identifies a Frame.io entity.
NamenametextRequired
Project Name
Restrictedrestrictedtrue/false
Whether the project is restricted or not

Outputs

dataobject
Frame.io project details
Example output
{
  "data": {
    "data": {
      "adobe_id": "example",
      "created_at": "example",
      "id": "example",
      "image": "example",
      "name": "example",
      "restricted": false,
      "root_folder_id": "example",
      "status": "active",
      "storage": 1,
      "updated_at": "example",
      "view_url": "example",
      "workspace_id": "example"
    }
  }
}

Create webhook

Create webhook

Inputs

Accountaccount_idtextRequired
A Frame.io or Adobe entity identifier. Typically a Frame.io UUID. But for accounts, projects, folders, files, and version stacks that reside in Adobe cloud storage, which is the case for Workfront-connected accounts and projects, an Adobe-assigned id may also be used interchangeably. These ids must be.
Workspaceworkspace_idtextRequired
A UUID string that uniquely identifies a Frame.io entity.
EventseventslistRequired
Events.
NamenametextRequired
Name.
UrlurltextRequired
URL where `event` is sent

Outputs

dataobject
Returns a single webhook with secret.
Example output
{
  "data": {
    "data": {
      "active": false,
      "created_at": "example",
      "events": [],
      "id": "example",
      "name": "example",
      "secret": "example",
      "updated_at": "example",
      "url": "example",
      "workspace_id": "example"
    }
  }
}

Delete comment

Delete comment

Inputs

Accountaccount_idtextRequired
A Frame.io or Adobe entity identifier. Typically a Frame.io UUID. But for accounts, projects, folders, files, and version stacks that reside in Adobe cloud storage, which is the case for Workfront-connected accounts and projects, an Adobe-assigned id may also be used interchangeably. These ids must be.
Comment idcomment_idtextRequired
A UUID string that uniquely identifies a Frame.io entity.

Outputs

dataobject
Frame.io response data.
Example output
{
  "data": {}
}

Delete file

Delete file

Inputs

Accountaccount_idtextRequired
A Frame.io or Adobe entity identifier. Typically a Frame.io UUID. But for accounts, projects, folders, files, and version stacks that reside in Adobe cloud storage, which is the case for Workfront-connected accounts and projects, an Adobe-assigned id may also be used interchangeably. These ids must be.
File idfile_idtextRequired
A Frame.io or Adobe entity identifier. Typically a Frame.io UUID. But for accounts, projects, folders, files, and version stacks that reside in Adobe cloud storage, which is the case for Workfront-connected accounts and projects, an Adobe-assigned id may also be used interchangeably. These ids must be.

Outputs

dataobject
Frame.io response data.
Example output
{
  "data": {}
}

Delete folder

Delete folder

Inputs

Accountaccount_idtextRequired
A Frame.io or Adobe entity identifier. Typically a Frame.io UUID. But for accounts, projects, folders, files, and version stacks that reside in Adobe cloud storage, which is the case for Workfront-connected accounts and projects, an Adobe-assigned id may also be used interchangeably. These ids must be.
Folder idfolder_idtextRequired
A Frame.io or Adobe entity identifier. Typically a Frame.io UUID. But for accounts, projects, folders, files, and version stacks that reside in Adobe cloud storage, which is the case for Workfront-connected accounts and projects, an Adobe-assigned id may also be used interchangeably. These ids must be.

Outputs

dataobject
Frame.io response data.
Example output
{
  "data": {}
}

Delete project

Delete project

Inputs

Accountaccount_idtextRequired
A Frame.io or Adobe entity identifier. Typically a Frame.io UUID. But for accounts, projects, folders, files, and version stacks that reside in Adobe cloud storage, which is the case for Workfront-connected accounts and projects, an Adobe-assigned id may also be used interchangeably. These ids must be.
Project idproject_idtextRequired
A Frame.io or Adobe entity identifier. Typically a Frame.io UUID. But for accounts, projects, folders, files, and version stacks that reside in Adobe cloud storage, which is the case for Workfront-connected accounts and projects, an Adobe-assigned id may also be used interchangeably. These ids must be.

Outputs

dataobject
Frame.io response data.
Example output
{
  "data": {}
}

Get comment

Show comment

Inputs

Accountaccount_idtextRequired
A Frame.io or Adobe entity identifier. Typically a Frame.io UUID. But for accounts, projects, folders, files, and version stacks that reside in Adobe cloud storage, which is the case for Workfront-connected accounts and projects, an Adobe-assigned id may also be used interchangeably. These ids must be.
Comment idcomment_idtextRequired
A UUID string that uniquely identifies a Frame.io entity.
Timestamp as timecodetimestamp_as_timecodetrue/false
Timestamp as timecode.
Includeincludetext
Include query parameter for commentsOne of: owner, replies.

Outputs

dataobject
Frame.io response data.
Example output
{
  "data": {
    "data": {
      "anchor": {},
      "annotation": "example",
      "attachments": [],
      "completed_at": "example",
      "completer_id": "example",
      "created_at": "example",
      "duration": 1,
      "file_id": "example",
      "id": "example",
      "links": [],
      "mentions": [],
      "owner": {
        "active": false,
        "adobe_user_id": "example",
        "avatar_url": "example",
        "email": "example",
        "id": "example",
        "name": "example"
      },
      "page": 1,
      "replies": [],
      "text": "example",
      "text_edited_at": "example",
      "text_review_annotation": {},
      "timestamp": {},
      "updated_at": "example"
    }
  }
}

Get file

Show file

Inputs

Accountaccount_idtextRequired
A Frame.io or Adobe entity identifier. Typically a Frame.io UUID. But for accounts, projects, folders, files, and version stacks that reside in Adobe cloud storage, which is the case for Workfront-connected accounts and projects, an Adobe-assigned id may also be used interchangeably. These ids must be.
File idfile_idtextRequired
A Frame.io or Adobe entity identifier. Typically a Frame.io UUID. But for accounts, projects, folders, files, and version stacks that reside in Adobe cloud storage, which is the case for Workfront-connected accounts and projects, an Adobe-assigned id may also be used interchangeably. These ids must be.
Includeincludetext
Supported include query parameter values for endpoints that return files with media linksOne of: media_links.original (Media links.original), media_links.thumbnail (Media links.thumbnail), media_links.thumbnail_high_quality (Media links.thumbnail high quality), media_links.video_h264_180 (Media links.video h264 180), media_links.high_quality (Media links.high quality), media_links.efficient (Media links.efficient), media_links.scrub_sheet (Media links.scrub sheet), creator, project, metadata.

Outputs

dataobject
Frame.io response data.
Example output
{
  "data": {
    "data": {
      "adobe_id": "example",
      "adobe_version_id": "example",
      "created_at": "example",
      "creator": {
        "active": false,
        "adobe_user_id": "example",
        "avatar_url": "example",
        "email": "example",
        "id": "example",
        "name": "example"
      },
      "file_size": 1,
      "id": "example",
      "media_links": {
        "efficient": {
          "download_url": "example",
          "url": "example"
        },
        "high_quality": {
          "download_url": "example",
          "url": "example"
        },
        "original": {
          "download_url": "example",
          "inline_url": "example"
        },
        "scrub_sheet": {
          "download_url": "example",
          "url": "example"
        },
        "thumbnail": {
          "download_url": "example",
          "url": "example"
        },
        "thumbnail_high_quality": {
          "download_url": "example",
          "url": "example"
        },
        "video_h264_180": {
          "download_url": "example",
          "url": "example"
        }
      },
      "media_type": "example",
      "metadata": [],
      "name": "example",
      "parent_id": "example",
      "project": {
        "adobe_id": "example",
        "created_at": "example",
        "description": "example",
        "id": "example",
        "image": "example",
        "name": "example",
        "owner": {
          "active": false,
          "adobe_user_id": "example",
          "avatar_url": "example",
          "email": "example",
          "id": "example",
          "name": "example"
        },
        "restricted": false,
        "root_folder_id": "example",
        "status": "active",
        "storage": 1,
        "updated_at": "example",
        "view_url": "example",
        "workspace_id": "example"
      },
      "project_id": "example",
      "status": "created",
      "type": "file",
      "updated_at": "example",
      "view_url": "example"
    }
  }
}

Get folder

Show folder

Inputs

Accountaccount_idtextRequired
A Frame.io or Adobe entity identifier. Typically a Frame.io UUID. But for accounts, projects, folders, files, and version stacks that reside in Adobe cloud storage, which is the case for Workfront-connected accounts and projects, an Adobe-assigned id may also be used interchangeably. These ids must be.
Folder idfolder_idtextRequired
A Frame.io or Adobe entity identifier. Typically a Frame.io UUID. But for accounts, projects, folders, files, and version stacks that reside in Adobe cloud storage, which is the case for Workfront-connected accounts and projects, an Adobe-assigned id may also be used interchangeably. These ids must be.
Includeincludetext
Include query parameter for assetsOne of: creator, project, metadata.

Outputs

dataobject
Frame.io response data.
Example output
{
  "data": {
    "data": {
      "adobe_id": "example",
      "cover_file_id": "example",
      "created_at": "example",
      "creator": {
        "active": false,
        "adobe_user_id": "example",
        "avatar_url": "example",
        "email": "example",
        "id": "example",
        "name": "example"
      },
      "id": "example",
      "metadata": [],
      "name": "example",
      "parent_id": "example",
      "project": {
        "adobe_id": "example",
        "created_at": "example",
        "description": "example",
        "id": "example",
        "image": "example",
        "name": "example",
        "owner": {
          "active": false,
          "adobe_user_id": "example",
          "avatar_url": "example",
          "email": "example",
          "id": "example",
          "name": "example"
        },
        "restricted": false,
        "root_folder_id": "example",
        "status": "active",
        "storage": 1,
        "updated_at": "example",
        "view_url": "example",
        "workspace_id": "example"
      },
      "project_id": "example",
      "restricted": false,
      "type": "file",
      "updated_at": "example",
      "view_url": "example"
    }
  }
}

Get my profile

Show user

Inputs

None.

Outputs

dataobject
User profile
Example output
{
  "data": {
    "data": {
      "avatar_url": "example",
      "email": "example",
      "id": "example",
      "name": "example"
    }
  }
}

Get project

Show project

Inputs

Accountaccount_idtextRequired
A Frame.io or Adobe entity identifier. Typically a Frame.io UUID. But for accounts, projects, folders, files, and version stacks that reside in Adobe cloud storage, which is the case for Workfront-connected accounts and projects, an Adobe-assigned id may also be used interchangeably. These ids must be.
Project idproject_idtextRequired
A Frame.io or Adobe entity identifier. Typically a Frame.io UUID. But for accounts, projects, folders, files, and version stacks that reside in Adobe cloud storage, which is the case for Workfront-connected accounts and projects, an Adobe-assigned id may also be used interchangeably. These ids must be.
Includeincludetext
Include query parameter for projectsOne of: owner.

Outputs

dataobject
Frame.io project details
Example output
{
  "data": {
    "data": {
      "adobe_id": "example",
      "created_at": "example",
      "description": "example",
      "id": "example",
      "image": "example",
      "name": "example",
      "owner": {
        "active": false,
        "adobe_user_id": "example",
        "avatar_url": "example",
        "email": "example",
        "id": "example",
        "name": "example"
      },
      "restricted": false,
      "root_folder_id": "example",
      "status": "active",
      "storage": 1,
      "updated_at": "example",
      "view_url": "example",
      "workspace_id": "example"
    }
  }
}

List accounts

List accounts

Inputs

Sortsorttext
Sort accounts by query paramsOne of: display_name_asc (Display name asc), created_at_asc (Created at asc), display_name_desc (Display name desc), created_at_desc (Created at desc).
Afteraftertext
Opaque Cursor query param for requests returning paginated results. NOTE: this value is auto-generated and included as part of links from a previous response. It is not intended to be human readable.
Page sizepage_sizenumber
Page size query param for requestsFrom 1 to 100. Default: 50.
Include total countinclude_total_counttrue/false
Page query param to include the count of all entitiesDefault: false.

Outputs

dataobject
Frame.io response data.
Example output
{
  "data": {
    "data": [],
    "links": {
      "next": "example"
    },
    "total_count": 1
  }
}

List comments

List comments

Inputs

Accountaccount_idtextRequired
A Frame.io or Adobe entity identifier. Typically a Frame.io UUID. But for accounts, projects, folders, files, and version stacks that reside in Adobe cloud storage, which is the case for Workfront-connected accounts and projects, an Adobe-assigned id may also be used interchangeably. These ids must be.
File idfile_idtextRequired
A Frame.io or Adobe entity identifier. Typically a Frame.io UUID. But for accounts, projects, folders, files, and version stacks that reside in Adobe cloud storage, which is the case for Workfront-connected accounts and projects, an Adobe-assigned id may also be used interchangeably. These ids must be.
Timestamp as timecodetimestamp_as_timecodetrue/false
Timestamp as timecode.
Includeincludetext
Include query parameter for commentsOne of: owner, replies.
Sortsorttext
Sort comments by query paramsOne of: owner_asc (Owner asc), owner_desc (Owner desc), completed_at_asc (Completed at asc), completed_at_desc (Completed at desc), created_at_asc (Created at asc), created_at_desc (Created at desc).
Afteraftertext
Opaque Cursor query param for requests returning paginated results. NOTE: this value is auto-generated and included as part of links from a previous response. It is not intended to be human readable.
Page sizepage_sizenumber
Page size query param for requestsFrom 1 to 100. Default: 50.
Include total countinclude_total_counttrue/false
Page query param to include the count of all entitiesDefault: false.

Outputs

dataobject
Frame.io response data.
Example output
{
  "data": {
    "data": [],
    "links": {
      "next": "example"
    },
    "total_count": 1
  }
}

List files

List files

Inputs

Accountaccount_idtextRequired
A Frame.io or Adobe entity identifier. Typically a Frame.io UUID. But for accounts, projects, folders, files, and version stacks that reside in Adobe cloud storage, which is the case for Workfront-connected accounts and projects, an Adobe-assigned id may also be used interchangeably. These ids must be.
Folder idfolder_idtextRequired
A Frame.io or Adobe entity identifier. Typically a Frame.io UUID. But for accounts, projects, folders, files, and version stacks that reside in Adobe cloud storage, which is the case for Workfront-connected accounts and projects, an Adobe-assigned id may also be used interchangeably. These ids must be.
Includeincludetext
Supported include query parameter values for endpoints that return files with media linksOne of: media_links.original (Media links.original), media_links.thumbnail (Media links.thumbnail), media_links.thumbnail_high_quality (Media links.thumbnail high quality), media_links.video_h264_180 (Media links.video h264 180), media_links.high_quality (Media links.high quality), media_links.efficient (Media links.efficient), media_links.scrub_sheet (Media links.scrub sheet), creator, project, metadata.
Sortsorttext
Sort files by query paramsOne of: name_asc (Name asc), created_at_asc (Created at asc), updated_at_asc (Updated at asc), file_size_asc (File size asc), name_desc (Name desc), created_at_desc (Created at desc), updated_at_desc (Updated at desc), file_size_desc (File size desc).
Afteraftertext
Opaque Cursor query param for requests returning paginated results. NOTE: this value is auto-generated and included as part of links from a previous response. It is not intended to be human readable.
Page sizepage_sizenumber
Page size query param for asset list requestsFrom 1 to 500. Default: 50.
Include total countinclude_total_counttrue/false
Page query param to include the count of all entitiesDefault: false.

Outputs

dataobject
Frame.io response data.
Example output
{
  "data": {
    "data": [],
    "links": {
      "next": "example"
    },
    "total_count": 1
  }
}

List folder children

List folder children

Inputs

Accountaccount_idtextRequired
A Frame.io or Adobe entity identifier. Typically a Frame.io UUID. But for accounts, projects, folders, files, and version stacks that reside in Adobe cloud storage, which is the case for Workfront-connected accounts and projects, an Adobe-assigned id may also be used interchangeably. These ids must be.
Folder idfolder_idtextRequired
A Frame.io or Adobe entity identifier. Typically a Frame.io UUID. But for accounts, projects, folders, files, and version stacks that reside in Adobe cloud storage, which is the case for Workfront-connected accounts and projects, an Adobe-assigned id may also be used interchangeably. These ids must be.
Includeincludetext
Supported include query parameter values for endpoints that return files with media linksOne of: media_links.original (Media links.original), media_links.thumbnail (Media links.thumbnail), media_links.thumbnail_high_quality (Media links.thumbnail high quality), media_links.video_h264_180 (Media links.video h264 180), media_links.high_quality (Media links.high quality), media_links.efficient (Media links.efficient), media_links.scrub_sheet (Media links.scrub sheet), creator, project, metadata.
Sortsorttext
Sort folder children by query paramsOne of: name_asc (Name asc), created_at_asc (Created at asc), updated_at_asc (Updated at asc), name_desc (Name desc), created_at_desc (Created at desc), updated_at_desc (Updated at desc).
Typetypetext
Type filter for folder children
Afteraftertext
Opaque Cursor query param for requests returning paginated results. NOTE: this value is auto-generated and included as part of links from a previous response. It is not intended to be human readable.
Page sizepage_sizenumber
Page size query param for asset list requestsFrom 1 to 500. Default: 50.
Include total countinclude_total_counttrue/false
Page query param to include the count of all entitiesDefault: false.

Outputs

dataobject
Frame.io response data.
Example output
{
  "data": {
    "data": [],
    "links": {
      "next": "example"
    },
    "total_count": 1
  }
}

List folders

List folders

Inputs

Accountaccount_idtextRequired
A Frame.io or Adobe entity identifier. Typically a Frame.io UUID. But for accounts, projects, folders, files, and version stacks that reside in Adobe cloud storage, which is the case for Workfront-connected accounts and projects, an Adobe-assigned id may also be used interchangeably. These ids must be.
Folder idfolder_idtextRequired
A Frame.io or Adobe entity identifier. Typically a Frame.io UUID. But for accounts, projects, folders, files, and version stacks that reside in Adobe cloud storage, which is the case for Workfront-connected accounts and projects, an Adobe-assigned id may also be used interchangeably. These ids must be.
Includeincludetext
Include query parameter for assetsOne of: creator, project, metadata.
Sortsorttext
Sort folders by query paramsOne of: name_asc (Name asc), created_at_asc (Created at asc), updated_at_asc (Updated at asc), name_desc (Name desc), created_at_desc (Created at desc), updated_at_desc (Updated at desc).
Afteraftertext
Opaque Cursor query param for requests returning paginated results. NOTE: this value is auto-generated and included as part of links from a previous response. It is not intended to be human readable.
Page sizepage_sizenumber
Page size query param for asset list requestsFrom 1 to 500. Default: 50.
Include total countinclude_total_counttrue/false
Page query param to include the count of all entitiesDefault: false.

Outputs

dataobject
Frame.io response data.
Example output
{
  "data": {
    "data": [],
    "links": {
      "next": "example"
    },
    "total_count": 1
  }
}

List projects

List projects

Inputs

Accountaccount_idtextRequired
A Frame.io or Adobe entity identifier. Typically a Frame.io UUID. But for accounts, projects, folders, files, and version stacks that reside in Adobe cloud storage, which is the case for Workfront-connected accounts and projects, an Adobe-assigned id may also be used interchangeably. These ids must be.
Workspaceworkspace_idtextRequired
A UUID string that uniquely identifies a Frame.io entity.
Includeincludetext
Include query parameter for projectsOne of: owner.
Sortsorttext
Sort projects by query paramsOne of: name_asc (Name asc), created_at_asc (Created at asc), name_desc (Name desc), created_at_desc (Created at desc).
Afteraftertext
Opaque Cursor query param for requests returning paginated results. NOTE: this value is auto-generated and included as part of links from a previous response. It is not intended to be human readable.
Page sizepage_sizenumber
Page size query param for requestsFrom 1 to 100. Default: 50.
Include total countinclude_total_counttrue/false
Page query param to include the count of all entitiesDefault: false.

Outputs

dataobject
Frame.io projects
Example output
{
  "data": {
    "data": [],
    "links": {
      "next": "example"
    },
    "total_count": 1
  }
}

List webhooks

List webhooks

Inputs

Accountaccount_idtextRequired
A Frame.io or Adobe entity identifier. Typically a Frame.io UUID. But for accounts, projects, folders, files, and version stacks that reside in Adobe cloud storage, which is the case for Workfront-connected accounts and projects, an Adobe-assigned id may also be used interchangeably. These ids must be.
Workspaceworkspace_idtextRequired
A UUID string that uniquely identifies a Frame.io entity.
Includeincludetext
Include query parameter for webhooksOne of: creator.
Sortsorttext
Sort webhooks by query paramsOne of: name_asc (Name asc), created_at_asc (Created at asc), name_desc (Name desc), created_at_desc (Created at desc).
Afteraftertext
Opaque Cursor query param for requests returning paginated results. NOTE: this value is auto-generated and included as part of links from a previous response. It is not intended to be human readable.
Page sizepage_sizenumber
Page size query param for requestsFrom 1 to 100. Default: 50.
Include total countinclude_total_counttrue/false
Page query param to include the count of all entitiesDefault: false.

Outputs

dataobject
Frame.io webhooks
Example output
{
  "data": {
    "data": [],
    "links": {
      "next": "example"
    },
    "total_count": 1
  }
}

List workspaces

List workspaces

Inputs

Accountaccount_idtextRequired
A Frame.io or Adobe entity identifier. Typically a Frame.io UUID. But for accounts, projects, folders, files, and version stacks that reside in Adobe cloud storage, which is the case for Workfront-connected accounts and projects, an Adobe-assigned id may also be used interchangeably. These ids must be.
Includeincludetext
Include query parameter for workspacesOne of: creator.
Sortsorttext
Sort workspaces by query paramsOne of: name_asc (Name asc), created_at_asc (Created at asc), name_desc (Name desc), created_at_desc (Created at desc).
Afteraftertext
Opaque Cursor query param for requests returning paginated results. NOTE: this value is auto-generated and included as part of links from a previous response. It is not intended to be human readable.
Page sizepage_sizenumber
Page size query param for requestsFrom 1 to 100. Default: 50.
Include total countinclude_total_counttrue/false
Page query param to include the count of all entitiesDefault: false.

Outputs

dataobject
Frame.io workspace details
Example output
{
  "data": {
    "data": [],
    "links": {
      "next": "example"
    },
    "total_count": 1
  }
}

Update comment

Update comment

Inputs

Accountaccount_idtextRequired
A Frame.io or Adobe entity identifier. Typically a Frame.io UUID. But for accounts, projects, folders, files, and version stacks that reside in Adobe cloud storage, which is the case for Workfront-connected accounts and projects, an Adobe-assigned id may also be used interchangeably. These ids must be.
Comment idcomment_idtextRequired
A UUID string that uniquely identifies a Frame.io entity.
Timestamp as timecodetimestamp_as_timecodetrue/false
Timestamp as timecode.
Anchoranchorobject
Comment anchor location. {(x, y) | 0 <= x <= 1, 0 <= y <= 1}.
Annotationannotationtext
JSON geometry for on-screen drawings. Allowed for document, image, video, or stream file types. JSON must be stringified.
Completedcompletedtrue/false
Comment completion status
Durationdurationnumber
Duration of comment in frames. Requires presence of timestamp parameterAt least 1.
Linkslinkslist
Comment text links.
Pagepagenumber
Document page. Only allowed when file type is a pdf documentAt least 1.
Texttexttext
Comment text
Text review annotationtext_review_annotationobject
Payload for updating an existing text review annotation.
Timestamptimestampobject
Timestamp.

Outputs

dataobject
Frame.io response data.
Example output
{
  "data": {
    "data": {
      "anchor": {},
      "annotation": "example",
      "attachments": [],
      "completed_at": "example",
      "completer_id": "example",
      "created_at": "example",
      "duration": 1,
      "file_id": "example",
      "id": "example",
      "links": [],
      "mentions": [],
      "page": 1,
      "text": "example",
      "text_edited_at": "example",
      "text_review_annotation": {},
      "timestamp": {},
      "updated_at": "example"
    }
  }
}

Update file

Update file

Inputs

Accountaccount_idtextRequired
A Frame.io or Adobe entity identifier. Typically a Frame.io UUID. But for accounts, projects, folders, files, and version stacks that reside in Adobe cloud storage, which is the case for Workfront-connected accounts and projects, an Adobe-assigned id may also be used interchangeably. These ids must be.
File idfile_idtextRequired
A Frame.io or Adobe entity identifier. Typically a Frame.io UUID. But for accounts, projects, folders, files, and version stacks that reside in Adobe cloud storage, which is the case for Workfront-connected accounts and projects, an Adobe-assigned id may also be used interchangeably. These ids must be.
Namenametext
File name

Outputs

dataobject
Frame.io response data.
Example output
{
  "data": {
    "data": {
      "adobe_id": "example",
      "adobe_version_id": "example",
      "created_at": "example",
      "file_size": 1,
      "id": "example",
      "media_type": "example",
      "name": "example",
      "parent_id": "example",
      "project_id": "example",
      "status": "created",
      "type": "file",
      "updated_at": "example",
      "view_url": "example"
    }
  }
}

Update folder

Update folder

Inputs

Accountaccount_idtextRequired
A Frame.io or Adobe entity identifier. Typically a Frame.io UUID. But for accounts, projects, folders, files, and version stacks that reside in Adobe cloud storage, which is the case for Workfront-connected accounts and projects, an Adobe-assigned id may also be used interchangeably. These ids must be.
Folder idfolder_idtextRequired
A Frame.io or Adobe entity identifier. Typically a Frame.io UUID. But for accounts, projects, folders, files, and version stacks that reside in Adobe cloud storage, which is the case for Workfront-connected accounts and projects, an Adobe-assigned id may also be used interchangeably. These ids must be.
Namenametext
Folder name

Outputs

dataobject
Frame.io response data.
Example output
{
  "data": {
    "data": {
      "adobe_id": "example",
      "cover_file_id": "example",
      "created_at": "example",
      "id": "example",
      "name": "example",
      "parent_id": "example",
      "project_id": "example",
      "restricted": false,
      "type": "file",
      "updated_at": "example",
      "view_url": "example"
    }
  }
}

Update project

Update project

Inputs

Accountaccount_idtextRequired
A Frame.io or Adobe entity identifier. Typically a Frame.io UUID. But for accounts, projects, folders, files, and version stacks that reside in Adobe cloud storage, which is the case for Workfront-connected accounts and projects, an Adobe-assigned id may also be used interchangeably. These ids must be.
Project idproject_idtextRequired
A Frame.io or Adobe entity identifier. Typically a Frame.io UUID. But for accounts, projects, folders, files, and version stacks that reside in Adobe cloud storage, which is the case for Workfront-connected accounts and projects, an Adobe-assigned id may also be used interchangeably. These ids must be.
Namenametext
Project Name
Restrictedrestrictedtrue/false
Whether the project is restricted or not
Statusstatustext
Project StatusOne of: active, inactive.

Outputs

dataobject
Frame.io project details
Example output
{
  "data": {
    "data": {
      "adobe_id": "example",
      "created_at": "example",
      "id": "example",
      "image": "example",
      "name": "example",
      "restricted": false,
      "root_folder_id": "example",
      "status": "active",
      "storage": 1,
      "updated_at": "example",
      "view_url": "example",
      "workspace_id": "example"
    }
  }
}

On this page