Scenario

List ScenarioRuns.

Changed on

List all ScenarioRuns matching filter.

get/v1/scenarios/runs

Request

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

Query parameters

namestring

Filter by name

statestring

Filter by state

benchmark_run_idstring

Filter by benchmark run ID

scenario_idstring

Filter runs associated to Scenario given ID

searchstring

Search by scenario run ID or name.

limitinteger

The limit of items to return. Default is 20. Max is 5000.

starting_afterstring

Load the next page of data starting after the item with the given ID.

include_total_countboolean

If true (default), includes total_count in the response. Set to false to skip the count query for better performance on large datasets.

Response

OK

has_moreboolean required
total_countinteger nullable

Changes

  • fe489479c0aaRevision changes
    • info

      added the new optional query request parameter search

  • 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