Frame.io API

Frame.io API Documentation

Welcome to Frame.io's official documentation portal.In here, you'll find everything you need to:

Get up and running with Frame.io's public API 🤙
Leverage powerful features like Webhooks and Custom Actions 🚀
Build your own OAuth2.0 app 🚢

Get Started    Guides

Developer Tokens

This page walks you through creating your first developer token and sending a request with it.

📘

To continue, you'll need a Frame.io

If you don't have a Frame.io account, you can sign up quickly and easily by going to Frame.io and clicking Sign Up Free.

Getting a Developer Token

  1. Sign into the Frame.io Developer Portal with your Frame.io user credentials.

  2. You should get the Welcome screen. To create a new Developer Token, click the Create a Token button.

  1. You'll get the Tokens screen. Click New.
  1. On the new token screen, you need to provide a description and scopes for your token. For DESCRIPTION, we recommend choosing something that will help you remember what you use the token for. Under SCOPES, you can select which precise access scopes this token should have.

For this walkthrough, simply click on Select all scopes. You can create tokens with more specific permissions and privileges later as needed (see Scopes for more information).

  1. Scroll down and click the Create button. If you are successful, you'll get a page with a summary of information about your token.
  1. Copy the string presented in the Token field. This is your new token. Store it somewhere safe -- it represents access to your account, and once you navigate off this page, you won't be able to see it again.

At this point, you should receive an email verifying that you made a token with your chosen scopes.

📘

Tokens are presented only once

Frame.io tokens are shown only upon initial creation. If you lose a token, you can always create a new one; but you'll never be able to see old tokens apart from their descriptions and scopes.

Testing your new token

Now that you have your token, let's try a request using bearer authentication. We'll do a basic request to get information about yourself:

curl -H "Authorization: Bearer <YOUR_TOKEN>" https://api.frame.io/v2/me
import requests

url = "https://api.frame.io/v2/me"
headers = {
 "Authorization": "Bearer <YOUR_TOKEN>"
}

requests.GET(url,headers=headers)

In response, you should see a JSON representation of your User record.

Congratulations! You've just made your first call to the Frame.io API. 🎉

Updated 6 months ago

Developer Tokens


This page walks you through creating your first developer token and sending a request with it.

Suggested Edits are limited on API Reference Pages

You can only suggest edits to Markdown body content, but not to the API spec.