Runs

Cancel Run

Stop an in-flight run. Cancelled runs reach a terminal state and are never charged.

curl --fail-with-body --silent --show-error -X POST 'https://api.edgaze.ai/v1/runs/7c9e6679-7425-40de-944b-e07fc1f90ae7/cancel' \
  -H "Authorization: Bearer $EDGAZE_API_KEY"

Audience

Developers stopping work a buyer no longer wants.

POSThttps://api.edgaze.ai/v1/runs/{run_id}/cancel

Overview#

Requests cancellation of a run that has not reached a terminal state. The run is marked cancelled before the call returns, a run.cancelled webhook is dispatched, and any subsequent poll of Get Run reports the terminal status.

Cancelled runs are not charged, and billingStatus settles to not_charged.

Cancellation requires run:execute rather than run:read, because it changes a run's outcome and its billing.

The call is idempotent. Cancelling a run that already completed, failed, or was cancelled returns 200 with cancelRequested false and the existing status. A cancelled run appears as cancelled in GET /runs, GET /runs?status=cancelled, and GET /runs/{id}.

Authorization#

run:execute

Parameters#

Headers

Authorizationstringheaderrequired

Bearer token with run:execute scope.

Example: Bearer edgaze_sk_live_…

Path parameters

run_idstringpathrequired

UUID returned from POST /runs.

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

Response#

Example payloads are in the request/response panel above.

cancelRequested distinguishes the two success cases: true means this call stopped the run, false means the run was already terminal and nothing changed.

Edge cases#

Requires run:execute

Cancelling changes a run's outcome and its billing, so it needs run:execute rather than run:read.

Idempotent

A run that already completed, failed, or was cancelled returns 200 with cancelRequested false and its status unchanged.

Cancellation is asynchronous at the worker

The run is marked cancelled immediately, but an in-flight step may take a moment to stop. Output produced before cancellation remains available in run events.

Cross-tenant isolation

Cancelling another account's run returns 404, not 403.

Was this useful?

Your response helps us improve the documentation.