DeepResearch

Cancel a running or queued task

Cancel a DeepResearch task that is currently running or queued. Completed, failed, or already cancelled tasks cannot be cancelled.

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

Request

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

Path parameters

idstring required

DeepResearch task ID.

Response

Task cancelled.

successboolean required

Whether the operation succeeded.

messagestring required

Human-readable status message.

deepresearch_idstring required

ID of the affected task.

Example response

{
  "success": true,
  "message": "Task cancelled",
  "deepresearch_id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
}

Changes

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