POST
/
v1
/
buckets
/
{bucket_identifier}
/
batches
/
list
List Batches
curl --request POST \
  --url https://api.mixpeek.com/v1/buckets/{bucket_identifier}/batches/list \
  --header 'Content-Type: application/json' \
  --data '{
  "offset": 0,
  "limit": 100
}'
{
  "batches": [
    {
      "batch_id": "batch_123",
      "bucket_id": "<string>",
      "status": "DRAFT",
      "object_ids": [
        "object_123",
        "object_456"
      ],
      "error": "Failed to process batch: Object not found",
      "type": "BUCKET",
      "manifest_key": "s3://bucket/manifest.json",
      "task_id": "task_123",
      "loaded_object_ids": [
        "<string>"
      ],
      "internal_metadata": {}
    }
  ],
  "total_count": 123
}

Headers

​
Authorization
string | null

Bearer token authentication using your API key. Format: 'Bearer your_api_key'. To get an API key, create an account at mixpeek.com/start and generate a key in your account settings. Example: 'Bearer sk_1234567890abcdef'

​
X-Namespace
string | null

Optional namespace for data isolation. This can be a namespace name or namespace ID. Example: 'netflix_prod' or 'ns_1234567890'. To create a namespace, use the /namespaces endpoint.

Path Parameters

​
bucket_identifier
string
required

The unique identifier of the bucket.

Body

application/json

The request model for listing batches.

​
status
enum<string> | null

Filter batches by status. Enumeration of task statuses.

Available options:
PENDING,
IN_PROGRESS,
PROCESSING,
COMPLETED,
FAILED,
CANCELED,
UNKNOWN,
SKIPPED,
DRAFT
​
offset
integer
default:0

The number of batches to skip.

Required range: x >= 0
​
limit
integer
default:100

The maximum number of batches to return.

Required range: 1 <= x <= 1000

Response

Successful Response

The response model for listing batches.

​
batches
BatchModel · object[]
required

A list of batches.

​
total_count
integer
required

The total number of batches found.