API Reference

Beta

Batch

Copy Markdown

Open in Claude

Open in ChatGPT

Open in Cursor

---

Copy Markdown

View as Markdown

Cancel Batch Job

BatchCancelResponse Beta.Batch.Cancel(BatchCancelParamsparameters, CancellationTokencancellationToken = default)

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

Cancel a running batch processing job.

Stops processing and marks pending items as cancelled. Items currently being processed may still complete.

ParametersExpand Collapse

BatchCancelParams parameters

required string jobID

Path param

string? organizationID

Query param

formatuuid

string? projectID

Query param

formatuuid

string? reason

Body param: Optional reason for cancelling the job

string temporalNamespace

Header param

ReturnsExpand Collapse

class BatchCancelResponse:

Response after cancelling a batch job.

required string JobID

ID of the cancelled job

required string Message

Confirmation message

required Long ProcessedItems

Number of items processed before cancellation

required Status Status

New status (should be ‘cancelled’)

One of the following:

"cancelled"Cancelled

"completed"Completed

"dispatched"Dispatched

"failed"Failed

"pending"Pending

"running"Running

Cancel Batch Job

C#

HTTP

TypeScript

Python

Go

Java

C#

CLI Tool

BatchCancelParams parameters = new() { JobID = "job_id" };

var response = await client.Beta.Batch.Cancel(parameters);

Console.WriteLine(response);

200 example

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

Returns Examples

200 example

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