Batches

Cancel a batch

Cancel all queued and running tasks in a batch. The batch must be in open or processing status.

post/v1/deepresearch/batches/{id}/cancel

Request

  • Base URL: https://api.valyu.ai
  • URL: https://api.valyu.ai/v1/deepresearch/batches/{id}/cancel
  • Auth: API key in header X-API-Key

Path parameters

idstring required

Batch ID.

Response

Batch cancelled.

batch_idstring required

ID of the cancelled batch.

status'cancelled' required

Batch status after cancellation.

cancelled_countinteger required

Number of tasks cancelled.

Example response

{
  "batch_id": "batch_a1b2c3d4-e5f6-7890-abcd-ef1234567890",
  "status": "cancelled",
  "cancelled_count": 3
}

Changes

No recorded changes to this operation across all 1 revision of this API.