Sign in

v34

latestOpenAPI 3.1.0raw.githubusercontent.com2026-06-09194386949.7 KB
V2
Batches

Get Batch

Get a batch by ID.

get/api/v2/batches/{batch_id}

Path parameters

batch_idstring required

Query parameters

expandstring[] nullable

Fields to expand. Supported value: results.

Fields to expand. Supported value: results.

project_idstring uuid nullable
organization_idstring uuid nullable

Cookies

sessionstring nullable

Response

Successful Response

created_atstring date-time nullable

Creation datetime

updated_atstring date-time nullable

Update datetime

project_idstring required

Project this batch belongs to.

source_directory_idstring required

Directory being processed.

status'PENDING' | 'THROTTLED' | 'RUNNING' | 'COMPLETED' | 'FAILED' | 'CANCELLED' required

Current batch status.

Example response

{
  "config": {
    "job": {
      "configuration_id": "cfg-PARSE_AGENTIC"
    }
  },
  "results": [
    {
      "source_directory_file_id": "dfl-aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee",
      "job_reference": {
        "id": "pjb-aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee"
      }
    }
  ]
}