analyzeAsync > tasks

Retrieve analysis task status and results

Changed on

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 result is available. The error field describes the failure.
  • canceled: The task was canceled. No result is available. The error field describes the cancellation reason, if available.

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

get/analyze/tasks/{task_id}

Request

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

Path parameters

task_idstring required

The unique identifier of the analysis task.

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.

batch_idstring

The unique identifier of the batch that the task was created in. The platform returns this field only for tasks created as part of a batch.

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

The current status of the analysis task. The ready, failed, and canceled statuses are final.

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 completed, failed, or was canceled. The platform returns this field only if status is ready, failed, or canceled.

Changes

  • 8b021f9a1426Revision changes
    • breaking

      added subschema #2 to the // response property oneOf list for the response status

    • breaking

      the // response's property type changed from integer null to no type for 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

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

    • info

      the response property ///////// became required for the status

  • 69c273061729Revision changes
    • warning

      added the new canceled enum value to the response property for the response status

    • warning

      added the new video_id 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

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