Request device code

Request

header Parameters

x-client-version

string

Default: 0.0.0

Firmware or software version of a C2C integration. Will be used to determine the correct Device Model configuration for the device when multiple are available. Must be a valid semantic version.

For more on semantic versions, see here: https://semver.org/

Example: 2.16.4

Request Body schema: multipart/form-data

client_id required	string A unique identifier for the physical hardware device. This value needs to be guaranteed to be unique for the device. This could be a serial number or a randomly generated UUID.
client_secret required	string This will be issued to you by Frame.io support and identifies the your device model. This value should be kept secret from the user, and should be encrypted at rest
scope required	string The permissions we are requesting, with spaces used as delimiters. Hardware devices can only request the following two scopes Enum: "asset_create" "offline"

Responses

200

Succesful request

Response Schema: application/json

device_code required	string non-empty The device code should be hidden from the user, and is used to identify this authorization request when polling to see if the user has entered their code successfully.
expires_in required	number <= 120 The number of seconds until this code expires.
interval required	number How long the we should wait between polling requests to see if the user has entered the code.
name required	string non-empty The name of the device we are trying to connect.
user_code required	string non-empty The six-digit code the user will enter into Frame.io to pair the device to a project.

post/v2/device/code

Request samples

curl
JavaScript
Node.js
Python
C#

Response samples

application/json

{"device_code": "string",
"expires_in": 0,
"interval": 0,
"name": "string",
"user_code": "string"
}

Request device code

header Parameters

Request Body schema: multipart/form-data

Response Schema: application/json

Overview

Integrations

Company

Support