Sign in

v3

latestOpenAPI 3.1.02026-07-3197486526.1 KB
embed > tasks

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.

get/embed/tasks/{task_id}

Path parameters

task_idstring required

The unique identifier of your video embedding task.

Query parameters

embedding_optionEmbedTasksTaskIdGetParametersEmbeddingOptionSchemaItems[]

Specifies which types of embeddings to retrieve. Values: visual, audio, transcription. For details, see the Embedding options section.

<Note title="Note"> The platform returns all available embeddings when you omit this parameter. </Note>

Headers

x-api-keystring required

Your API key.

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

Response

Video embeddings have successfully been retrieved.

_idstring

The unique identifier of the video embedding task.

model_namestring

The name of the video understanding model the platform used to create the embedding.

statusstring

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

created_atstring date-time

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

updated_atstring date-time

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