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.

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.

Authentication

x-api-keystring

Your API key.

Note

You can find your API key on the API Keys page.

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 analysis task.

Response

Task status and results retrieved successfully

task_idstring

The unique identifier of the analysis task.

statusenum

The current status of the analysis task.

Allowed values:

created_atstringformat: "date-time"

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

completed_atstringformat: "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.

resultobject

An object that contains the generated text and additional information. The platform returns this object only when status is ready.

errorobject

Details about why the task failed. The platform returns this object only when status is failed.

webhookslist of objects

The delivery status of each webhook endpoint. The platform omits this field when no webhooks are configured. You can register webhooks through the Playground. See the Webhooks page for details.

Errors

404

Not Found Error