创建 C2C 资产 | Frame.io API Documentation

专用于 C2C 设备和应用程序的资产上传初始化。

注意：此端点之前为 /v2/assets。虽然之前的端点将继续正常运行，但我们建议您改用此端点。

身份验证

AuthorizationBearer

Bearer 身份验证，格式为 Bearer <token>，其中 token 是您的身份验证令牌。

请求头

x-client-versionstring可选默认为 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/

请求

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.

namestring可选默认为

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.

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.

extensionstring可选格式: "\..+"

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".

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"`.

filetypestring可选

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_idstring可选格式: "uuid"

The asset you'd like this to be the next version of

is_realtime_uploadboolean可选默认为 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 integer可选

channelstring or integer可选

offsetstring or integer可选

partsstring or integer可选

响应头

x-ratelimit-limitdouble

The number of times you can make this call within the x-ratelimit-window

x-ratelimit-windowstring可选

The length in milliseconds of the rate limit window

x-ratelimit-remainingstring可选

The number of remaining times you can make this API call in the x-ratelimit-window

响应

Asset create success response.

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

object

RealtimeAssetCreateResponseobject

错误

400

Bad Request Error

401

Unauthorized Error

404

Not Found Error

409

Conflict Error

429

Too Many Requests Error

1	import requests
2
3	headers = {
4	'Authorization': 'Bearer YOUR_ACCESS_TOKEN',
5	'Content-Type': 'application/json'
6	}
7
8	data = {
9	'name': 'my-video.mov',
10	'filetype': 'video/quicktime',
11	'filesize': 1073741824,
12	'is_realtime_upload': False
13	}
14
15	response = requests.post(
16	'https://api.frame.io/v2/devices/assets',
17	headers=headers,
18	json=data
19	)
20
21	asset = response.json()
22	print(asset)