Swarm runs

Cancel a journey run

Stops a run and settles its in-flight attempts. IDEMPOTENT: cancelling an already-cancelled run answers 200 with alreadyCanceled: true and finalized: 0, not a 409.

Addressed entirely by the path runId — there is no body.

Deliberately NOT behind the beta gate: cancelling REDUCES exposure and spend, so an organization that loses the flag can still stop a run that is under way.

post/projects/{projectId}/goal-runs/{runId}/cancel

Response

The run was cancelled (or already was).

idstring required

statusstring required

The run's terminal status after the cancel settled it.

canceledtrue required

alreadyCanceledboolean required

True when the run was already cancelled and this call did nothing.

finalizedinteger required

Attempts this call moved to terminal. Zero on an idempotent replay.

Changes

Changed in 1 of the 122 revisions of this API.1

Sep 22, 2026561e4fd0dfa21See the full diff
- ○
  endpoint added
  endpoint-added
This revision also has 50 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

Full history