Skip to main content
POST
Cancel a batch

Authorizations

X-API-Key
string
header
required

API key for authentication. Get yours at platform.valyu.ai.

Path Parameters

id
string
required

Batch ID.

Response

Batch cancelled.

batch_id
string
required

ID of the cancelled batch.

Example:

"batch_a1b2c3d4-e5f6-7890-abcd-ef1234567890"

status
enum<string>
required

Batch status after cancellation.

Available options:
cancelled
Example:

"cancelled"

cancelled_count
integer
required

Number of tasks cancelled.

Example:

3