Introduction

Quick Start

This guide covers the fastest path to your first successful Frame.io V4 API call. You’ll create a project in the Adobe Developer Console, generate credentials, and make your first API request.

Step 1: Create a Project in Your Adobe Developer Console + Add the Frame.io V4 API

From the Adobe Developer Console, create a new project, and add the Frame.io V4 API.

This guide uses OAuth 2.0 Web App for authentication. For information on other authentication methods, see the Authentication Guide

Step 2: Configure Your Application

Select OAuth Web App as your application type, and set your redirect fields.

Redirect URIA route in your application that receives the OAuth response from Adobe IMS. After a user signs in and approves access, Adobe IMS redirects them to this URL with an authorization code in the query string, which your app then exchanges for an access token
Redirect URI patternPatterns that match additional redirect URLs beyond the default redirect URI. This is useful if your app runs in multiple environments or uses dynamic routing. Multiple patterns should be provided as a comma-separated list

Step 3: Authentication

Start the OAuth flow by redirecting the user to the Adobe IMS authorization endpoint:

  https://ims-na1.adobelogin.com/ims/authorize/v2
  ?client_id={CLIENT_ID}
  &redirect_uri={REDIRECT_URI}
  &scope=offline_access,openid,email,profile,additional_info.roles
  &response_type=code

After the user signs in and approves access, Adobe IMS redirects them back to your configured redirect URI with an authorization code in the query string. Exchange that code for an access token by sending a POST request to the IMS token endpoint.


Here is a list of parameter definitions along with an example request and response:

ParameterMandatoryDescription
codeYesThe value of the code query string returned to your redirect_uri when a user authenticates with your application
grant_typeYesValue should always be authorization_code
authorizationRequired for confidential clientsThe Basic auth header string. It is the literal word Basic followed by the Base64-encoded string of your clientID:clientSecret

Example Request

curl -X POST 'https://ims-na1.adobelogin.com/ims/token/v3' \
  -H 'Authorization: Basic {AUTHORIZATION}' \
  -H 'Content-Type: application/x-www-form-urlencoded' \
  -d 'code={CODE}&grant_type=authorization_code'

Example Response

{
    "access_token": "{ACCESS_TOKEN}",
    "refresh_token": "{REFRESH_TOKEN}",
    "sub": "B0DC108C5CD449CA0A494133@c62f24cc5b5b7e0e0a494004",
    "id_token": "{ID_TOKEN}",
    "token_type": "bearer",
    "expires_in": 86399
}
SDK Support

Both the Python and TypeScript SDKs include authentication modules that handle the OAuth handshake, token exchange, and automatic token refresh. You can find more on each here: Python | TypeScript

Step 4: Make Your First API Requests

With your access token, start by calling the /v4/me endpoint:

curl https://api.frame.io/v4/me \
-H "Authorization: Bearer <token>"

This request returns details about the authenticated user, including user_id, name, and email. A successful response confirms that your authentication flow is working as expected.

Most V4 API endpoints require an account_id, which is not returned by /v4/me. To get your account_id, make a request to /v4/accounts:

curl https://api.frame.io/v4/accounts \
-H "Authorization: Bearer <token>"

This returns the list of accounts available to the authenticated user. Use the account_id from this response in subsequent API requests.

Next Steps

With authentication in place and your account_id, you’re ready to start working with the Frame.io API. These resources can help you get started: