Batch Confirm Uploads

curl --request POST \
  --url https://api.mixpeek.com/v1/buckets/{bucket_identifier}/uploads/confirm/batch \
  --header 'Authorization: <authorization>' \
  --header 'Content-Type: application/json' \
  --header 'X-Namespace: <x-namespace>' \
  --data '
{
  "confirmations": [
    {}
  ]
}
'

{
  "task_id": "<string>",
  "status": "PENDING",
  "confirmations_count": 123,
  "task": {
    "task_id": "<string>",
    "task_type": "api_namespaces_create",
    "status": "PENDING",
    "inputs": [
      "batch_xyz789"
    ],
    "outputs": [
      "document_123",
      "document_456"
    ],
    "additional_data": {
      "batch_id": "btch_xyz789",
      "bucket_id": "bkt_products",
      "collection_ids": [
        "col_tier0",
        "col_tier1",
        "col_tier2"
      ],
      "current_tier": 1,
      "job_id": "ray_job_123",
      "namespace_id": "ns_abc123",
      "object_count": 10000,
      "sample_object_ids": [
        "obj_001",
        "obj_002",
        "obj_003",
        "obj_004",
        "obj_005"
      ],
      "total_tiers": 3
    },
    "error": "Failed to process batch: Object not found"
  },
  "message": "Batch confirmation is being processed in the background."
}

POST

buckets

{bucket_identifier}

uploads

confirm

batch

Batch Confirm Uploads

curl --request POST \
  --url https://api.mixpeek.com/v1/buckets/{bucket_identifier}/uploads/confirm/batch \
  --header 'Authorization: <authorization>' \
  --header 'Content-Type: application/json' \
  --header 'X-Namespace: <x-namespace>' \
  --data '
{
  "confirmations": [
    {}
  ]
}
'

{
  "task_id": "<string>",
  "status": "PENDING",
  "confirmations_count": 123,
  "task": {
    "task_id": "<string>",
    "task_type": "api_namespaces_create",
    "status": "PENDING",
    "inputs": [
      "batch_xyz789"
    ],
    "outputs": [
      "document_123",
      "document_456"
    ],
    "additional_data": {
      "batch_id": "btch_xyz789",
      "bucket_id": "bkt_products",
      "collection_ids": [
        "col_tier0",
        "col_tier1",
        "col_tier2"
      ],
      "current_tier": 1,
      "job_id": "ray_job_123",
      "namespace_id": "ns_abc123",
      "object_count": 10000,
      "sample_object_ids": [
        "obj_001",
        "obj_002",
        "obj_003",
        "obj_004",
        "obj_005"
      ],
      "total_tiers": 3
    },
    "error": "Failed to process batch: Object not found"
  },
  "message": "Batch confirmation is being processed in the background."
}

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.

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'

Path Parameters

bucket_identifier

string

required

The unique identifier of the bucket

Body

application/json

Request to confirm multiple uploads in batch.

confirmations

Confirmations · object[]

required

List of confirmations with upload_id, etag, file_size_bytes

Required array length: 1 - 100 elements

Response

Successful Response

Response from batch confirmation.

task_id

string

required

Task ID for tracking batch confirmation progress

status

enum<string>

required

Task status

Available options:

PENDING,

IN_PROGRESS,

PROCESSING,

COMPLETED,

COMPLETED_WITH_ERRORS,

FAILED,

CANCELED,

UNKNOWN,

SKIPPED,

DRAFT,

ACTIVE,

ARCHIVED,

SUSPENDED

confirmations_count

integer

required

Number of confirmations being processed

task

TaskResponse · object

required

Full task details

Show child attributes

task.task_id

string

required

Unique identifier for the task. REQUIRED. Used to poll task status via GET /v1/tasks/{task_id}. This ID is also stored on parent resources (batches, clusters, etc.) for cross-referencing. Format: UUID v4 or custom string identifier.

task.task_type

enum<string>

required

Type of operation this task represents. REQUIRED. Identifies the specific async operation being performed. Used for filtering and categorizing tasks. Common types: api_buckets_batches_process, engine_cluster_build, api_taxonomies_execute. See TaskType enum for complete list of supported operations.

Available options:

api_namespaces_create,

api_namespaces_migrations_run,

api_buckets_objects_create,

api_buckets_delete,

api_buckets_batches_process,

api_buckets_batches_submit,

api_buckets_uploads_create,

api_buckets_uploads_confirm,

api_buckets_uploads_batch_confirm,

api_taxonomies_create,

api_taxonomies_execute,

api_taxonomies_materialize,

api_evaluations_run,

api_evaluations_dataset_create,

engine_feature_extractor_run,

engine_inference_run,

engine_object_processing,

engine_cluster_build,

thumbnail,

video_segment,

materialize

task.status

enum<string>

required

Current status of the task. REQUIRED. Indicates the current state of the async operation. Terminal statuses (COMPLETED, FAILED, CANCELED) indicate the task has finished and will not change. Active statuses (PENDING, IN_PROGRESS, PROCESSING) indicate the task is still running and should be polled. Use this field to determine when to stop polling.

Available options:

PENDING,

IN_PROGRESS,

PROCESSING,

COMPLETED,

COMPLETED_WITH_ERRORS,

FAILED,

CANCELED,

UNKNOWN,

SKIPPED,

DRAFT,

ACTIVE,

ARCHIVED,

SUSPENDED

task.inputs

(string | object)[] | null

Input parameters or data used to start the task. OPTIONAL. May include IDs, configuration objects, or file references. Useful for debugging and understanding what data the task processed. Format: List of strings (IDs) or objects (configuration). Example: ['batch_id_123'] or [{'bucket_id': 'bkt_abc', 'config': {...}}]

Example:

["batch_xyz789"]

task.outputs

(string | object)[] | null

Output results produced by the task. OPTIONAL. Populated when task completes successfully. May include processed file IDs, result metrics, or status summaries. Check this field after task reaches COMPLETED status to get results. Format: List of strings (output IDs) or objects (result data).

Example:

["document_123", "document_456"]

task.additional_data

Additional Data · object

Additional metadata and context for the task. OPTIONAL. Contains job IDs, error details, progress info, and other task-specific metadata.

Common fields (all task types): - 'error': Error message if task failed - 'job_id': Ray job ID for engine tasks - 'from_mongodb': True if retrieved from MongoDB fallback (not Redis)

Batch-specific fields (task_type=api_buckets_batches_process): - 'batch_id': Batch identifier (REQUIRED) - 'bucket_id': Source bucket identifier (REQUIRED) - 'namespace_id': Namespace identifier (REQUIRED) - 'current_tier': Currently processing tier number, 0-indexed (OPTIONAL, None if not started) - 'total_tiers': Total number of tiers in the batch pipeline (REQUIRED) - 'collection_ids': Array of ALL collection IDs across all tiers (REQUIRED) - 'object_count': Number of objects being processed (REQUIRED) - 'sample_object_ids': First 5 object IDs for debugging/display (OPTIONAL)

Performance Note: Full object_ids array is NOT stored in task metadata to avoid bloating task documents (batches with 10k+ objects would add 200KB+ per task). For full object list, query the batch directly via GET /v1/buckets/{bucket_id}/batches/{batch_id}.

Note: For detailed per-tier status, use GET /v1/buckets/{bucket_id}/batches/{batch_id} to access the tier_tasks[] array which contains individual tier statuses, collection_ids, and timestamps for each tier.

Example:

{
  "batch_id": "btch_xyz789",
  "bucket_id": "bkt_products",
  "collection_ids": ["col_tier0", "col_tier1", "col_tier2"],
  "current_tier": 1,
  "job_id": "ray_job_123",
  "namespace_id": "ns_abc123",
  "object_count": 10000,
  "sample_object_ids": [
    "obj_001",
    "obj_002",
    "obj_003",
    "obj_004",
    "obj_005"
  ],
  "total_tiers": 3
}

task.error

string | null

Flattened error message for convenient error handling. OPTIONAL. Automatically populated from additional_data['error'] when the task has FAILED status. This is a convenience field - the full error details are always available in additional_data['error']. Use this field for displaying errors to users or logging. Will be None if task has not failed or if no error details are available. Serialized as 'error' in API responses for backward compatibility.

Example:

"Failed to process batch: Object not found"

message

string

default:Batch confirmation is being processed in the background.

Status message

Confirm Upload List Uploads

⌘I

Health

Namespaces

Buckets

Feature Extractors

Collections

Retrievers

Taxonomies

Clusters

Analytics

Tasks

Webhooks

Batch Confirm Uploads

Headers

Path Parameters

Body

Response