API Reference
DraftLast reviewed 2026-06-23Cancel running simulation
POST/api/v1/simulations/:id/cancel
Sets the cancellation flag for the simulation. The engine checks this flag between pages and stops gracefully.
Worst-case cancel latency = one page processing time + one statement timeout (C3). Already-persisted partial results are retained and the run is resumable.
Returns HTTP 409 if the simulation is already in a terminal state (completed, failed, or cancelled).
Request
Responses
- 200
- 403
- 404
- 409
Cancellation flag set; returns current progress
Insufficient scope
Simulation not found
Simulation already in terminal state