Skip to content

Bulk Operations

For high-throughput workloads, batch multiple writes into a single request instead of issuing one request per record.

Bulk create

POST /v1/buckets/my-first-bucket/records:batch
Request body
{
  "records": [
    { "name": "record-1", "value": 1 },
    { "name": "record-2", "value": 2 },
    { "name": "record-3", "value": 3 }
  ]
}
Response
{
  "succeeded": 2,
  "failed": 1,
  "results": [
    { "name": "record-1", "status": "created" },
    { "name": "record-2", "status": "created" },
    { "name": "record-3", "status": "error", "error": { "code": "conflict", "message": "already exists" } }
  ]
}

Bulk requests are partial-failure tolerant — one bad record doesn't fail the whole batch.

Limits

Limit Value
Max records per batch 500
Max request body size 5 MB
  • Validate payload size client-side before sending
  • Handle partial failures from results
  • Assume the whole batch succeeded just because the request returned 200

Warning

A 200 response does not mean every record succeeded — always check failed and inspect results.