Get Batch Run

Retrieve the status of a batch run by its ID. The status field reflects the aggregate state of the batch.

This is a unified endpoint that works for batches created via any of the batch submission endpoints (POST /parse_runs/batch, POST /extract_runs/batch, POST /classify_runs/batch, POST /split_runs/batch).

Status	Meaning
`PENDING`	Queued, not yet started
`PROCESSING`	Runs are actively being processed
`PROCESSED`	All runs have completed
`FAILED`	The batch encountered a fatal error
`CANCELLED`	The batch was cancelled

To retrieve individual run results, use the List endpoint for the relevant type filtered by batchId:

GET /parse_runs?batchId={id}
GET /extract_runs?batchId={id}
GET /classify_runs?batchId={id}
GET /split_runs?batchId={id}

Retrieve the status of a batch run by its ID. The `status` field reflects the aggregate state of the batch. This is a unified endpoint that works for batches created via any of the batch submission endpoints (`POST /parse_runs/batch`, `POST /extract_runs/batch`, `POST /classify_runs/batch`, `POST /split_runs/batch`). | Status | Meaning | |---|---| | `PENDING` | Queued, not yet started | | `PROCESSING` | Runs are actively being processed | | `PROCESSED` | All runs have completed | | `FAILED` | The batch encountered a fatal error | | `CANCELLED` | The batch was cancelled | To retrieve individual run results, use the List endpoint for the relevant type filtered by `batchId`: - `GET /parse_runs?batchId={id}` - `GET /extract_runs?batchId={id}` - `GET /classify_runs?batchId={id}` - `GET /split_runs?batchId={id}`

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Path parameters

idstringRequired

The unique identifier of the batch processor run to retrieve.

Example: "bpr_Xj8mK2pL9nR4vT7qY5wZ"

Response

Successfully retrieved batch processor run

objectenum

The type of object. Always "batch_run".

Allowed values:

idstring

The unique identifier for this batch run.

Example: "bpr_Xj8mK2pL9nR4vT7qY5wZ"

statusenum

The status of a batch run:

"PENDING" - The batch has been created and is waiting to be processed
"PROCESSING" - The batch is currently being processed
"PROCESSED" - All runs in the batch have completed successfully
"FAILED" - The batch failed to process
"CANCELLED" - The batch was cancelled

Allowed values:

runCountinteger

The number of individual runs in this batch.

createdAtstringformat: "date-time"

The time (in UTC) at which the object was created. Will follow the RFC 3339 format.

Example: "2024-03-21T16:45:00Z"

Errors

400

Bad Request Error

401

Unauthorized Error

402

Payment Required Error

403

Forbidden Error

404

Not Found Error

429

Too Many Requests Error

500

Internal Server Error

Retrieve the status of a batch run by its ID. The status field reflects the aggregate state of the batch.

Status	Meaning
`PENDING`	Queued, not yet started
`PROCESSING`	Runs are actively being processed
`PROCESSED`	All runs have completed
`FAILED`	The batch encountered a fatal error
`CANCELLED`	The batch was cancelled

To retrieve individual run results, use the List endpoint for the relevant type filtered by batchId:

GET /parse_runs?batchId={id}
GET /extract_runs?batchId={id}
GET /classify_runs?batchId={id}
GET /split_runs?batchId={id}

Bearer authentication of the form Bearer <token>, where token is your auth token.

The unique identifier of the batch processor run to retrieve.

Example: "bpr_Xj8mK2pL9nR4vT7qY5wZ"

API version to use for the request. If you’re using an SDK, you can ignore this parameter. If you are not using an SDK and do not specify a version, you will either receive a 400 Bad Request or be set to a previous legacy version. See API Versioning for more details.

API version to use for the request. If you're using an SDK, you can ignore this parameter. If you are not using an SDK and do not specify a version, you will either receive a `400 Bad Request` or be set to a previous legacy version. See [API Versioning](https://docs.extend.ai/2026-02-09/api-reference/api-versioning) for more details.

Successfully retrieved batch processor run

The type of object. Always "batch_run".

The unique identifier for this batch run.

Example: "bpr_Xj8mK2pL9nR4vT7qY5wZ"

The status of a batch run:

"PENDING" - The batch has been created and is waiting to be processed
"PROCESSING" - The batch is currently being processed
"PROCESSED" - All runs in the batch have completed successfully
"FAILED" - The batch failed to process
"CANCELLED" - The batch was cancelled

The number of individual runs in this batch.

The time (in UTC) at which the object was created. Will follow the RFC 3339 format.

Example: "2024-03-21T16:45:00Z"

1	from extend_ai import Extend
2
3	client = Extend(
4	token="YOUR_TOKEN_HERE",
5	extend_api_version="2026-02-09",
6	)
7
8	client.batch_runs.get(
9	id="bpr_Xj8mK2pL9nR4vT7qY5wZ",
10	)

1	{
2	"object": "batch_run",
3	"id": "bpr_Xj8mK2pL9nR4vT7qY5wZ",
4	"status": "PROCESSING",
5	"runCount": 50,
6	"createdAt": "2024-03-21T16:45:00Z"
7	}

Authentication

Path parameters

Headers

Response

Errors

Authentication

Path parameters

Headers

Response

Errors