Frame.io v4 API Documentation
This is the complete API documentation for connecting to the Frame.io v4 API using MindCloud's Universal API. If you are new to MindCloud, start with the Introduction to see how one API can sit in front of many different apps.
MindCloud is an integration company that offers one normalized API to access 3,100+ apps from a single place. It cleans up provider-specific quirks, keeps requests and responses consistent, and centralizes authentication so you do not need to manage separate flows for every app. Browse other apps.
Meet Frame.io v4: Review, share, and manage media projects and files. Keep reading to get started.
Quickstart
Before you run your first Frame.io v4 request, you need three things:
- A MindCloud account — sign in or create an account at MindCloud.
- A MindCloud API Key — create one in API Keys. Keep it on your server.
- At least one Frame.io v4 connection — create or choose one in Connections. Note its
connectionId.
Every Frame.io v4 action uses the same URL pattern:
POST https://connect.mindcloud.co/v2/universal/apps/frameioV4/actions/{actionSlug}/runYou need a MindCloud API Key and a Frame.io v4 connection. Then call an action such as Get User Details:
curl --request POST \
--url "https://connect.mindcloud.co/v2/universal/apps/frameioV4/actions/get-user-details/run" \
--header "Authorization: Bearer $MINDCLOUD_API_KEY" \
--header "Content-Type: application/json" \
--data '{
"connectionId": "$CONNECTION_ID",
"arguments": {}
}'Every response comes back in the same envelope, with your rows in a data array:
{
"success": true,
"data": [
{ "id": "1042", "name": "Ava" }
],
"meta": {}
}After your first request works, use Shape your requests to control arguments, pagination, filtering, fields, and errors.
Authenticate with a MindCloud API Key plus a connectionId for your Frame.io v4 account. See Frame.io v4 API Authentication for the full flow and how to get your connection credentials.
Frame.io v4 actions
All 40 published actions for this Frame.io v4 version. Each page documents the endpoint, arguments, and response controls.
- POSTCopy File
- POSTCopy Folder
- POSTCopy Version Stack
- POSTCreate Comment
- POSTCreate File Local Upload
- POSTCreate File Remote Upload
- POSTCreate Folder
- POSTCreate Project
- POSTCreate Share
- POSTCreate Version Stack
- POSTCreate Workspace
- GETGet Comment
- GETGet File
- GETGet File Upload Status
- GETGet Folder
- GETGet Project
- GETGet Share
- GETGet User Details
- GETGet Version Stack
- GETGet Workspace
- POSTImport File
- GETList Accounts
- GETList Comments
- GETList Files
- GETList Folder Children
- GETList Folders
- GETList Projects
- GETList Shares
- GETList Version Stack Children
- GETList Version Stacks
- GETList Workspaces
- PUTMove File
- PUTMove Folder
- PUTMove Version Stack
- PUTUpdate Comment
- PUTUpdate File
- PUTUpdate Folder
- PUTUpdate Project
- PUTUpdate Share
- PUTUpdate Workspace
Related apps
More Content & Files apps on the Universal API, behind the same REST shape. Or browse all apps.