Scenario

Cancel a Scenario run.

Changed on

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

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

Request

  • Base URL: https://api.runloop.ai
  • URL: https://api.runloop.ai/v1/scenarios/runs/{id}/cancel
  • Auth: HTTP bearer

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.

Changes

  • d3ddb452754cRevision changes
    • breaking

      the response's property type changed from object to no type for status

    • breaking

      removed the required property / from the response with the status

    • breaking

      removed the required property / from the response with the status

    • info

      added subschema #2 to the response property anyOf list for the response status