API Reference

Batches

Copy Markdown

Open in Claude

Open in ChatGPT

Open in Cursor

---

Copy Markdown

View as Markdown

Get Batch

client.batches.get(stringbatchID, BatchGetParams { expand, organization_id, project_id } query?, RequestOptionsoptions?): BatchGetResponse { id, config, project_id, 5 more }

GET/api/v2/batches/{batch_id}

Get a batch by ID.

ParametersExpand Collapse

batchID: string

query: BatchGetParams { expand, organization_id, project_id }

expand?: Array<string> | null

Fields to expand. Supported value: results.

organization_id?: string | null

project_id?: string | null

ReturnsExpand Collapse

BatchGetResponse { id, config, project_id, 5 more }

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.

id: string

Unique identifier

config: Config { job }

Batch configuration snapshot.

job: Job { configuration_id, type }

Job to create for each file in the source directory.

configuration_id: string

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

type: "parse_v2" | "extract_v2"

Product job type to run for each source directory file.

One of the following:

"parse_v2"

"extract_v2"

project_id: string

Project this batch belongs to.

source_directory_id: string

Directory being processed.

status: "PENDING" | "THROTTLED" | "RUNNING" | 3 more

Current batch status.

One of the following:

"PENDING"

"THROTTLED"

"RUNNING"

"COMPLETED"

"FAILED"

"CANCELLED"

created_at?: string | null

Creation datetime

formatdate-time

results?: Array<Result> | null

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

source_directory_file_id: string

Source directory file processed by this batch.

error_message?: string | null

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

job_reference?: JobReference | null

Reference to a job produced by a batch.

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

id: string

Job ID, such as a parse job ID.

type: "parse_v2" | "extract_v2"

Type of job produced for the file.

One of the following:

"parse_v2"

"extract_v2"

updated_at?: string | null

Update datetime

formatdate-time

Get Batch

TypeScript

HTTP

TypeScript

Python

Java

Go

CLI Tool

import LlamaCloud from '@llamaindex/llama-cloud';

const client = new LlamaCloud({
  apiKey: process.env['LLAMA_CLOUD_API_KEY'], // This is the default and can be omitted
});

const batch = await client.batches.get('batch_id');

console.log(batch.id);

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": "PENDING",
  "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": "PENDING",
  "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"
}