API ReferenceCreate embeddings v1Create 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. Values vary depending on the version of the model: - **Marengo 3.0**: `visual`, `audio`, `transcription`. - **Marengo 2.7**: `visual-text`, `audio`. For details, see the [Embedding options](/v1.3/docs/concepts/modalities#embedding-options) section. <Note title="Note"> The platform returns all available embeddings when you omit this parameter. </Note>
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"

A string representing the date and time, in RFC 3339 format (“YYYY-MM-DDTHH:mm:ssZ”), when the resource 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.

updated_atstring or nullformat: "date-time"

A string representing the date and time, in RFC 3339 format (“YYYY-MM-DDTHH:mm:ssZ”), when the resource was last updated.

video_embeddingobject or null

Errors