Sign in

v3

latestOpenAPI 3.1.02026-07-3197486526.1 KB
embed > v2 > tasks

Retrieve task status and results

This method retrieves the status and the results of an async embedding task.

Invoke this method repeatedly until the status field is ready or failed. When the status is ready, use the embeddings from the response. When the status is failed, the error.message field contains the reason.

<Note title="Note"> Embeddings are stored for seven days. </Note>
get/embed-v2/tasks/{task_id}

Path parameters

task_idstring required

The unique identifier of the 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

Task status and results retrieved successfully

_idstring required

The unique identifier of the embedding task.

status'processing' | 'ready' | 'failed' required

The current status of the task.

Values:

  • processing: The platform is creating the embeddings
  • ready: Processing is complete. Embeddings are available in the data field
  • failed: The task failed. The data field is null, and the error.message field contains the reason
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.