Sign in
Scenario

Update a Scenario.

Update a Scenario, a repeatable AI coding evaluation test that defines the starting environment as well as evaluation success criteria. Only provided fields will be updated.

post/v1/scenarios/{id}

Path parameters

idstring required

The Scenario ID.

Request body

namestring nullable

Name of the scenario.

metadataobject nullable

User defined metadata to attach to the scenario for organization.

required_environment_variablesstring[] nullable

Environment variables required to run the scenario.

required_secret_namesstring[] nullable

Secrets required to run the scenario.

reference_outputstring nullable

A string representation of the reference output to solve the scenario. Commonly can be the result of a git diff or a sequence of command actions to apply to the environment.

validation_type'UNSPECIFIED' | 'FORWARD' | 'REVERSE' | 'EVALUATION'

Response

OK

idstring required

The ID of the Scenario.

namestring required

The name of the Scenario.

metadataobject required

User defined metadata to attach to the scenario for organization.

reference_outputstring nullable

A string representation of the reference output to solve the scenario. Commonly can be the result of a git diff or a sequence of command actions to apply to the environment.

required_environment_variablesstring[]

Environment variables required to run the scenario. If any required environment variables are missing, the scenario will fail to start.

required_secret_namesstring[]

Environment variables required to run the scenario. If any required secrets are missing, the scenario will fail to start.

is_publicboolean

Whether this scenario is public.

validation_type'UNSPECIFIED' | 'FORWARD' | 'REVERSE' | 'EVALUATION'

Changes