V2
Batches

Cancel Batch

Changed on

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.

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

Request

  • Base URL: https://api.cloud.llamaindex.ai (the document declares no server; this is the origin it was published from)
  • URL: https://api.cloud.llamaindex.ai/api/v2/batches/{batch_id}/cancel
  • Auth: HTTP bearer

Path parameters

batch_idstring required

Query parameters

project_idstring uuid nullable
organization_idstring uuid nullable

Cookies

sessionstring nullable

Response

Successful Response

created_atstring date-time nullable

Creation datetime

updated_atstring date-time nullable

Update datetime

project_idstring required

Project this batch belongs to.

source_directory_idstring required

Directory being processed.

status'PENDING' | 'THROTTLED' | 'RUNNING' | 'COMPLETED' | 'FAILED' | 'CANCELLED' required

Current batch status.

Example response

{
  "config": {
    "job": {
      "configuration_id": "cfg-PARSE_AGENTIC"
    }
  },
  "results": [
    {
      "source_directory_file_id": "dfl-aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee",
      "job_reference": {
        "id": "pjb-aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee"
      }
    }
  ]
}

Changes