# Batch

The Batch object of the Kaabist API.

| Field | Type | Required | Description |
|---|---|---|---|
| `id` | string | yes | pattern `^bat_[0-9a-hjkmnp-tv-z]{26}$` |
| `object` | `"batch"` | yes |  |
| `total` | integer | yes | ≥ 0 |
| `queued` | integer | yes | ≥ 0 |
| `running` | integer | yes | ≥ 0 |
| `succeeded` | integer | yes | ≥ 0 |
| `failed` | integer | yes | ≥ 0 |
| `canceled` | integer | yes | ≥ 0 |
| `webhook_url` | string or null (uri) | yes |  |
| `job_ids_url` | string | yes |  |
| `finished_at` | string or null (date-time) | yes |  |
| `created_at` | string (date-time) | yes |  |

## Example

```json
{
  "id": "bat_01j9zqk3q7m4n5p6r7s8t9v0wx",
  "object": "batch",
  "total": 120,
  "queued": 100,
  "running": 8,
  "succeeded": 10,
  "failed": 2,
  "canceled": 0,
  "webhook_url": null,
  "job_ids_url": "/v1/batches/bat_01j9zqk3q7m4n5p6r7s8t9v0wx/jobs",
  "finished_at": null,
  "created_at": "2026-09-18T10:00:00Z"
}
```
