Cancel a run
cancel_runCancels an in-flight simulation run in built, queued, or computing status and terminates its compute resources. Use it to stop costly jobs; already-finished runs return a 409 conflict.
Instructions
Cancel an in-flight simulation run.
Needs a launch-level agent key; a read or draft key gets 403 AGENT_LEVEL_INSUFFICIENT.
Works on runs in built, queued, or computing status. Cleans up compute resources (terminates EC2 instance, Celery task, or Batch job).
Returns 409 if the run is already in a terminal state (complete, cancelled, or error).
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| run_id | Yes | The run ID to cancel |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
No arguments | |||