Sign in
simulation_runs

Cancel a simulation run

Cooperatively cancels a pending or running simulation run: the row is marked cancelled and the worker's Celery task is best-effort revoked. The database is the source of truth — the worker re-reads the row before every terminal write, so a missed revoke signal is safe.

Idempotent: a run that has already reached a terminal status is returned unchanged with 200, so this is safe to call twice.

post/v1/simulation/runs/{sim_run_id}/cancel

Path parameters

sim_run_idstring uuid required

Response

Successful Response

idstring uuid required
session_idstring uuid required
organization_idstring uuid required
agent_idstring uuid required
agent_revision_idstring uuid nullable required
persona_idstring uuid required
scenario_idstring uuid required
suite_idstring uuid nullable
suite_run_idstring uuid nullable
suite_item_idstring uuid nullable
suite_attemptinteger
channel'text' | 'voice' required
tool_overridesobject nullable required
sut_snapshot_sha256string nullable
statusstring required
idempotency_keystring nullable
budget_usdstring nullable
spent_usdstring nullable
started_atstring date-time nullable required
finished_atstring date-time nullable required
error_textstring nullable required
stop_reasonstring nullable
persona_turn_countinteger
agent_turn_countinteger
transcript_charsinteger
heartbeat_atstring date-time nullable
inputs_snapshotobject required
created_atstring date-time required
recording_idstring uuid nullable
recording_statusstring nullable

Changes

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