API Reference
Batches
Upload scanned PDFs and track their processing progress. Each batch is split into individual letters, classified by AI, and matched to client records automatically.
Upload limits
Maximum file size: 100 MB. Maximum pages per batch: 500. Uploads use resumable chunked transfer — use the X-Upload-Id header for resumable sessions on large files.
GET
/batchesList all batches with status and progress information.
Auth: Bearer token
| Parameter | Type | Description |
|---|---|---|
| status | string | Filter by status: pending, processing, completed, failed |
| page | integer | Page number (default: 1) |
| limit | integer | Results per page (default: 20, max: 100) |
GET
/batches/:idGet a single batch including page count, OCR progress, and extracted letters.
Auth: Bearer token
POST
/batchesCreate a new batch by uploading a PDF. Use multipart/form-data with a 'file' field. Maximum 100 MB.
Auth: Bearer token
| Parameter | Type | Description |
|---|---|---|
| file | File (PDF) | The scanned PDF to process (required) |
GET
/batches/:id/lettersList all letters extracted from a specific batch.
Auth: Bearer token
| Parameter | Type | Description |
|---|---|---|
| page | integer | Page number (default: 1) |
| limit | integer | Results per page (default: 20, max: 100) |