API ReferenceAnalyze videos

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.

Authentication

x-api-keystring
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>

Query parameters

pageintegerOptionalDefaults to 1

A number that identifies the page to retrieve.

Default: 1.

page_limitintegerOptionalDefaults to 10

The number of items to return on each page.

Default: 10. Max: 50.

statusenumOptional

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

Allowed values:

Response

A list of analysis tasks has successfully been retrieved.
datalist of objects

An array that contains up to page_limit analysis tasks.

page_infoobject
An object that provides information about pagination.

Errors

400
Bad Request Error