API Reference

Batches

Copy Markdown

Open in Claude

Open in ChatGPT

Open in Cursor

---

Copy Markdown

View as Markdown

Cancel Batch

client.Batches.Cancel(ctx, batchID, body) (*BatchCancelResponse, error)

POST/api/v2/batches/{batch_id}/cancel

Cancel a running batch.

Returns immediately; the batch reaches CANCELLED once processing stops. Files that already finished keep their results. A batch in a terminal status cannot be cancelled.

ParametersExpand Collapse

batchID string

body BatchCancelParams

OrganizationID param.Field[string]Optional

ProjectID param.Field[string]Optional

ReturnsExpand Collapse

type BatchCancelResponse struct{…}

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 BatchCancelResponseConfig

Batch configuration snapshot.

Job BatchCancelResponseConfigJob

Job to create for each file in the source directory.

ConfigurationID string

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

Type BatchCancelResponseConfigJobType

Product job type to run for each source directory file.

One of the following:

const BatchCancelResponseConfigJobTypeParseV2 BatchCancelResponseConfigJobType = "parse_v2"

const BatchCancelResponseConfigJobTypeExtractV2 BatchCancelResponseConfigJobType = "extract_v2"

ProjectID string

Project this batch belongs to.

SourceDirectoryID string

Directory being processed.

Status BatchCancelResponseStatus

Current batch status.

One of the following:

const BatchCancelResponseStatusCancelled BatchCancelResponseStatus = "CANCELLED"

const BatchCancelResponseStatusCompleted BatchCancelResponseStatus = "COMPLETED"

const BatchCancelResponseStatusFailed BatchCancelResponseStatus = "FAILED"

const BatchCancelResponseStatusPending BatchCancelResponseStatus = "PENDING"

const BatchCancelResponseStatusRunning BatchCancelResponseStatus = "RUNNING"

const BatchCancelResponseStatusThrottled BatchCancelResponseStatus = "THROTTLED"

CreatedAt TimeOptional

Creation datetime

formatdate-time

Results []BatchCancelResponseResultOptional

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

SourceDirectoryFileID string

Source directory file processed by this batch.

ErrorMessage stringOptional

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

JobReference BatchCancelResponseResultJobReferenceOptional

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 BatchCancelResponseResultJobReferenceType

Type of job produced for the file.

One of the following:

const BatchCancelResponseResultJobReferenceTypeParseV2 BatchCancelResponseResultJobReferenceType = "parse_v2"

const BatchCancelResponseResultJobReferenceTypeExtractV2 BatchCancelResponseResultJobReferenceType = "extract_v2"

UpdatedAt TimeOptional

Update datetime

formatdate-time

Cancel Batch

Go

HTTP

TypeScript

Python

Go

Java

C#

CLI Tool

package main

import (
  "context"
  "fmt"

  "github.com/run-llama/llama-parse-go"
  "github.com/run-llama/llama-parse-go/option"
)

func main() {
  client := llamacloud.NewClient(
    option.WithAPIKey("My API Key"),
  )
  response, err := client.Batches.Cancel(
    context.TODO(),
    "batch_id",
    llamacloud.BatchCancelParams{

    },
  )
  if err != nil {
    panic(err.Error())
  }
  fmt.Printf("%+v\n", response.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": "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"
}