analyzeAsync > tasks

List async analysis tasks

Changed on

This method returns a list of the analysis tasks in your account. The platform returns your analysis tasks sorted by creation date, with the newest at the top of the list.

get/analyze/tasks

Request

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

Query parameters

pageinteger

A number that identifies the page to retrieve.

Default: 1.

page_limitinteger

The number of items to return on each page.

Default: 10. Max: 50.

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

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

Filter analysis tasks by status. Possible values: queued, pending, processing, ready, failed, canceled.

video_urlstring uri

Filter tasks by exact video source URL.

asset_idstring

Filter tasks by asset ID.

analysis_mode'general' | 'time_based_metadata'

Filter tasks by the analysis mode used when creating the task.

Response

A list of analysis tasks.

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 new enum value canceled to the query request parameter 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