API Reference

Create C2C asset

Asset upload initiation specifically for C2C devices and applications.

Note: This endpoint used to be /v2/assets, and while that endpoint will continue to function as normal, we suggest you use this one instead.

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/

Request

While supported, we encourage you to switch from application/x-ww-form-urlencoded to application/json in order to support future workflows that will only be supported through JSON.

When is_realtime_upload is true, call must be made in application/json.

namestringOptionalDefaults to
The name the asset should have in Frame.io. This value does not have to match the name of the file on disk; it can be whatever you want it to be in Frame.io. Required if `is_realtime_upload` is `false`. If `is_realtime_upload` is `true`, must containa valid extension in the form of `".[ext]"`, unless `extension` is provided, in which case this field may be `null` or omitted.
extensionstringOptionalformat: "\..+"

Required when is_realtime_upload is true, when name is not known at time of asset creation. If name is provided, must match extension of that value.

Ignored when is_realtime_upload is false.

When supplied, asset will be creted with name value of "[new file].extension".

filetypestringOptional

MIME type like video/quicktime. Many languages have built in utilities for detecting file mimetype (see Go and Python for examples).

Required if is_realtime_upload is true.

auto_version_idstringOptionalformat: "uuid"
The asset you'd like this to be the next version of
is_realtime_uploadbooleanOptionalDefaults to false

If true, File data for this asset is to be uploaded through the Real-time Uploads API.

If false, File data for this asset will be uploaded through the default API.

Must be false if filetype is not file.

filesizestring or integerOptional
channelstring or integerOptional
offsetstring or integerOptional
partsstring or integerOptional

Response

Asset create success response.

When is_realtime_asset was set to true in the request, a simplified payload will be returned.

object
OR
RealtimeAssetCreateResponseobject

Errors