API Reference
Devbox
- The Devbox Object
- Devbox Lifecycle
- Devbox File Tools
- Devbox Shell Tools
- Devbox Network Tools
- Devbox Persistence Tools
- Devbox Observability Tools
- Devbox Add-ons
Blueprint
- The Blueprint Object
- Blueprint Lifecycle
- Blueprint Observability
Repository
- The Repository Object
- Repository Lifecycle
Code Scenario
- Code Scenario Lifecycle
- Scenarios Runs
- Custom Scenario Scorer
- Public Scenarios
Benchmark
- Benchmark Lifecycle
- Benchmark Runs
- Public Benchmarks
Code Scenario Lifecycle
List Scenarios.
Code Scenario Lifecycle
List Scenarios.
List all Scenarios matching filter.
GET
/
v1
/
scenarios
import Runloop from '@runloop/api-client';
const client = new Runloop({
bearerToken: process.env['RUNLOOP_API_KEY'], // This is the default and can be omitted
});
async function main() {
// Automatically fetches more pages as needed.
for await (const scenarioView of client.scenarios.list()) {
console.log(scenarioView.id);
}
}
main();
{
"scenarios": [
{
"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,
"architecture": "x86_64",
"user_parameters": {
"username": "<string>",
"uid": 123
}
},
"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>",
"is_public": true
}
],
"has_more": true,
"total_count": 123,
"remaining_count": 123
}
Authorizations
Bearer authentication header of the form Bearer <token>
, where <token>
is your auth token.
Query Parameters
Query for Scenarios with a given name.
The limit of items to return. Default is 20.
Load the next page of data starting after the item with the given ID.
Response
200 - application/json
OK
The response is of type object
.
Was this page helpful?
import Runloop from '@runloop/api-client';
const client = new Runloop({
bearerToken: process.env['RUNLOOP_API_KEY'], // This is the default and can be omitted
});
async function main() {
// Automatically fetches more pages as needed.
for await (const scenarioView of client.scenarios.list()) {
console.log(scenarioView.id);
}
}
main();
{
"scenarios": [
{
"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,
"architecture": "x86_64",
"user_parameters": {
"username": "<string>",
"uid": 123
}
},
"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>",
"is_public": true
}
],
"has_more": true,
"total_count": 123,
"remaining_count": 123
}