Sign in

v5

latestOpenAPI 3.1.02026-08-025631,1012.8 MB
Bucket Objects

Create Objects in Batch

This endpoint creates multiple new objects in the specified bucket as a batch. Each object must conform to the bucket's schema.

**Processing**: By default, objects are created in DRAFT status and require
batch submission for processing. Set `auto_process=true` to automatically
create a processing batch and submit it (zero-touch workflow).

**Partial Success**: This endpoint uses partial success - valid objects are created
even if some fail validation. Failed objects are returned separately with error details,
allowing you to fix and retry only the failed ones.

**Response**: Returns both succeeded and failed objects. The batch succeeds (200 OK) as long
as at least one object is created. Check the `failed` array for objects that need attention.
post/v1/buckets/{bucket_identifier}/objects/batch

Path parameters

bucket_identifierstring required

The unique identifier of the bucket.

The unique identifier of the bucket.

Query parameters

auto_processboolean

Automatically create a batch and submit it for processing. When true, all successfully created objects will be immediately queued for processing without requiring separate batch calls. Ideal for onboarding and bulk upload workflows.

Automatically create a batch and submit it for processing. When true, all successfully created objects will be immediately queued for processing without requiring separate batch calls. Ideal for onboarding and bulk upload workflows.

Request body

Example request

{
  "objects": [
    {
      "blobs": [
        {
          "data": {
            "num_pages": 5,
            "title": "Service Agreement 2024"
          },
          "key_prefix": "/contract-2024/content.pdf",
          "metadata": {
            "author": "John Doe",
            "department": "Legal"
          },
          "property": "content",
          "type": "json"
        }
      ],
      "key_prefix": "/documents",
      "metadata": {
        "category": "contracts",
        "status": "draft",
        "year": 2024
      }
    }
  ]
}

Response

Successful Response

total_requestedinteger required

Total number of objects in the batch request

succeeded_countinteger required

Number of objects successfully created

failed_countinteger required

Number of objects that failed

Example response

{
  "failed": [
    {
      "error": "Schema validation failed: Missing required field 'title'",
      "error_type": "ValidationError",
      "object_index": 15
    }
  ],
  "failed_count": 1,
  "succeeded": [
    {
      "bucket_id": "bkt_9xy8z7",
      "object_id": "obj_123abc",
      "status": "DRAFT"
    }
  ],
  "succeeded_count": 99,
  "total_requested": 100
}