batch_get_status
Check the status of batch jobs and monitor progress through completion states. Use auto-polling to wait for job completion and receive current state, progress statistics, and completion information.
Instructions
GET BATCH JOB STATUS - Check status of running batch job with optional auto-polling. STATES: PENDING (queued), RUNNING (processing), SUCCEEDED (complete), FAILED (error), CANCELLED (user stopped), EXPIRED (timeout). WORKFLOW: 1) Call with batch job name/ID, 2) Optionally enable polling to wait for completion, 3) Returns current state, progress stats, and completion info. USAGE: Pass job name from batch_create response. Enable autoPoll for hands-off waiting.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| batchName | Yes | Batch job name/ID from batch_create | |
| autoPoll | No | Automatically poll until job completes (SUCCEEDED, FAILED, or CANCELLED) | |
| pollIntervalSeconds | No | Seconds between status checks when autoPoll=true (default: 30) | |
| maxWaitMs | No | Maximum wait time in milliseconds (default: 24 hours) |
Input Schema (JSON Schema)
{
"properties": {
"autoPoll": {
"default": false,
"description": "Automatically poll until job completes (SUCCEEDED, FAILED, or CANCELLED)",
"type": "boolean"
},
"batchName": {
"description": "Batch job name/ID from batch_create",
"type": "string"
},
"maxWaitMs": {
"default": 86400000,
"description": "Maximum wait time in milliseconds (default: 24 hours)",
"type": "number"
},
"pollIntervalSeconds": {
"default": 30,
"description": "Seconds between status checks when autoPoll=true (default: 30)",
"minimum": 10,
"type": "number"
}
},
"required": [
"batchName"
],
"type": "object"
}