Benchmark

Modify scenarios for a Benchmark.

Changed on

Add and/or remove Scenario IDs from an existing Benchmark.

post/v1/benchmarks/{id}/scenarios

Request

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

Path parameters

idstring required

The Benchmark ID.

Request body

scenarios_to_addstring[] nullable

Scenario IDs to add to the Benchmark.

scenarios_to_removestring[] nullable

Scenario IDs to remove from the Benchmark.

Response

OK

idstring required

The ID of the Benchmark.

namestring required

The name of the Benchmark.

scenarioIdsstring[] required

List of Scenario IDs that make up the benchmark.

metadataobject required

User defined metadata to attach to the benchmark for organization.

required_environment_variablesstring[]

Required environment variables used to run the benchmark. If any required environment variables are missing, the benchmark will fail to start.

required_secret_namesstring[]

Required secrets used to run the benchmark. If any required secrets are missing, the benchmark will fail to start.

is_publicboolean

Whether this benchmark is public.

attributionstring

Attribution information for the benchmark.

descriptionstring

Detailed description of the benchmark.

status'active' | 'archived' required

Changes

  • d3ddb452754cRevision changes
    • breaking

      the request property became not nullable

    • breaking

      the request property became not nullable

  • c33fa67077f6Revision changes
    • info

      added the required property to the response with the status