How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Need help?

Contact us
Runloop

Runloop Scenario API

The Scenario API from Runloop — 17 operation(s) for scenario.

Documentation Provider Profile APIs.io OpenAPI GitHub

Runloop Scenario API is one of 24 APIs that Runloop publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

This API exposes 19 JSON Schema definitions.

Tagged areas include Scenario. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, a JSON-LD context, and 19 JSON Schemas.

This API exposes 21 operations across 17 paths, and defines 48 schemas. It is described by OpenAPI 3.2.0, at version 0.1.

Requests are made against a single base URL, https://api.runloop.ai.

21 operations 17 paths 48 schemas 10 GET11 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
0.1
Base URL
https://api.runloop.ai
Authentication
HTTP Bearer
Contact
Runloop AI Support
Resource Areas
1

Authentication & Security 1

Runloop Scenario API declares 1 security scheme for authenticating requests. It accepts HTTP bearer tokens (bearerAuth). By default, every request must be authenticated.

Paths & Operations 21

Across 17 paths, the API surfaces 21 operations — 10 GET, 11 POST. Each is listed below with its method, path, parameters, and response codes.

Scenario 21
POST
/v1/scenarios
Create a Scenario.
createScenario body → 200
GET
/v1/scenarios
List Scenarios.
listScenarios 6 params → 200
GET
/v1/scenarios/list_public
List Public Scenarios.
listPublicScenarios 4 params → 200
GET
/v1/scenarios/metadata/keys
List available scenario metadata keys.
getScenarioMetadataKeys → 200
GET
/v1/scenarios/metadata/keys/{key}/values
List values for a specific scenario metadata key.
getScenarioMetadataValues 1 param → 200400
GET
/v1/scenarios/runs
List ScenarioRuns.
listScenarioRuns 7 params → 200
GET
/v1/scenarios/runs/{id}
Get a previously created ScenarioRun.
getScenarioRun 1 param → 200
POST
/v1/scenarios/runs/{id}/cancel
Cancel a Scenario run.
cancelScenarioRun 1 param → 200
POST
/v1/scenarios/runs/{id}/complete
Complete a ScenarioRun.
completeScenarioRun 1 param → 200
POST
/v1/scenarios/runs/{id}/download_logs
Download logs for a Scenario run.
downloadScenarioRunLogs 1 param → 200
POST
/v1/scenarios/runs/{id}/score
Score a ScenarioRun.
scoreScenarioRun 1 param → 200
POST
/v1/scenarios/scorers
Create a custom scenario scorer.
createCustomScorer body → 200400
GET
/v1/scenarios/scorers
List Scenario Scorers.
listScenarioScorers 3 params → 200
POST
/v1/scenarios/scorers/{id}
Update a custom scenario scorer.
updateCustomScorer 1 param body → 200
GET
/v1/scenarios/scorers/{id}
Retrieve Scenario Scorer.
retrieveScenarioScorers 1 param → 200
POST
/v1/scenarios/start_run
Start a new ScenarioRun.
startScenarioRun body → 200
POST
/v1/scenarios/{id}
Update a Scenario.
updateScenario 1 param body → 200
GET
/v1/scenarios/{id}
Get a Scenario.
getScenario 1 param → 200
POST
/v1/scenarios/{id}/archive
Archive a Scenario.
archiveScenario 1 param → 200403404
GET
/v1/scenarios/{id}/runs
Get the runs for a Scenario.
getScenarioRuns 4 params → 200
POST
/v1/scenarios/{id}/unarchive
Unarchive a Scenario.
unarchiveScenario 1 param → 200403404

Schemas 48

The contract defines 48 schemas that model the data the API accepts and returns. The most detailed are LaunchParameters (13 properties), ScenarioDefinitionView (13 properties), ScenarioRunView (13 properties), ScenarioUpdateParameters (10 properties). Each schema is shown below with its type and property counts.

ScenarioEnvironment
object
ScenarioEnvironmentParameters specify the environment in which a Scenario will be run.
4 properties
ScenarioRunListView
object
3 properties 2 required
ScoringContractResultView
object
A ScoringContractResultView represents the result of running all scoring functions on a given input context.
2 properties 2 required
BrokerMount
object
6 properties 2 required
ScoringContract
object
InputContextView specifies the problem statement along with all additional context for a Scenario.
1 property 1 required
LaunchParameters
object
LaunchParameters enable you to customize the resources available to your Devbox as well as the environment set up that should be completed before the Devbox is…
13 properties
ScenarioDefinitionListView
object
3 properties 2 required
FileMount
object
3 properties 3 required
InputContextUpdate
object
2 properties
InputContext
object
InputContextView specifies the problem statement along with all additional context for a Scenario.
2 properties 1 required
LifecycleConfigurationParameters
object
Lifecycle configuration for Devbox idle and resume behavior. Configure idle policy via afteridle and resume triggers via resumetriggers.
2 properties
ScenarioUpdateParameters
object
ScenarioUpdateParameters contain the set of parameters to update a Scenario. All fields are optional - null fields preserve existing values, provided fields re…
10 properties
ScenarioDefinitionView
object
A ScenarioDefinitionView represents a repeatable AI coding evaluation test, complete with initial environment and scoring contract.
13 properties 6 required
AgentMount
object
5 properties 3 required
AstGrepScoringFunction
object
AstGrepScoringFunction utilizes structured coach search for scoring.
4 properties 3 required
ScenarioRunState
string
IdleConfigurationParameters
object
2 properties 2 required
TestBasedScoringFunction
object
TestBasedScoringFunction writes test files to disk and executes a test command to verify the solution.
3 properties 1 required
CustomScoringFunction
object
CustomScoringFunction is a custom, user defined scoring function.
3 properties 2 required
ScenarioScorerView
object
A ScenarioScorerView represents a custom scoring function for a Scenario.
3 properties 3 required
ScenarioRunView
object
A ScenarioRunView represents a single run of a Scenario on a Devbox. When completed, the ScenarioRun will contain the final score and output of the run.
13 properties 5 required
CodeMount
object
6 properties 3 required
Mount
RunProfile
object
5 properties
PythonScriptScoringFunction
object
PythonScriptScoringFunction will run a python script in the context of your environment as a ScoringFunction.
4 properties 2 required
MetadataKeysView
object
1 property
ScenarioCreateParameters
object
10 properties 3 required
ScoringFunction
object
ScoringFunction specifies a method of scoring a Scenario.
3 properties 3 required
IdleAction
string
Action to take after Devbox idle timer is triggered. shutdown: Shutdown the Devbox. suspend: Suspend the Devbox.
CreateCustomScorerParams
object
2 properties 2 required
StartScenarioRunParameters
object
5 properties 1 required
ScoringContractUpdate
object
1 property
ScenarioDefinitionStatus
string
BrokerMountProtocol
string
TestFile
object
2 properties
BashScriptScoringFunction
object
BashScriptScoringFunction is a scoring function specified by a bash script that will be run in the context of your environment.
2 properties 1 required
ValidationType
string
CommandScoringFunction
object
CommandScoringFunction executes a single command and checks the result.The output of the command will be printed. Scoring will passed if the command returns st…
2 properties 1 required
UserParameters
object
Configuration for the Linux user in the Devbox environment.
2 properties 2 required
ScoringFunctionResultView
object
A ScoringFunctionResultView represents the result of running a single scoring function on a given input context.
4 properties 4 required
ObjectMount
object
3 properties 3 required
Architecture
string
ResumeTriggers
object
Triggers that can resume a suspended Devbox.
2 properties
MetadataValuesView
object
2 properties
ScoringFunctionResultViewState
string
ResourceSize
string
The size of the Devbox resources for Runloop to allocate. XSMALL: 0.5 cpu x 1GiB memory x 4GiB disk SMALL: 1 cpu x 2GiB memory x 4GiB disk MEDIUM: 2 cpu x 4GiB…
BuiltInScoringFunction
ScenarioScorersListView
object
3 properties 2 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

runloop-ai-scenario-api-openapi.yml Raw ↑

Other APIs Runloop publishes across the network.

Runloop agents API
AE Profile APIs.io
Runloop apikeys API
AE Profile APIs.io
Runloop axons API
AE Profile APIs.io
Runloop Benchmark API
AE Profile APIs.io
Runloop Blueprint API
AE Profile APIs.io
Runloop Blueprint-Lifecycle API
AE Profile APIs.io
Runloop Blueprint-ObservabilityTools API
AE Profile APIs.io
Runloop Devbox API
AE Profile APIs.io
Runloop Devbox-FileTools API
AE Profile APIs.io
Runloop Devbox-Lifecycle API
AE Profile APIs.io
Runloop Devbox-NetworkTools API
AE Profile APIs.io
Runloop Devbox-ObservabilityTools API
AE Profile APIs.io
#Scenario
← Back to R APIs
API Details
ID
runloop-ai:runloop-ai-scenario-api
Base URL
https://api.runloop.ai
Docs
https://docs.runloop.ai/docs/devboxes/overview
Provider
Runloop
APIs.io →  GitHub →
Explore more
All APIs Providers APIs.io Network
Work with this as data

Every API here is available over the API and to AI agents over MCP. APIs is not yet its own endpoint on the v1 API. Reach this content through network search and the tag graph, or the MCP server below.

Installs https://mcp.apievangelist.com/mcp in Claude, Cursor, VS Code and the rest — one button, every client.

MCP tools for apis
4 tools reach this content
  • search_api_evangelistSearch every content type across the network at once.
  • find_relatedThe shared-tag relevance graph — what else covers this.
  • get_tagEverything one tag labels, across all content types.
  • guide_topicPRO — a curated bundle for a topic: area, guidance, rules, papers, stories, services.
All tools & prompts
Call it yourself
curl for this page
Search the network for this 
curl "https://api.apievangelist.com/v1/search?q=runloop-ai-scenario-api&limit=10"
Everything under a tag 
curl "https://api.apievangelist.com/v1/tags/runloop-ai-scenario-api"

Discovery needs no key. Full bodies and the synthesis endpoints are Pro.

Get an API key

Free tier, no email required. Sign in with whichever identity you already have.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have. Your account

Where this information came from

This is an independent, third-party profile of Runloop Scenario API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.