Skip to main content
POST
cURL

Authorizations

​
X-API-Key
string
header
required

Body

application/json
​
name
string
required

Name of the asset. Default to user-provided file name.

​
type
enum<string>
required

The type of the asset.

Available options:
text,
image,
audio,
video,
voice,
three_d,
rich_text
​
workspace_id
string | null
​
reserved_asset_id
string<uuid> | null

Optional pre-reserved asset ID, used as the produced media+asset resource_id so the client knows the upload's identity before it completes.

Response

Successful Response

​
name
string
required

Name of the asset. Default to user-provided file name.

​
type
enum<string>
required

The type of the asset.

Available options:
text,
image,
audio,
video,
voice,
three_d,
rich_text
​
id
string<uuid>
required

The id of the newly created asset. Should be used for upload.

​
workspace_id
string | null
​
reserved_asset_id
string<uuid> | null

Optional pre-reserved asset ID, used as the produced media+asset resource_id so the client knows the upload's identity before it completes.

​
upload_url
string<uri> | null

Presigned S3 URL for uploading the asset file using HTTP PUT. Only present when the asset type is VIDEO.

Required string length: 1 - 2083