Scenario

Start a new ScenarioRun.

Changed on

Start a new ScenarioRun based on the provided Scenario.

post/v1/scenarios/start_run

Request

  • Base URL: https://api.runloop.ai
  • URL: https://api.runloop.ai/v1/scenarios/start_run
  • Auth: HTTP bearer

Request body

scenario_idstring required

ID of the Scenario to run.

run_namestring nullable

Display name of the run.

benchmark_run_idstring nullable

Benchmark to associate the run.

metadataobject nullable

User defined metadata to attach to the run for organization.

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

  • e9dc776053e4Revision changes
    • info

      added the new pi_json enum value to the request property ///////////////

  • fe489479c0aaRevision changes
    • info

      added the new codex_json enum value to the request property ///////////////