API ReferenceCreate embeddings v2

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>

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-keys" target="_blank">API Keys</a> page. </Note>

Path parameters

task_idstringRequired
The unique identifier of the embedding task.

Response

Task status and results retrieved successfully
_idstring
The unique identifier of the embedding task.
statusenum

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
datalist of objects or null

An object containing the embedding results, or null otherwise.

created_atstringformat: "date-time"

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

updated_atstringformat: "date-time"

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

metadataobject
Metadata for the media input.
errorobject

An object describing why the embedding task failed. Present only when status is failed. Omitted otherwise.

Errors

404
Not Found Error