API ReferenceCreate video embeddings

Retrieve video embeddings

This method retrieves embeddings for a specific video embedding task. Ensure the task status is ready before invoking this method. Refer to the Retrieve the status of a video embedding tasks page for instructions on checking the task status.

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

task_idstringRequired
The unique identifier of your video embedding task.

Query parameters

embedding_optionlist of enumsOptional
Specifies which types of embeddings to retrieve. You can include one or more of the following values: - `visual-text`: Returns visual embeddings optimized for text search. - `audio`: Returns audio embeddings. The platform returns all available embeddings if you don't provide this parameter. The platform returns all available embeddings if you don't provide this parameter. The values you specify in `embedding_option` must be included in the `model_options` defined when the index was created. For example, if `model_options` is set to `visual` only, then you cannot set `embedding_option` to `audio` or both `visual-text` and `audio`.
Allowed values:

Response

Video embeddings have successfully been retrieved.
_idstring or null
The unique identifier of the video embedding task.
created_atstring or nullformat: "date-time"

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

model_namestring or null
The name of the video understanding model the platform used to create the embedding.
statusstring or null

A string indicating the status of the video indexing task. It can take one of the following values: processing, ready or failed.

video_embeddingobject or null

Errors