Bucket Uploads

Batch Confirm Uploads

Changed on

Confirm multiple uploads in a single request (processed asynchronously).

Maximum 100 confirmations per batch.
All uploads must belong to the same bucket.

Returns a task_id to track progress via GET /v1/tasks/{task_id}.
post/v1/buckets/{bucket_identifier}/uploads/confirm/batch

Request

  • Base URL: https://api.mixpeek.com
  • URL: https://api.mixpeek.com/v1/buckets/{bucket_identifier}/uploads/confirm/batch
  • Auth: HTTP bearer and API key in header X-Namespace

Path parameters

bucket_identifierstring required

The unique identifier of the bucket

Query parameters

policy'insert' | 'update' | 'upsert' nullable

Insertion policy for unique key enforcement on the object created at confirmation. Valid values: 'insert', 'update', 'upsert'. Only applies if the bucket has a unique_key. Overrides the bucket's default_policy, matching ?policy= on POST /objects. Required when the bucket has a unique_key and no default_policy.

Example:insert

Request body

confirmationsobject[] required

List of confirmations with upload_id, etag, file_size_bytes

Example request

{
  "confirmations": [
    {
      "etag": "d41d8cd98f00b204e9800998ecf8427e",
      "file_size_bytes": 10485760,
      "upload_id": "upl_abc123"
    },
    {
      "etag": "7f9c12ab56f4e12d80cf8d98fe12c4a9",
      "file_size_bytes": 5242880,
      "upload_id": "upl_def456"
    }
  ]
}

Response

Successful Response

task_idstring required

Task ID for tracking batch confirmation progress

status'PENDING' | 'QUEUED' | 'IN_PROGRESS' | 'PROCESSING' | 'COMPLETED' | 'COMPLETED_WITH_ERRORS' | 'FAILED' | 'CANCELED' | 'INTERRUPTED' | 'UNKNOWN' | 'SKIPPED' | 'DRAFT' | 'ACTIVE' | 'ARCHIVED' | 'SUSPENDED' | 'DEACTIVATED' required

Enumeration of task statuses for tracking asynchronous operations.

Task statuses indicate the current state of asynchronous operations like batch processing, object ingestion, clustering, and taxonomy execution.

Status Categories: Operation Statuses: Track progress of async operations Lifecycle Statuses: Track entity state (buckets, collections, namespaces)

Values: PENDING: Task is queued but has not started processing yet IN_PROGRESS: Task is currently being executed PROCESSING: Task is actively processing data (similar to IN_PROGRESS) COMPLETED: Task finished successfully with no errors COMPLETED_WITH_ERRORS: Task finished but some items failed (partial success) FAILED: Task encountered an error and could not complete CANCELED: Task was manually canceled by a user or system UNKNOWN: Task status could not be determined SKIPPED: Task was intentionally skipped DRAFT: Task is in draft state and not yet submitted

ACTIVE: Entity is active and operational (for buckets, collections, etc.)
ARCHIVED: Entity has been archived
SUSPENDED: Entity has been temporarily suspended

Terminal Statuses: COMPLETED, COMPLETED_WITH_ERRORS, FAILED, CANCELED are terminal statuses. Once a task reaches these states, it will not transition to another state.

Partial Success Handling: COMPLETED_WITH_ERRORS indicates that the operation completed but some documents/items failed. The task result includes: - List of successful items - List of failed items with error details - Success rate percentage This allows clients to handle partial success scenarios appropriately.

Polling Guidance: - Poll tasks in PENDING, QUEUED, IN_PROGRESS, or PROCESSING states - Stop polling when task reaches COMPLETED, COMPLETED_WITH_ERRORS, FAILED, or CANCELED - Use exponential backoff (1s → 30s) when polling

confirmations_countinteger required

Number of confirmations being processed

messagestring

Status message

Example response

{
  "task": {
    "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
    },
    "description": "Multi-tier batch processing task in progress (tier 1 of 3) with 10k objects",
    "inputs": [
      "batch_xyz789"
    ],
    "status": "IN_PROGRESS",
    "task_id": "2d322a05-3178-4eca-aac6-b82b0a0313aa",
    "task_type": "api_buckets_batches_process"
  }
}

Changes

  • 61a175e8eb9aRevision changes
    • warning

      removed the optional property from the response with the status

    • info

      added the non-success response with the status

    • info

      added the non-success response with the status

    • info

      added the optional property to the response with the status

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status

  • b75474e978ffRevision changes
    • warning

      added the new api_manifest_apply enum value to the / response property for the response status