Cancel Batch Job

beta.batch.cancel(, ) -> BatchCancelResponse

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.

ParametersExpand Collapse

job_id: str

organization_id: Optional[str]

project_id: Optional[str]

reason: Optional[str]

Optional reason for cancelling the job

temporal_namespace: Optional[str]

ReturnsExpand Collapse

class BatchCancelResponse: …

Response after cancelling a batch job.

job_id: str

ID of the cancelled job

message: str

Confirmation message

processed_items: int

Number of items processed before cancellation

status: Literal["pending", "running", "dispatched", 3 more]

New status (should be 'cancelled')

Accepts one of the following:

"pending"

"running"

"dispatched"

"completed"

"failed"

"cancelled"

Cancel Batch Job

import os
from llama_cloud import LlamaCloud

client = LlamaCloud(
    api_key=os.environ.get("LLAMA_CLOUD_API_KEY"),  # This is the default and can be omitted
)
response = client.beta.batch.cancel(
    job_id="job_id",
)
print(response.job_id)

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

Returns Examples

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