Runs

Cancel run

Request cancellation of a run that is still in flight. Idempotent: a run that already reached a terminal state is returned unchanged with cancelRequested: false. A run that has not started executing yet is cancelled before this call returns. A run that is executing is stopped asynchronously: the response carries its current status with cancelRequested: true, and the run reaches cancelled shortly after, with a run.cancelled webhook. A cancelled run is never charged to the buyer (billingStatus settles to not_charged). Requires run:execute, not run:read, because it changes the run's outcome.

post/runs/{id}/cancel

Request

  • Base URL: https://api.edgaze.ai/v1
  • URL: https://api.edgaze.ai/v1/runs/{id}/cancel
  • Auth: HTTP bearer

Path parameters

idstring required

UUID returned from POST /runs.

Example:7c9e6679-7425-40de-944b-e07fc1f90ae7

Response

Cancellation recorded.

idstring uuid required
status'pending' | 'running' | 'suspended' | 'completed' | 'failed' | 'cancelled' required

Canonical run status exposed by the public API.

cancelRequestedboolean required

True when this call initiated the cancellation, false when the run was already in a terminal state and nothing changed.

Changes

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