Research

Cancel research run by ID

Cancel a running research run. Idempotent: an already-terminal run returns 200 with cancelled false and its current status.

post/v1/research-run/{research_run_id}/cancel

Request

  • Base URL: https://agent.tinyfish.ai
  • URL: https://agent.tinyfish.ai/v1/research-run/{research_run_id}/cancel
  • Auth: API key in header X-API-Key

Path parameters

research_run_idstring required

Research run identifier

Example:a1b2c3d4-e5f6-7890-abcd-ef1234567890

Response

Cancellation outcome

research_run_idstring required

Research run identifier

status'RUNNING' | 'COMPLETED' | 'FAILED' | 'CANCELLED' | 'TIMED_OUT' | 'QUEUED' required

Status of the run after this request

cancelledboolean required

Whether this request changed the run to CANCELLED

Example response

{
  "status": "CANCELLED",
  "cancelled": true
}

Changes

No recorded changes to this operation across all 2 revisions of this API.