Batch Classify Files
Submit up to 1,000 files for classification in a single request. Each file is processed as an independent classify run using the same classifier and configuration.
Unlike the single Classify File (Async) endpoint, this batch endpoint accepts an inputs array and immediately returns a BatchRun object containing a batch id and a PENDING status. The individual runs are then queued and processed asynchronously.
Monitoring results:
- Webhooks (recommended): Subscribe to
batch_processor_run.processedandbatch_processor_run.failedevents. The webhook payload indicates the batch has finished — fetch individual run results usingGET /classify_runs?batchId={id}. - Polling: Call
GET /batch_runs/{id}to check the overall batch status, and useGET /classify_runsfiltered bybatchIdto retrieve individual run results.
Notes:
- A processor reference (
classifier.id) is required — inlineconfigis not supported for batch requests. inputsmust contain between 1 and 1,000 items.- All inputs in a batch use the same classifier version and override config.
Authentication
Bearer authentication of the form Bearer <token>, where token is your auth token.
Headers
API version to use for the request. If you’re using an SDK, you can ignore this parameter. If you are not using an SDK and do not specify a version, you will either receive a 400 Bad Request or be set to a previous legacy version. See API Versioning for more details.
Request
Response
The type of object. Always "batch_run".
The unique identifier for this batch run.
Example: "bpr_Xj8mK2pL9nR4vT7qY5wZ"
The status of a batch run:
"PENDING"- The batch has been created and is waiting to be processed"PROCESSING"- The batch is currently being processed"PROCESSED"- All runs in the batch have completed successfully"FAILED"- The batch failed to process"CANCELLED"- The batch was cancelled
The time (in UTC) at which the object was created. Will follow the RFC 3339 format.
Example: "2024-03-21T16:45:00Z"

