embed > v2 > tasks

Retrieve task status and results

Changed on

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}

Request

  • Base URL: https://api.twelvelabs.io/v1.3
  • URL: https://api.twelvelabs.io/v1.3/embed-v2/tasks/{task_id}
  • Auth: API key in header x-api-key

Path parameters

task_idstring required

The unique identifier of the embedding task.

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.

Changes

  • 69c273061729Revision changes
    • breaking

      added subschema #1 subschema #2 subschema #3 subschema #4 to the response property oneOf list for the response status

    • warning

      added the new chunk enum value to the /// response property for the response status

    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status

    • info

      added the optional property / to the response with the status

    • info

      removed subschema #1 subschema #2 subschema #3 subschema #4 from the response property oneOf list for the response status

  • b8591e05c0baRevision changes
    • warning

      deleted the header request parameter x-api-key

    • info

      the endpoint scheme security x-api-key was added to the API