API Reference

Batches

Copy Markdown

Open in Claude

Open in ChatGPT

Open in Cursor

---

Copy Markdown

View as Markdown

Get Batch

BatchGetResponse Batches.Get(BatchGetParamsparameters, CancellationTokencancellationToken = default)

GET/api/v2/batches/{batch_id}

Get a batch by ID.

ParametersExpand Collapse

BatchGetParams parameters

required string batchID

IReadOnlyList<string>? expand

Fields to expand. Supported value: results.

string? organizationID

string? projectID

ReturnsExpand Collapse

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-PARSE_AGENTIC” } }, “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.

required string ID

Unique identifier

required Config Config

Batch configuration snapshot.

required Job Job

Job to create for each file in the source directory.

required string ConfigurationID

Product configuration ID or built-in preset ID matching the job type.

required Type Type

Product job type to run for each source directory file.

One of the following:

"parse_v2"ParseV2

"extract_v2"ExtractV2

required string ProjectID

Project this batch belongs to.

required string SourceDirectoryID

Directory being processed.

required Status Status

Current batch status.

One of the following:

"CANCELLED"Cancelled

"COMPLETED"Completed

"FAILED"Failed

"PENDING"Pending

"RUNNING"Running

"THROTTLED"Throttled

DateTimeOffset? CreatedAt

Creation datetime

formatdate-time

IReadOnlyList<Result>? Results

Expanded per-file result mappings. Null unless requested with expand=results, or while the batch is still running.

required string SourceDirectoryFileID

Source directory file processed by this batch.

string? ErrorMessage

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

JobReference? JobReference

Reference to a job produced by a batch.

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

required string ID

Job ID, such as a parse job ID.

required Type Type

Type of job produced for the file.

One of the following:

"parse_v2"ParseV2

"extract_v2"ExtractV2

DateTimeOffset? UpdatedAt

Update datetime

formatdate-time

Get Batch

C#

HTTP

TypeScript

Python

Go

Java

C#

CLI Tool

BatchGetParams parameters = new() { BatchID = "batch_id" };

var batch = await client.Batches.Get(parameters);

Console.WriteLine(batch);

200 example

{
  "id": "id",
  "config": {
    "job": {
      "configuration_id": "cfg-PARSE_AGENTIC",
      "type": "parse_v2"
    }
  },
  "project_id": "project_id",
  "source_directory_id": "source_directory_id",
  "status": "CANCELLED",
  "created_at": "2019-12-27T18:11:19.117Z",
  "results": [
    {
      "source_directory_file_id": "dfl-aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee",
      "error_message": "error_message",
      "job_reference": {
        "id": "pjb-aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee",
        "type": "parse_v2"
      }
    }
  ],
  "updated_at": "2019-12-27T18:11:19.117Z"
}

Returns Examples

200 example

{
  "id": "id",
  "config": {
    "job": {
      "configuration_id": "cfg-PARSE_AGENTIC",
      "type": "parse_v2"
    }
  },
  "project_id": "project_id",
  "source_directory_id": "source_directory_id",
  "status": "CANCELLED",
  "created_at": "2019-12-27T18:11:19.117Z",
  "results": [
    {
      "source_directory_file_id": "dfl-aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee",
      "error_message": "error_message",
      "job_reference": {
        "id": "pjb-aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee",
        "type": "parse_v2"
      }
    }
  ],
  "updated_at": "2019-12-27T18:11:19.117Z"
}