API ReferenceRessources

Créer un asset

Créez un asset.

Authentification

AuthorizationBearer

Authentification bearer de la forme Bearer <token>, où token est votre jeton d’authentification.

Paramètres de chemin

asset_idstringRequisformat: "uuid"

Requête

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.

typeenumRequis

Must be file if is_realtime_upload is true.

Valeurs autorisées:
namestringOptionnel
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.
extensionstringOptionnel
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"`.
filetypestringOptionnel

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.

is_realtime_uploadbooleanOptionnelPar défaut 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.

descriptionstringOptionnel
Brief description of the Asset
filesizeintegerOptionnel

File size in bytes.

Required if is_realtime_upload is not true.

propertiesobjectOptionnel

Custom key-value data

sourceobjectOptionnel

En-têtes de réponse

x-ratelimit-limitdouble

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

x-ratelimit-remainingstring

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

x-ratelimit-windowstring
The length in milliseconds of the rate limit window

Réponse

Asset create success response.

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

object
OR
RealtimeAssetCreateResponseobject

Erreurs

400
Bad Request Error
401
Unauthorized Error
404
Not Found Error
429
Too Many Requests Error