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 Devbox API

The Devbox API from Runloop — 40 operation(s) for devbox.

Documentation Provider Profile APIs.io OpenAPI GitHub

Runloop Devbox 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 Devbox. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, a JSON-LD context, and 19 JSON Schemas.

This API exposes 42 operations across 40 paths, and defines 68 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.

42 operations 40 paths 68 schemas 16 GET26 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 Devbox API declares 1 security scheme for authenticating requests. It accepts HTTP bearer tokens (bearerAuth). By default, every request must be authenticated.

Paths & Operations 42

Across 40 paths, the API surfaces 42 operations — 16 GET, 26 POST. Each is listed below with its method, path, parameters, and response codes.

Devbox 42
GET
/pty/{session_name}
Create or reconnect to a PTY session.
connectDevboxPtySession 3 params → 200400503
POST
/pty/{session_name}/control
Send a control command to a PTY session.
controlDevboxPtySession 1 param body → 200400404
POST
/v1/devboxes
Create a Devbox.
createDevbox body → 200
GET
/v1/devboxes
List Devboxes.
listDevboxes 4 params → 200
GET
/v1/devboxes/disk_snapshots
List disk snapshots of a Devbox.
getDevboxDiskSnapshotList 7 params → 200404
GET
/v1/devboxes/disk_snapshots/list_public
List public disk snapshots.
listPublicSnapshots 7 params → 200
GET
/v1/devboxes/disk_snapshots/metadata/keys
List available snapshot metadata keys.
getSnapshotMetadataKeys → 200
GET
/v1/devboxes/disk_snapshots/metadata/keys/{key}/values
List values for a specific snapshot metadata key.
getSnapshotMetadataValues 1 param → 200400
GET
/v1/devboxes/disk_snapshots/public/metadata/keys
List available public snapshot metadata keys.
getPublicSnapshotMetadataKeys → 200
GET
/v1/devboxes/disk_snapshots/public/metadata/keys/{key}/values
List values for a specific public snapshot metadata key.
getPublicSnapshotMetadataValues 1 param → 200400
POST
/v1/devboxes/disk_snapshots/{id}
Update metadata of Disk Snapshot.
updateDiskSnapshot 1 param body → 200404
POST
/v1/devboxes/disk_snapshots/{id}/delete
Delete a disk snapshot of a Devbox.
deleteSnapshot 1 param → 200404409
GET
/v1/devboxes/disk_snapshots/{id}/status
Query the status of an asynchronous disk snapshot.
queryDiskSnapshotAsync 1 param → 200404
GET
/v1/devboxes/metadata/keys
List available devbox metadata keys.
getDevboxMetadataKeys → 200
GET
/v1/devboxes/metadata/keys/{key}/values
List values for a specific devbox metadata key.
getDevboxMetadataValues 1 param → 200400
GET
/v1/devboxes/{devbox_id}/executions/{execution_id}
Get status of an asynchronous execution on a Devbox.
queryAsyncCommand 3 params → 200404
POST
/v1/devboxes/{devbox_id}/executions/{execution_id}/kill
Kill an asynchronous execution currently running on a devbox
killAsyncExecution 2 params body → 200404
POST
/v1/devboxes/{devbox_id}/executions/{execution_id}/send_std_in
Send Content to Std In for a running execution.
sendStdIn 2 params body → 200404
POST
/v1/devboxes/{devbox_id}/executions/{execution_id}/wait_for_status
Wait for an asynchronous execution to reach a specific status.
waitForCommandCompletion 3 params body → 200400404408
POST
/v1/devboxes/{id}
Update a Devbox.
updateDevbox 1 param body → 200
GET
/v1/devboxes/{id}
Get Devbox details.
getDevbox 1 param → 200
POST
/v1/devboxes/{id}/create_pty_tunnel
Create an ephemeral PTY tunnel for a running Devbox.
createDevboxPtyTunnel 1 param → 200400404
POST
/v1/devboxes/{id}/create_ssh_key
Create an SSH key for a Devbox
createDevboxSshKey 1 param → 200404
POST
/v1/devboxes/{id}/download_file
Download binary file contents from Devbox filesystem.
devboxDownloadFile 1 param body → 200404
POST
/v1/devboxes/{id}/enable_tunnel
Enable a tunnel for a running Devbox.
enableDevboxTunnel 1 param body → 200400404
POST
/v1/devboxes/{id}/execute
Execute a command with a known ID, optimistically waiting for completion
executeCommand 2 params body → 200404408
POST
/v1/devboxes/{id}/execute_async
Asynchronously execute a command via the Devbox shell
execAsyncCommand 1 param body → 200404
POST
/v1/devboxes/{id}/execute_syncdeprecated
(Deprecated, please use /executeasync) Synchronously execute a shell command on a Devbox
execSyncCommand 1 param body → 200
POST
/v1/devboxes/{id}/keep_alive
Reset the idle timer of a running Devbox.
keepAliveDevbox 1 param → 200
GET
/v1/devboxes/{id}/logs
Get Devbox logs.
listDevboxLogs 3 params → 200404
GET
/v1/devboxes/{id}/logs/tail
Live Tail Devbox Logs.
tailDevboxLogs 3 params → 200404
POST
/v1/devboxes/{id}/read_file_contents
Read text file contents from Devbox filesystem.
devboxReadFileContents 1 param body → 200404
POST
/v1/devboxes/{id}/remove_tunnel
Remove a tunnel from the Devbox.
removeDevboxTunnel 1 param → 200404
POST
/v1/devboxes/{id}/resume
Resume a suspended Devbox
resumeDevbox 1 param → 200400404
POST
/v1/devboxes/{id}/shutdown
Shutdown a running Devbox.
shutdownDevbox 2 params → 200409
POST
/v1/devboxes/{id}/snapshot_disk
Synchronously create a disk snapshot of a running Devbox.
createDiskSnapshot 1 param body → 200404
POST
/v1/devboxes/{id}/snapshot_disk_async
Start an asynchronous disk snapshot of a running Devbox.
createDiskSnapshotAsync 1 param body → 200404
POST
/v1/devboxes/{id}/suspend
Suspend a running Devbox
suspendDevbox 1 param → 200400404
POST
/v1/devboxes/{id}/upload_file
Upload binary file contents to Devbox filesystem.
devboxUploadFile 1 param body → 200404
GET
/v1/devboxes/{id}/usage
Get resource usage for a Devbox.
getDevboxResourceUsage 1 param → 200404
POST
/v1/devboxes/{id}/wait_for_status
Wait for a Devbox to reach one of the specified statuses.
waitForDevboxStatus 1 param body → 200400404408
POST
/v1/devboxes/{id}/write_file_contents
Write text file contents to Devbox filesystem.
devboxWriteFileContents 1 param body → 200404

Schemas 68

The contract defines 68 schemas that model the data the API accepts and returns. The most detailed are DevboxView (18 properties), DevboxCreateParameters (16 properties), LaunchParameters (13 properties), PtyConnectView (9 properties). Each schema is shown below with its type and property counts.

DevboxViewStatus
string
The status of the Devbox. provisioning: Runloop is allocating and booting the necessary infrastructure resources. initializing: Runloop defined boot scripts ar…
DevboxViewFailureReason
string
The category of failure experienced by the Devbox. outofmemory: The Devbox ran out of memory at runtime. Use launch parameters to request a larger resource siz…
BrokerMount
object
6 properties 2 required
DevboxListView
object
3 properties 2 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
McpSpecView
object
2 properties 2 required
FileMount
object
3 properties 3 required
GatewaySpec
object
GatewaySpec links an agent gateway configuration to a secret for credential proxying in a devbox. The agent gateway will proxy requests to external APIs using…
2 properties 2 required
DevboxSnapshotStatus
string
LifecycleConfigurationParameters
object
Lifecycle configuration for Devbox idle and resume behavior. Configure idle policy via afteridle and resume triggers via resumetriggers.
2 properties
SignalType
string
DevboxStartExecutionParameters
object
4 properties 2 required
DevboxDiskSnapshotView
object
8 properties 4 required
PtyControlResultView
object
2 properties
TunnelAuthModeView
string
AgentMount
object
5 properties 3 required
DevboxDownloadFileParameters
object
1 property 1 required
DevboxCreateExecutionParameters
object
3 properties 1 required
IdleConfigurationParameters
object
2 properties 2 required
Number
object
PtyControlAction
string
PtyControlParameters
object
4 properties
DevboxLog
object
8 properties 3 required
FileUpload
object
2 properties 1 required
PtyConnectView
object
9 properties 2 required
CodeMount
object
6 properties 3 required
TunnelConfig
object
Configuration for creating a V2 tunnel. When specified at Devbox creation, a tunnel will be automatically provisioned.
3 properties
Mount
DevboxKillExecutionRequest
object
1 property
EmptyRecord
object
GatewaySpecView
object
2 properties 2 required
TunnelAuthMode
string
MetadataKeysView
object
1 property
DevboxWaitForStatusRequest
object
2 properties 1 required
PtyTunnelView
object
An ephemeral PTY tunnel providing authenticated terminal access to a Devbox. These tunnels are not stored on the Devbox and are generated fresh on each request…
2 properties 2 required
DevboxCapabilities
string
InitiatorType
string
IdleAction
string
Action to take after Devbox idle timer is triggered. shutdown: Shutdown the Devbox. suspend: Suspend the Devbox.
DevboxCreateParameters
object
16 properties
DevboxViewShutdownReason
string
The reason that caused the transition of the Devbox to the shutown state. apishutdown: The Devbox shutdown due to API request. entrypointexit: The Devbox entry…
DevboxLogSource
string
McpSpec
object
[Beta] McpSpec links an MCP configuration to a secret for MCP server access in a devbox. The MCP hub will proxy requests to upstream MCP servers using the spec…
2 properties 2 required
DevboxExecutionStatus
string
DevboxReadFileParameters
object
1 property 1 required
CodeMountParameters
object
5 properties 2 required
DevboxSnapshotAsyncStatusView
object
3 properties 1 required
DevboxSnapshotRequest
object
3 properties
DevboxWriteFileParameters
object
2 properties 2 required
DevboxAsyncExecutionDetailView
object
9 properties 3 required
DevboxSendStdInRequest
object
2 properties
DevboxDiskSnapshotListView
object
3 properties 2 required
DevboxSendStdInResult
object
3 properties 3 required
DevboxView
object
A Devbox represents a virtual development environment. It is an isolated sandbox that can be given to agents and used to run arbitrary code such as AI generate…
18 properties 8 required
BrokerMountProtocol
string
DevboxStateTransition
object
2 properties
DevboxResourceUsageView
object
9 properties 8 required
UserParameters
object
Configuration for the Linux user in the Devbox environment.
2 properties 2 required
DevboxCreateSshKeyView
object
4 properties 4 required
TunnelView
object
A V2 tunnel provides secure HTTP access to services running on a Devbox. Tunnels allow external clients to reach web servers, APIs, or other HTTP services runn…
6 properties 5 required
ResumeTriggers
object
Triggers that can resume a suspended Devbox.
2 properties
DevboxExecutionDetailView
object
5 properties 4 required
DevboxUpdateParameters
object
2 properties
Architecture
string
MetadataValuesView
object
2 properties
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…
DevboxLogsListView
object
1 property 1 required
DevboxWaitForCommandRequest
object
2 properties 1 required
ObjectMount
object
3 properties 3 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

runloop-ai-devbox-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-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
Runloop Devbox-PersistenceTools API
AE Profile APIs.io
#Devbox
← Back to R APIs
API Details
ID
runloop-ai:runloop-ai-devbox-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-devbox-api&limit=10"
Everything under a tag 
curl "https://api.apievangelist.com/v1/tags/runloop-ai-devbox-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 Devbox 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.