List batches

GET

https://api.twelvelabs.io/v1.3/analyze/batches

GET

/v1.3/analyze/batches

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": [
    {
      "batch_id": "68f4ddaf8aaa60d33df0e800",
      "analysis_mode": "general",
      "model_name": "pegasus1.5",
      "status": "processing",
      "total_items": 100,
      "created_at": "2026-05-15T10:00:00Z",
      "expires_at": "2026-05-16T10:00:00Z",
      "queued_items": 30,
      "processing_items": 20,
      "ready_items": 50,
      "failed_items": 0,
      "canceled_items": 0
    },
    {
      "batch_id": "68f4ddaf8aaa60d33df0e7ff",
      "analysis_mode": "time_based_metadata",
      "model_name": "pegasus1.5",
      "status": "completed",
      "total_items": 50,
      "created_at": "2026-05-14T08:30:00Z",
      "expires_at": "2026-05-15T08:30:00Z",
      "queued_items": 0,
      "processing_items": 0,
      "ready_items": 48,
      "failed_items": 2,
      "canceled_items": 0,
      "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.

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.

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.

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