API Reference

Batches

Copy Markdown

Open in Claude

Open in ChatGPT

Open in Cursor

---

Copy Markdown

View as Markdown

Get Batch

BatchGetResponse batches().get(BatchGetParamsparams = BatchGetParams.none(), RequestOptionsrequestOptions = RequestOptions.none())

GET/api/v2/batches/{batch_id}

Get a batch by ID.

ParametersExpand Collapse

BatchGetParams params

Optional<String> batchId

Optional<List<String>> expand

Fields to expand. Supported value: results.

Optional<String> organizationId

Optional<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.

String id

Unique identifier

Config config

Batch configuration snapshot.

Job job

Job to create for each file in the source directory.

String configurationId

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

Type type

Product job type to run for each source directory file.

One of the following:

PARSE_V2("parse_v2")

EXTRACT_V2("extract_v2")

String projectId

Project this batch belongs to.

String sourceDirectoryId

Directory being processed.

Status status

Current batch status.

One of the following:

PENDING("PENDING")

THROTTLED("THROTTLED")

RUNNING("RUNNING")

COMPLETED("COMPLETED")

FAILED("FAILED")

CANCELLED("CANCELLED")

Optional<LocalDateTime> createdAt

Creation datetime

formatdate-time

Optional<List<Result>> results

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

String sourceDirectoryFileId

Source directory file processed by this batch.

Optional<String> errorMessage

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

Optional<JobReference> jobReference

Reference to a job produced by a batch.

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

String id

Job ID, such as a parse job ID.

Type type

Type of job produced for the file.

One of the following:

PARSE_V2("parse_v2")

EXTRACT_V2("extract_v2")

Optional<LocalDateTime> updatedAt

Update datetime

formatdate-time

Get Batch

Java

HTTP

TypeScript

Python

Java

Go

CLI Tool

package com.llamacloud_prod.api.example;

import com.llamacloud_prod.api.client.LlamaCloudClient;
import com.llamacloud_prod.api.client.okhttp.LlamaCloudOkHttpClient;
import com.llamacloud_prod.api.models.batches.BatchGetParams;
import com.llamacloud_prod.api.models.batches.BatchGetResponse;

public final class Main {
    private Main() {}

    public static void main(String[] args) {
        LlamaCloudClient client = LlamaCloudOkHttpClient.fromEnv();

        BatchGetResponse batch = client.batches().get("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"
}