Skip to main content
GET
/
v1
/
buckets
/
{bucket_identifier}
/
batches
/
{batch_id}
Get Batch
curl --request GET \
  --url https://api.mixpeek.com/v1/buckets/{bucket_identifier}/batches/{batch_id} \
  --header 'Authorization: Bearer <token>' \
  --header 'X-Namespace: <x-namespace>'
{
  "batch_id": "batch_123",
  "bucket_id": "<string>",
  "status": "DRAFT",
  "object_ids": [
    "object_123",
    "object_456"
  ],
  "collection_ids": [
    "col_123",
    "col_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": {},
  "metadata": {},
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z"
}

Authorizations

​
Authorization
string
header
required

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.

Headers

​
Authorization
string
required

REQUIRED: Bearer token authentication using your API key. Format: 'Bearer sk_xxxxxxxxxxxxx'. You can create API keys in the Mixpeek dashboard under Organization Settings.

Examples:

"Bearer sk_live_abc123def456"

"Bearer sk_test_xyz789"

​
X-Namespace
string
required

REQUIRED: Namespace identifier for scoping this request. All resources (collections, buckets, taxonomies, etc.) are scoped to a namespace. You can provide either the namespace name or namespace ID. Format: ns_xxxxxxxxxxxxx (ID) or a custom name like 'my-namespace'

Examples:

"ns_abc123def456"

"production"

"my-namespace"

Path Parameters

​
bucket_identifier
string
required

The unique identifier of the bucket.

​
batch_id
string
required

The unique identifier of the batch.

Response

Successful Response

The base model for a batch.

​
bucket_id
string
required

The unique identifier of the bucket.

​
batch_id
string

The unique identifier of the batch.

Examples:

"batch_123"

​
status
enum<string>

The current status of the batch.

Available options:
PENDING,
IN_PROGRESS,
PROCESSING,
COMPLETED,
FAILED,
CANCELED,
UNKNOWN,
SKIPPED,
DRAFT,
ACTIVE,
ARCHIVED,
SUSPENDED
​
object_ids
string[]

A list of object IDs included in the batch.

Examples:
["object_123", "object_456"]
​
collection_ids
string[] | null

A list of collection IDs that this batch is connected to for processing.

Examples:
["col_123", "col_456"]
​
error
string | null

The error message if the batch failed to process.

Examples:

"Failed to process batch: Object not found"

​
type
enum<string>

The type of the batch.

Available options:
BUCKET,
COLLECTION
​
manifest_key
string | null

The S3 manifest key for the batch.

Examples:

"s3://bucket/manifest.json"

​
task_id
string | null

The task ID of the batch.

Examples:

"task_123"

​
loaded_object_ids
string[] | null

A list of object IDs that were successfully loaded into the batch.

​
internal_metadata
object | null

Internal engine/job metadata (e.g., job_id for provider).

​
metadata
object

Additional user-defined metadata for the batch.

​
created_at
string<date-time>

Timestamp when the batch was created.

​
updated_at
string<date-time>

Timestamp when the batch was last updated.