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
Custom Scenario Scorer
Validate a custom scenario scorer.
Custom Scenario Scorer
Validate a custom scenario scorer.
Validate a scenario scorer.
POST
/
v1
/
scenarios
/
scorers
/
{id}
/
validate
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() {
const response = await client.scenarios.scorers.validate('id', { scoring_context: {} });
console.log(response.name);
}
main();
{
"name": "<string>",
"environment_parameters": {
"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>"
},
"scoring_context": {},
"scoring_result": {
"score": 123,
"scoring_function_name": "<string>",
"output": "<string>",
"state": "unknown"
}
}
Authorizations
Bearer authentication header of the form Bearer <token>
, where <token>
is your auth token.
Path Parameters
The Scorer ID.
Body
application/json
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() {
const response = await client.scenarios.scorers.validate('id', { scoring_context: {} });
console.log(response.name);
}
main();
{
"name": "<string>",
"environment_parameters": {
"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>"
},
"scoring_context": {},
"scoring_result": {
"score": 123,
"scoring_function_name": "<string>",
"output": "<string>",
"state": "unknown"
}
}