Connect a new device channel | Frame.io API Documentation

We can connect a new channel with the following request

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Headers

x-client-versionstringOptionalDefaults to 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/

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/

Request

Payload

client_idstringRequiredformat: "uuid"

device_model_idstringRequiredformat: "uuid"

Response

Example response

_typestringOptionalDefaults to project_device_channel

idstringOptionalformat: "uuid"

actor_idstringOptionalformat: "uuid"

asset_typeenumOptional

device_idstringOptionalformat: "uuid"

external_indexdoubleOptional0-100

inserted_atstringOptionalformat: "date-time"

namestringOptional

Auto-generated name, based on the device model

project_idstringOptional

The Project ID that this device is linked to

project_device_idstringOptional

real_time_logging_capablebooleanOptionalDefaults to false

statusenumOptional

updated_atstringOptionalformat: "date-time"

Errors

401

Unauthorized Error

409

Conflict Error

1	import requests
2
3	headers = {
4	'Authorization': 'Bearer [access_token]',
5	'Content-Type': 'application/json',
6	'x-client-version': '2.0.0'
7	}
8
9	data = {
10	'client_id': '[client_id]',
11	'device_model_id': '[device_model_id]'
12	}
13
14	response = requests.post(
15	'https://api.frame.io/v2/devices/channels/connect',
16	headers=headers,
17	json=data
18	)
19
20	result = response.json()
21	print(result)