Frame.io API (2.0.0)

Developer Relations: platform@frame.io URL: http://developer.frame.io License: MIT License

Documentation for the Frame.io API Frame.io's API is powered by a RESTful interface.

We have code samples here in C#, JavaScript, cURL, as well as several from our Python SDK

Authentication

JWT

Bearer token used by Frame.io developed applications like our web app, iOS app, FCPX integration, Premiere integration, After Effects integration, Watch Folders app, etc.

Security Scheme Type HTTP
HTTP Authorization Scheme bearer
Bearer format "JWT"

Developer Token

Security Scheme Type HTTP
HTTP Authorization Scheme bearer

OAuth2

OAuth Token - configured on https://developer.frame.io/app/ouath-apps

Security Scheme Type OAuth2
authorizationCode OAuth Flow
Authorization URL: https://applications.frame.io/oauth2/auth
Token URL: https://applications.frame.io/oauth2/token
Refresh URL: https://applications.frame.io/oauth2/token
Scopes:
  • presentation.update -

    modify presentations

  • comment.read -

    read comments

  • asset.update -

    modify assets

  • reviewlink.update -

    modify review links

  • webhook.create -

    create webhooks

  • account.read -

    read accounts

  • action.update -

    modify actions

  • reviewlink.read -

    read review links

  • presentation.read -

    read presentations

  • action.create -

    create actions

  • presentation.create -

    create presentations

  • auditlog.read -

    read audit logs

  • team.create -

    create teams

  • comment.create -

    create comments

  • team.read -

    read teams

  • offline -

    generate refresh tokens

  • reviewlink.delete -

    delete review links

  • project.update -

    modify projects

  • project.delete -

    delete projects

  • webhook.delete -

    delete webhooks

  • action.delete -

    delete actions

  • asset.delete -

    delete assets

  • webhook.read -

    read webhooks

  • asset.create -

    create assets

  • comment.delete -

    delete comments

  • webhook.update -

    modify webhooks

  • asset.read -

    read assets

  • comment.update -

    modify comments

  • project.read -

    read projects

  • action.read -

    read actions

  • reviewlink.create -

    create review links

  • presentation.delete -

    delete presentations

  • project.create -

    create projects

  • team.update -

    modify teams

implicit OAuth Flow
Authorization URL: https://applications.frame.io/oauth2/auth
Scopes:
  • presentation.update -

    modify presentations

  • comment.read -

    read comments

  • asset.update -

    modify assets

  • reviewlink.update -

    modify review links

  • webhook.create -

    create webhooks

  • account.read -

    read accounts

  • action.update -

    modify actions

  • reviewlink.read -

    read review links

  • presentation.read -

    read presentations

  • action.create -

    create actions

  • presentation.create -

    create presentations

  • auditlog.read -

    read audit logs

  • team.create -

    create teams

  • comment.create -

    create comments

  • team.read -

    read teams

  • offline -

    generate refresh tokens

  • reviewlink.delete -

    delete review links

  • project.update -

    modify projects

  • project.delete -

    delete projects

  • webhook.delete -

    delete webhooks

  • action.delete -

    delete actions

  • asset.delete -

    delete assets

  • webhook.read -

    read webhooks

  • asset.create -

    create assets

  • comment.delete -

    delete comments

  • webhook.update -

    modify webhooks

  • asset.read -

    read assets

  • comment.update -

    modify comments

  • project.read -

    read projects

  • action.read -

    read actions

  • reviewlink.create -

    create review links

  • presentation.delete -

    delete presentations

  • project.create -

    create projects

  • team.update -

    modify teams

C2C Device Auth

Security Scheme Type OAuth2
authorizationCode OAuth Flow
Authorization URL: https://api.frame.io/v2/auth/device/code
Token URL: https://api.frame.io/v2/auth/token
Refresh URL: https://api.frame.io/v2/auth/token
Scopes:
  • offline -

    Enables refreshing of tokens

  • asset_create -

    Enables ability to create assets in fixed folder structure

C2C OAuth2

Security Scheme Type OAuth2
authorizationCode OAuth Flow
Authorization URL: https://applications.frame.io/oauth2/auth
Token URL: https://applications.frame.io/oauth2/token
Refresh URL: https://applications.frame.io/oauth2/token
Scopes:
  • offline -

    Enables refreshing of tokens

  • asset_create -

    Enables ability to create assets in fixed folder structure

  • device_connect -

    Enables ability to connect to project as a device