runs

Abort a run

Accepted, not applied: abort asks the Workflow engine to abort the run and returns the status the RunAgent holds at that moment. A blocked run resumes from the gate it parked on; a cooperative abort reaches billing finalization before the run reads aborted everywhere.

post/v1/runs/{id}/abort

Request

  • Base URL: https://api.hyperresearch.ai
  • URL: https://api.hyperresearch.ai/v1/runs/{id}/abort
  • Auth: one of:
    • HTTP bearer
    • API key in cookie hr_session

Path parameters

idstring required

Response

Control request accepted; the run status as it now stands

idstring required
status'clarifying' | 'queued' | 'running' | 'paused' | 'blocked' | 'done' | 'failed' | 'aborted' required
cancellation_requestedboolean

Changes

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