Skip to main content
POST
/
v1
/
deepresearch
/
batches
/
{id}
/
cancel
Cancel a batch
curl --request POST \
  --url https://api.valyu.ai/v1/deepresearch/batches/{id}/cancel \
  --header 'x-api-key: <api-key>'
{
  "batch_id": "<string>",
  "status": "cancelled",
  "cancelled_count": 123
}

Authorizations

​
x-api-key
string
header
required

Your Valyu API key. Get one at platform.valyu.ai

Path Parameters

​
id
string
required

Batch ID

Response

Batch cancelled successfully

​
batch_id
string

Batch ID that was cancelled

​
status
enum<string>

Status of the batch after cancellation

Available options:
cancelled
​
cancelled_count
integer

Number of tasks cancelled