Sign in

v3

latestOpenAPI 3.1.02026-07-3197486526.1 KB
embed > tasks

Retrieve the status of a video embedding task

<Note title="Note"> This endpoint will be deprecated in a future version. Migrate to the [Embed API v2](/v1.3/api-reference/create-embeddings-v2) for continued support and access to new features. </Note> This method retrieves the status of a video embedding task. Check the task status of a video embedding task to determine when you can retrieve the embedding.

A task can have one of the following statuses:

  • processing: The platform is creating the embeddings.
  • ready: Processing is complete. Retrieve the embeddings by invoking the GET method of the /embed/tasks/{task_id} endpoint.
  • failed: The task could not be completed, and the embeddings haven't been created.
get/embed/tasks/{task_id}/status

Path parameters

task_idstring required

The unique identifier of your video embedding task.

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

The status of your video embedding task has been retrieved.

_idstring

The unique identifier of the video embedding task.

statusstring

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

model_namestring

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