API referenceBatch
Submit a batch job
Fire-and-forget bulk processing of up to 1000 URL-only photos. (POST /v1/batches)
POST
/v1/batches- Auth
- Bearer API key
Fire-and-forget bulk processing of up to 1000 URL-only photos.
base64 is rejected in batch — use real-time endpoints for inline images.
Results arrive per-photo via your registered webhook, or poll
GET /v1/batches/{id}.
Example request
curl -X POST "https://api.sightradar.com/v1/batches" \
-H "Authorization: Bearer $SR_API_KEY" \
-H "Content-Type: application/json" \
-d '{"collection_id":"event-2026","op":"index","photos":[{"url":"https://example.com/photo.jpg","external_id":"photo-1"}]}'Request body (application/json)
| Field | Type | Description |
|---|---|---|
collection_id required | string | |
op required | "index" | "match" | |
webhook_endpoint_id | string | Optional; an endpoint id from POST /v1/webhooks. |
photos required | object[] |
Response body
| Field | Type | Description |
|---|---|---|
batch_id | string | |
total_photos | integer | |
status | string | |
message | string |
Status codes
| Status | Meaning |
|---|---|
202 | Batch accepted. |
400 | Validation error (missing fields, base64 in batch, too large). |
401 | Missing or invalid API key. |
Last updated