Skip to content
Developer Documentation
API Reference

Batches

Create Batch
batches.create(BatchCreateParams**kwargs) -> BatchCreateResponse
POST/api/v2/batches
List Batches
batches.list(BatchListParams**kwargs) -> SyncPaginatedCursor[BatchListResponse]
GET/api/v2/batches
Get Batch
batches.get(strbatch_id, BatchGetParams**kwargs) -> BatchGetResponse
GET/api/v2/batches/{batch_id}
ModelsExpand Collapse
class BatchCreateResponse: …

A top-level batch.

Example: { “id”: “bat-aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee”, “project_id”: “prj-aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee”, “source_directory_id”: “dir-aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee”, “config”: { “job”: { “type”: “parse_v2”, “configuration_id”: “cfg-aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee” } }, “status”: “COMPLETED”, “results”: [ { “source_directory_file_id”: “dfl-aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee”, “job_reference”: { “type”: “parse_v2”, “id”: “pjb-aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee” }, “error_message”: null } ] }

Batch-level FAILED means the orchestration failed and cannot provide a reliable per-file result set. results is only populated when explicitly requested with expand=results and may be null while a batch is still running or before result mappings are available.

id: str

Unique identifier

config: Config

Batch configuration snapshot.

job: ConfigJob

Job to create for each file in the source directory.

configuration_id: str

Saved product configuration ID matching the job type.

type: Literal["parse_v2", "extract_v2"]

Product job type to run for each source directory file.

One of the following:
"parse_v2"
"extract_v2"
project_id: str

Project this batch belongs to.

source_directory_id: str

Directory being processed.

status: Literal["PENDING", "THROTTLED", "RUNNING", 3 more]

Current batch status.

One of the following:
"PENDING"
"THROTTLED"
"RUNNING"
"COMPLETED"
"FAILED"
"CANCELLED"
created_at: Optional[datetime]

Creation datetime

formatdate-time
results: Optional[List[Result]]

Expanded per-file result mappings. Null unless requested with expand=results, or until result mappings are available.

source_directory_file_id: str

Source directory file processed by this batch.

error_message: Optional[str]

Batch-level mapping error if the system could not create or associate a job for this source file.

job_reference: Optional[ResultJobReference]

Reference to a job produced by a batch.

Example: { “type”: “parse_v2”, “id”: “pjb-aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee” }

id: str

Job ID, such as a parse job ID.

type: Literal["parse_v2", "extract_v2"]

Type of job produced for the file.

One of the following:
"parse_v2"
"extract_v2"
updated_at: Optional[datetime]

Update datetime

formatdate-time
class BatchListResponse: …

A top-level batch.

Example: { “id”: “bat-aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee”, “project_id”: “prj-aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee”, “source_directory_id”: “dir-aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee”, “config”: { “job”: { “type”: “parse_v2”, “configuration_id”: “cfg-aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee” } }, “status”: “COMPLETED”, “results”: [ { “source_directory_file_id”: “dfl-aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee”, “job_reference”: { “type”: “parse_v2”, “id”: “pjb-aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee” }, “error_message”: null } ] }

Batch-level FAILED means the orchestration failed and cannot provide a reliable per-file result set. results is only populated when explicitly requested with expand=results and may be null while a batch is still running or before result mappings are available.

id: str

Unique identifier

config: Config

Batch configuration snapshot.

job: ConfigJob

Job to create for each file in the source directory.

configuration_id: str

Saved product configuration ID matching the job type.

type: Literal["parse_v2", "extract_v2"]

Product job type to run for each source directory file.

One of the following:
"parse_v2"
"extract_v2"
project_id: str

Project this batch belongs to.

source_directory_id: str

Directory being processed.

status: Literal["PENDING", "THROTTLED", "RUNNING", 3 more]

Current batch status.

One of the following:
"PENDING"
"THROTTLED"
"RUNNING"
"COMPLETED"
"FAILED"
"CANCELLED"
created_at: Optional[datetime]

Creation datetime

formatdate-time
results: Optional[List[Result]]

Expanded per-file result mappings. Null unless requested with expand=results, or until result mappings are available.

source_directory_file_id: str

Source directory file processed by this batch.

error_message: Optional[str]

Batch-level mapping error if the system could not create or associate a job for this source file.

job_reference: Optional[ResultJobReference]

Reference to a job produced by a batch.

Example: { “type”: “parse_v2”, “id”: “pjb-aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee” }

id: str

Job ID, such as a parse job ID.

type: Literal["parse_v2", "extract_v2"]

Type of job produced for the file.

One of the following:
"parse_v2"
"extract_v2"
updated_at: Optional[datetime]

Update datetime

formatdate-time
class BatchGetResponse: …

A top-level batch.

Example: { “id”: “bat-aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee”, “project_id”: “prj-aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee”, “source_directory_id”: “dir-aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee”, “config”: { “job”: { “type”: “parse_v2”, “configuration_id”: “cfg-aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee” } }, “status”: “COMPLETED”, “results”: [ { “source_directory_file_id”: “dfl-aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee”, “job_reference”: { “type”: “parse_v2”, “id”: “pjb-aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee” }, “error_message”: null } ] }

Batch-level FAILED means the orchestration failed and cannot provide a reliable per-file result set. results is only populated when explicitly requested with expand=results and may be null while a batch is still running or before result mappings are available.

id: str

Unique identifier

config: Config

Batch configuration snapshot.

job: ConfigJob

Job to create for each file in the source directory.

configuration_id: str

Saved product configuration ID matching the job type.

type: Literal["parse_v2", "extract_v2"]

Product job type to run for each source directory file.

One of the following:
"parse_v2"
"extract_v2"
project_id: str

Project this batch belongs to.

source_directory_id: str

Directory being processed.

status: Literal["PENDING", "THROTTLED", "RUNNING", 3 more]

Current batch status.

One of the following:
"PENDING"
"THROTTLED"
"RUNNING"
"COMPLETED"
"FAILED"
"CANCELLED"
created_at: Optional[datetime]

Creation datetime

formatdate-time
results: Optional[List[Result]]

Expanded per-file result mappings. Null unless requested with expand=results, or until result mappings are available.

source_directory_file_id: str

Source directory file processed by this batch.

error_message: Optional[str]

Batch-level mapping error if the system could not create or associate a job for this source file.

job_reference: Optional[ResultJobReference]

Reference to a job produced by a batch.

Example: { “type”: “parse_v2”, “id”: “pjb-aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee” }

id: str

Job ID, such as a parse job ID.

type: Literal["parse_v2", "extract_v2"]

Type of job produced for the file.

One of the following:
"parse_v2"
"extract_v2"
updated_at: Optional[datetime]

Update datetime

formatdate-time