Sign in

v49

latestOpenAPI 3.1.0raw.githubusercontent.com2026-08-01151216390.1 KB
Scenario

Cancel a Scenario run.

Cancel a currently running Scenario run. This will shutdown the underlying Devbox resource.

post/v1/scenarios/runs/{id}/cancel

Path parameters

idstring required

The Scenario Run ID.

Response

OK

idstring required

ID of the ScenarioRun.

namestring nullable

Optional name of ScenarioRun.

scenario_idstring required

ID of the Scenario that has been run.

devbox_idstring required

ID of the Devbox on which the Scenario is running.

benchmark_run_idstring nullable

ID of the BenchmarkRun that this Scenario is associated with, if any.

start_time_msinteger

The time that the scenario started

duration_msinteger nullable

Duration scenario took to run.

state'running' | 'scoring' | 'scored' | 'completed' | 'canceled' | 'timeout' | 'failed' required
metadataobject required

User defined metadata to attach to the scenario run for organization.

purposestring nullable

Purpose of the ScenarioRun.

environment_variablesobject nullable

Environment variables used to run the scenario.

secrets_providedobject nullable

User secrets used to run the scenario.