Get Batch Status
Get status and counters for a batch call operation
Headers
x-workspace-idstringrequiredWorkspace identifier for the API.
Path Parameters
batchIdstringrequiredThe 10-character batch ID returned by Start Batch Calls.
Live tracking for a batch is kept for 7 days. After that, a batch that already ran returns 404 Batch not found. Use Call History filtered by batchId, or GET /v1/api/batch-history/batch/{batchId}, for older batches. A scheduled batch that hasn't started yet is always found.
Response
existsbooleanAlways true on a 200 response.
batchIdstringThe batch ID.
statusstringStatus worked out from the counters:
scheduled- The batch has a future start time and no calls have been queued yetqueued- Calls are waiting and none has completed yetprocessing- Calls are being placedcompleted- Nothing is waiting or active, and every job completed or failedfailed- Nothing is waiting or active, and every job failed
countersobjectJob counters for the batch.
timestampnumberTime this status was read, in Unix milliseconds.
progressobjectThe same object Get Batch Progress returns: batchId, total, completed, failed, waiting, active, progress (percent completed, 0-100) and lastUpdated (Unix milliseconds).
scheduledAtstringScheduled batches only. Start time as an ISO 8601 string.
scheduledTimezonestring | nullScheduled batches only. The scheduledTimezone sent when the batch was created, or null.
timezonestring | nullScheduled batches only. The call flow's office-hours timezone.
Example Usage
curl -X GET "https://api.trillet.ai/v1/api/batch-calls/k3j9x0a1bq" \
-H "x-api-key: YOUR_API_KEY" \
-H "x-workspace-id: YOUR_WORKSPACE_ID"
Example Response
{
"exists": true,
"batchId": "k3j9x0a1bq",
"status": "processing",
"counters": {
"waiting": 45,
"active": 5,
"completed": 95,
"failed": 5,
"total": 150
},
"timestamp": 1793284800000,
"progress": {
"batchId": "k3j9x0a1bq",
"total": 150,
"completed": 95,
"failed": 5,
"waiting": 45,
"active": 5,
"progress": 63,
"lastUpdated": 1793284800000
}
}
Example Response (scheduled)
{
"exists": true,
"batchId": "p8d2m4t7zs",
"status": "scheduled",
"scheduledAt": "2026-11-15T14:30:00.000Z",
"scheduledTimezone": "America/New_York",
"timezone": "America/New_York",
"counters": { "waiting": 0, "active": 0, "completed": 0, "failed": 0, "total": 150 },
"timestamp": 1793284800000,
"progress": {
"batchId": "p8d2m4t7zs",
"total": 0,
"completed": 0,
"failed": 0,
"waiting": 0,
"active": 0,
"progress": 0,
"lastUpdated": 1793284800000
}
}
Error Responses
errorstringError message describing what went wrong
messagestringAdditional context about the error
idstringThe batch ID that was not found (on some 404 responses)
Common Error Codes:
404-Batch not found: the batch doesn't exist, belongs to another workspace, or its 7-day tracking window has passed500- Server error retrieving batch information
Status Monitoring
Poll this endpoint to follow a running batch. For per-call outcomes, transcripts and analysis, use Call History filtered by batchId.
Last updated on