v3

latestOpenAPI 3.1.02026-07-3197486526.1 KB
analyzeAsync > tasks

List async analysis tasks

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

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'

The current status of the analysis task.

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

video_urlstring uri

Filter tasks by exact video source URL.

asset_idstring

Filter tasks by asset ID.

video_idstring

Filter tasks by video ID for pre-indexed videos (Pegasus 1.2 only). Deprecated — use asset_id instead.

analysis_mode'general' | 'time_based_metadata'

Filter tasks by the analysis mode used when creating the 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

A list of analysis tasks.