GET
/
v1
/
scenarios
/
{id}
JavaScript
import Runloop from '@runloop/api-client';

const client = new Runloop({
  bearerToken: 'My Bearer Token',
});

const scenarioView = await client.scenarios.retrieve('id');

console.log(scenarioView.id);
{
  "id": "<string>",
  "name": "<string>",
  "environment": {
    "blueprint_id": "<string>",
    "snapshot_id": "<string>",
    "prebuilt_id": "<string>",
    "launch_parameters": {
      "launch_commands": [
        "<string>"
      ],
      "resource_size_request": "X_SMALL",
      "keep_alive_time_seconds": 123,
      "available_ports": [
        123
      ],
      "after_idle": {
        "idle_time_seconds": 123,
        "on_idle": "shutdown"
      },
      "custom_cpu_cores": 123,
      "custom_gb_memory": 123,
      "custom_disk_size": 123,
      "architecture": "x86_64",
      "user_parameters": {
        "username": "<string>",
        "uid": 123
      },
      "required_services": [
        "<string>"
      ]
    },
    "working_directory": "<string>"
  },
  "input_context": {
    "problem_statement": "<string>",
    "additional_context": {}
  },
  "scoring_contract": {
    "scoring_function_parameters": [
      {
        "name": "<string>",
        "scorer": {
          "lang": "<string>",
          "search_directory": "<string>",
          "pattern": "<string>",
          "type": "ast_grep_scorer"
        },
        "weight": 123
      }
    ]
  },
  "metadata": {},
  "reference_output": "<string>",
  "required_environment_variables": [
    "<string>"
  ],
  "required_secret_names": [
    "<string>"
  ],
  "is_public": true
}

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

id
string
required

The Scenario ID.

Response

200 - application/json

OK

A ScenarioDefinitionView represents a repeatable AI coding evaluation test, complete with initial environment and scoring contract.

id
string
required

The ID of the Scenario.

name
string
required

The name of the Scenario.

input_context
object
required

The input context for the Scenario.

scoring_contract
object
required

The scoring contract for the Scenario.

metadata
object
required

User defined metadata to attach to the scenario for organization.

environment
object

The Environment in which the Scenario is run.

reference_output
string | null

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_variables
string[]

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

required_secret_names
string[]

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

is_public
boolean

Whether this scenario is public.