Class Scenarios

constructor

• new Scenarios(client: Runloop): Scenarios

  Parameters

  • client: Runloop

  Returns Scenarios

runs

scorers

create

• create(
      body: ScenarioCreateParams,
      options?: RequestOptions<unknown>,
  ): APIPromise<ScenarioView>

  Create a Scenario, a repeatable AI coding evaluation test that defines the starting environment as well as evaluation success criteria.

  Parameters

  • body: ScenarioCreateParams
  • Optionaloptions: RequestOptions<unknown>

  Returns APIPromise<ScenarioView>

retrieve

• retrieve(
      id: string,
      options?: RequestOptions<unknown>,
  ): APIPromise<ScenarioView>

  Get a previously created scenario.

  Parameters

  • id: string
  • Optionaloptions: RequestOptions<unknown>

  Returns APIPromise<ScenarioView>

update

• update(
      id: string,
      body?: ScenarioUpdateParams,
      options?: RequestOptions<unknown>,
  ): APIPromise<ScenarioView>

  Update a Scenario. Fields that are null will preserve the existing value. Fields that are provided (including empty values) will replace the existing value entirely.

  Parameters

  • id: string
  • Optionalbody: ScenarioUpdateParams
  • Optionaloptions: RequestOptions<unknown>

  Returns APIPromise<ScenarioView>

• update(id: string, options?: RequestOptions<unknown>): APIPromise<ScenarioView>

  Update a Scenario. Fields that are null will preserve the existing value. Fields that are provided (including empty values) will replace the existing value entirely.

  Parameters

  • id: string
  • Optionaloptions: RequestOptions<unknown>

  Returns APIPromise<ScenarioView>

list

• list(
      query?: ScenarioListParams,
      options?: RequestOptions<unknown>,
  ): PagePromise<ScenarioViewsScenariosCursorIDPage, ScenarioView>

  List all Scenarios matching filter.

  Parameters

  • Optionalquery: ScenarioListParams
  • Optionaloptions: RequestOptions<unknown>

  Returns PagePromise<ScenarioViewsScenariosCursorIDPage, ScenarioView>

• list(
      options?: RequestOptions<unknown>,
  ): PagePromise<ScenarioViewsScenariosCursorIDPage, ScenarioView>

  List all Scenarios matching filter.

  Parameters

  • Optionaloptions: RequestOptions<unknown>

  Returns PagePromise<ScenarioViewsScenariosCursorIDPage, ScenarioView>

listPublic

• listPublic(
      query?: ScenarioListPublicParams,
      options?: RequestOptions<unknown>,
  ): PagePromise<ScenarioViewsScenariosCursorIDPage, ScenarioView>

  List all public scenarios matching filter.

  Parameters

  • Optionalquery: ScenarioListPublicParams
  • Optionaloptions: RequestOptions<unknown>

  Returns PagePromise<ScenarioViewsScenariosCursorIDPage, ScenarioView>

• listPublic(
      options?: RequestOptions<unknown>,
  ): PagePromise<ScenarioViewsScenariosCursorIDPage, ScenarioView>

  List all public scenarios matching filter.

  Parameters

  • Optionaloptions: RequestOptions<unknown>

  Returns PagePromise<ScenarioViewsScenariosCursorIDPage, ScenarioView>

startRun

• startRun(
      body: ScenarioStartRunParams,
      options?: RequestOptions<unknown>,
  ): APIPromise<ScenarioRunView>

  Start a new ScenarioRun based on the provided Scenario.

  Parameters

  • body: ScenarioStartRunParams
  • Optionaloptions: RequestOptions<unknown>

  Returns APIPromise<ScenarioRunView>

startRunAndAwaitEnvReady

• startRunAndAwaitEnvReady(
      body: ScenarioStartRunParams,
      options?: RequestOptions<unknown> & {
          polling?: Partial<PollingOptions<DevboxView>>;
      },
  ): Promise<ScenarioRunView>

  Start a new ScenarioRun and wait for its environment to be ready. This is a convenience method that combines startRun() and awaitReady() on the devbox.

  Parameters

  • body: ScenarioStartRunParams
  • Optionaloptions: RequestOptions<unknown> & { polling?: Partial<PollingOptions<DevboxView>> }

  Returns Promise<ScenarioRunView>