Sign in

v3

latestOpenAPI 3.1.02026-07-3197486526.1 KB
analyzeAsync > tasks

Retrieve analysis task status and results

This method retrieves the status and results of an analysis task.

Task statuses:

  • queued: The task is waiting to be processed.
  • pending: The task is queued and waiting to start.
  • processing: The platform is analyzing the video.
  • ready: Processing is complete. Results are available in the response.
  • failed: The task failed. No results were generated.

Poll this method until status is ready or failed. When status is ready, use the results from the response.

get/analyze/tasks/{task_id}

Path parameters

task_idstring required

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

task_idstring required

The unique identifier of the analysis task.

custom_idstring nullable required

The identifier you provided in the custom_id field when you created the task, or null if you did not set one. This key is always present in the response.

status'queued' | 'pending' | 'processing' | 'ready' | 'failed' required

The current status of the analysis task.

created_atstring date-time required

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

completed_atstring date-time

A string representing the date and time, in RFC 3339 format ("YYYY-MM-DDTHH:mm:ssZ"), when the analysis task was completed or failed. The platform returns this field only if status is ready or failed.