/v1/capture-batches/{id}/files

​

Path Parameters

Headers

  • Any unique string of 1 to 255 printable characters, such as a UUID. A create without it is refused with 400. The same key and request within 30 days answers with the first response and creates nothing.

Body

required
application/json
  • Integer numbers.

Responses

  • application/json
  • application/json
  • application/json
  • application/json
  • application/json
  • application/json
  • application/json
  • application/json
  • application/json
  • application/json
Request Example for post/v1/capture-batches/{id}/files
curl /v1/capture-batches/bat_0196f2a0-4c1e-7a00-8000-000000000001/files \
  --request POST \
  --header 'idempotency-key: 0b8a3f5e-1c2d-4e6f-8a9b-7c6d5e4f3a2b' \
  --header 'Content-Type: application/json' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN' \
  --data '{
  "byteSize": 182344,
  "mediaType": "image/jpeg",
  "sha256": "9f2c4e1a7b3d5f6e8a0c2e4f6a8b0d2f4e6a8c0e2f4a6b8d0f2e4a6c8e0a2b4d"
}'
{
  "file": {
    "byteSize": 182344,
    "createdAt": "2026-03-02T09:30:00.000Z",
    "id": "fil_0196f2a0-4c1e-7a00-8000-000000000001",
    "mediaType": "image/jpeg",
    "object": "file",
    "pageCount": null,
    "pageStatus": "waiting",
    "scanStatus": "pending",
    "sha256": "9f2c4e1a7b3d5f6e8a0c2e4f6a8b0d2f4e6a8c0e2f4a6b8d0f2e4a6c8e0a2b4d"
  },
  "upload": {
    "expiresAt": "2026-03-02T09:45:00.000Z",
    "headers": {
      "content-type": "image/jpeg"
    },
    "method": "PUT",
    "url": "https://uploads.example.test/fil_0196f2a0?signature=synthetic"
  }
}