API ReferenceUpload contentDirect uploads

Retrieve an asset

This method retrieves details about the specified asset.

Authentication

x-api-keystring
Your API key. <Note title="Note"> You can find your API key on the <a href="https://playground.twelvelabs.io/dashboard/api-key" target="_blank">API Key</a> page. </Note>

Path Parameters

asset_idstringRequired
The unique identifier of the asset to retrieve.

Response

The asset has been successfully retrieved.
_idstring or null
The unique identifier of the asset.
methodenum or null
Indicates how you uploaded the asset. **Values**: - `direct`: Uploaded from your local file system - `url`: Uploaded from a publicly accessible URL
Allowed values:
statusenum or null
Indicates the current status of the asset. **Values**: - `failed`: The platform failed to process the upload - `processing`: The platform is processing the uploaded file - `ready`: The asset is ready to use
Allowed values:
filenamestring or null
The name of the file used to create the asset.
file_typestring or null
The MIME type of the asset file.
urlstring or null

The URL to access your asset. Use this URL to preview or download the asset.

This URL expires after the time specified in the url_expires_at field. After expiration, you must retrieve the asset again to obtain a new URL.

url_expires_atstring or nullformat: "date-time"

The date and time, in RFC 3339 format (“YYYY-MM-DDTHH:mm:ssZ”), when the URL expires. After this time, the URL in the url field becomes invalid. Retrieve the asset again to obtain a new URL.

created_atstring or nullformat: "date-time"

The date and time, in RFC 3339 format (“YYYY-MM-DDTHH:mm:ssZ”), when the asset was created.

Errors