Sign in

v3

latestOpenAPI 3.1.02026-07-3197486526.1 KB
analyzeAsync > batches

List batches

Use this method to list all the batch objects in your account. The response sorts batches by creation date, with the newest batch first.

get/analyze/batches

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.

statusBatchStatus[]

Filter batches by status. Provide one or more values to include batches matching any of them. To send multiple values, repeat the status parameter:

status=processing&status=canceling

If you omit this parameter, the response includes batches in all statuses.

analysis_modeAnalyzeBatchesGetParametersAnalysisModeSchemaItems[]

Filter batches by analysis mode. Provide one or more values to include batches matching any of them. To send multiple values, repeat the analysis_mode parameter:

analysis_mode=general&analysis_mode=time_based_metadata

If you omit this parameter, the response includes batches in all analysis modes.

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 batch objects.