Frame.io v2 API (2.0.0)

Download OpenAPI specification:Download

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 some from our Python SDK

Authentication

JWTAuth

Bearer token used by internal Frame.io Applications

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

SecretTokenAuth

Security Scheme Type HTTP
HTTP Authorization Scheme token

UserTokenAuth

Security Scheme Type HTTP
HTTP Authorization Scheme bearer

OAuth

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