Cancel Batch Job

POST/api/v1/beta/batch-processing/{job_id}/cancel

Cancel a running batch processing job.

Stops processing and marks all pending items as cancelled. Items currently being processed may complete depending on their state.

Path ParametersExpand Collapse

job_id: string

Query ParametersExpand Collapse

organization_id: optional string

project_id: optional string

Header ParametersExpand Collapse

"temporal-namespace": optional string

Cookie ParametersExpand Collapse

session: optional string

Body ParametersExpand Collapse

reason: optional string

Optional reason for cancelling the job

ReturnsExpand Collapse

job_id: string

ID of the cancelled job

message: string

Confirmation message

processed_items: number

Number of items processed before cancellation

status: "pending" or "running" or "dispatched" or 3 more

New status (should be 'cancelled')

Accepts one of the following:

"pending"

"running"

"dispatched"

"completed"

"failed"

"cancelled"

Cancel Batch Job

curl https://api.cloud.llamaindex.ai/api/v1/beta/batch-processing/$JOB_ID/cancel \
    -H 'Content-Type: application/json' \
    -H "Authorization: Bearer $LLAMA_CLOUD_API_KEY" \
    -d '{}'

{
  "job_id": "job_id",
  "message": "message",
  "processed_items": 0,
  "status": "pending"
}

Returns Examples

{
  "job_id": "job_id",
  "message": "message",
  "processed_items": 0,
  "status": "pending"
}