Benchmark

List started scenario runs for a benchmark run.

Changed on

List started scenario runs for a benchmark run.

get/v1/benchmarks/runs/{id}/scenario_runs

Request

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

Path parameters

idstring required

The BenchmarkRun ID.

Query parameters

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

Filter by Scenario Run state

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

    • info

      added the new optional query request parameter search

    • 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