Get a batch
⚠️
Preview — this feature is being built; the design below is the spec.
GET https://app.syntic.ai/v1/batches/{batch_id}Return a batch’s status and counts. Poll it every minute or so, or register a webhook for batch.completed and skip polling.
For how this fits into a full workflow, see Batches.
Headers
| Header | Required | Value |
|---|---|---|
Authorization | Yes | Bearer <key>: a private inference key (sk_live_...). See Authentication. |
Path parameters
| Parameter | Type | Description |
|---|---|---|
batch_id | string | The batch id, starting with batch_. |
Response
200 OK, Content-Type: application/json
{
"id": "batch_01JBXF3P8K",
"object": "batch",
"status": "in_progress",
"input_file_id": "file_01JBXF1Z",
"output_file_id": null,
"error_file_id": null,
"request_counts": {
"total": 5000,
"succeeded": 3120,
"failed": 4,
"canceled": 0
},
"created_at": 1791820800,
"started_at": 1791820860,
"ends_by": 1791907200,
"completed_at": null,
"metadata": {
"job": "october-tickets"
}
}| Field | Type | Description |
|---|---|---|
id | string | Starts with batch_. |
object | string | Always batch. |
status | string | validating, in_progress, canceling, completed, expired, canceled or failed. |
input_file_id | string or null | The input file, or null for an inline batch. |
output_file_id | string or null | Results file, set once the batch reaches a final state with any finished lines. |
error_file_id | string or null | Set when validation found problems; lists them by line. |
request_counts | object | total, succeeded, failed and canceled. |
created_at | integer | Unix seconds. |
started_at | integer or null | When the first request started. |
ends_by | integer | The end of the 24-hour window. |
completed_at | integer or null | When the batch reached a final state. |
metadata | object | Your string pairs, returned unchanged. |
Examples
curl -sS https://app.syntic.ai/v1/batches/batch_01JBXF3P8K \
-H "Authorization: Bearer $SYNTIC_API_KEY"Errors
Errors use the error envelope and carry a request_id. Codes specific to this operation:
| Status | type | code | When |
|---|---|---|---|
| 404 | not_found_error | batch_not_found | Unknown id or another workspace’s batch. |
| 401 | authentication_error | invalid_api_key | The key is missing, unknown, revoked or expired. |
| 429 | rate_limit_error | rate_limited | Too many requests; wait for Retry-After. See Rate-limit headers. |
Collecting results
When status is completed, expired or canceled, download output_file_id with Download file content. Lines arrive in any order; match them by custom_id. Only lines whose result.type is succeeded are billed.
Related
Was this page helpful?