List batches | TwelveLabs

curl -G https://api.twelvelabs.io/v1.3/analyze/batches \
     -H "x-api-key: <apiKey>" \
     -d status=processing \
     -d status=canceling \
     -d analysis_mode=general \
     -d analysis_mode=time_based_metadata

{
  "data": [
    {
      "analysis_mode": "general",
      "batch_id": "68f4ddaf8aaa60d33df0e800",
      "canceled_items": 0,
      "created_at": "2026-05-15T10:00:00Z",
      "expires_at": "2026-05-16T10:00:00Z",
      "failed_items": 0,
      "model_name": "pegasus1.5",
      "processing_items": 20,
      "queued_items": 30,
      "ready_items": 50,
      "status": "processing",
      "total_items": 100
    },
    {
      "analysis_mode": "time_based_metadata",
      "batch_id": "68f4ddaf8aaa60d33df0e7ff",
      "canceled_items": 0,
      "created_at": "2026-05-14T08:30:00Z",
      "expires_at": "2026-05-15T08:30:00Z",
      "failed_items": 2,
      "model_name": "pegasus1.5",
      "processing_items": 0,
      "queued_items": 0,
      "ready_items": 48,
      "status": "completed",
      "total_items": 50,
      "completed_at": "2026-05-14T11:42:13Z"
    }
  ],
  "page_info": {
    "limit_per_page": 10,
    "page": 1,
    "total_page": 1,
    "total_results": 2
  }
}

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

Authentication

x-api-keystring

Your API key.

Note

You can find your API key on the API Keys page.

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.

statuslist of enumsOptional

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.

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_modelist of enumsOptional

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.

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.

Allowed values:

Response

A list of batch objects.

datalist of objects

An array of batch objects. Each object includes item counts for each item status.

page_infoobject

An object that provides information about pagination.

Errors

400

Bad Request Error