Runloop Devbox API

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

Business capability
Environment Management BC-4210.20

Operations 42

GET /pty/{session_name} Create or reconnect to a PTY session #
POST /pty/{session_name}/control Send a control command to a PTY session #
POST /v1/devboxes Create a Devbox #
GET /v1/devboxes List Devboxes #
GET /v1/devboxes/disk_snapshots List disk snapshots of a Devbox #
GET /v1/devboxes/disk_snapshots/list_public List public disk snapshots #
GET /v1/devboxes/disk_snapshots/metadata/keys List available snapshot metadata keys #
GET /v1/devboxes/disk_snapshots/metadata/keys/{key}/values List values for a specific snapshot metadata key #
GET /v1/devboxes/disk_snapshots/public/metadata/keys List available public snapshot metadata keys #
GET /v1/devboxes/disk_snapshots/public/metadata/keys/{key}/values List values for a specific public snapshot metadata key #
POST /v1/devboxes/disk_snapshots/{id} Update metadata of Disk Snapshot #
POST /v1/devboxes/disk_snapshots/{id}/delete Delete a disk snapshot of a Devbox #
GET /v1/devboxes/disk_snapshots/{id}/status Query the status of an asynchronous disk snapshot #
GET /v1/devboxes/metadata/keys List available devbox metadata keys #
GET /v1/devboxes/metadata/keys/{key}/values List values for a specific devbox metadata key #
GET /v1/devboxes/{devbox_id}/executions/{execution_id} Get status of an asynchronous execution on a Devbox #
POST /v1/devboxes/{devbox_id}/executions/{execution_id}/kill Kill an asynchronous execution currently running on a devbox #
POST /v1/devboxes/{devbox_id}/executions/{execution_id}/send_std_in Send Content to Std In for a running execution #
POST /v1/devboxes/{devbox_id}/executions/{execution_id}/wait_for_status Wait for an asynchronous execution to reach a specific status #
POST /v1/devboxes/{id} Update a Devbox #
GET /v1/devboxes/{id} Get Devbox details #
POST /v1/devboxes/{id}/create_pty_tunnel Create an ephemeral PTY tunnel for a running Devbox #
POST /v1/devboxes/{id}/create_ssh_key Create an SSH key for a Devbox #
POST /v1/devboxes/{id}/download_file Download binary file contents from Devbox filesystem #
POST /v1/devboxes/{id}/enable_tunnel Enable a tunnel for a running Devbox #
POST /v1/devboxes/{id}/execute Execute a command with a known ID, optimistically waiting for completion #
POST /v1/devboxes/{id}/execute_async Asynchronously execute a command via the Devbox shell #
POST /v1/devboxes/{id}/execute_sync (Deprecated, please use /execute_async) Synchronously execute a shell command… #
POST /v1/devboxes/{id}/keep_alive Reset the idle timer of a running Devbox #
GET /v1/devboxes/{id}/logs Get Devbox logs #
GET /v1/devboxes/{id}/logs/tail Live Tail Devbox Logs #
POST /v1/devboxes/{id}/read_file_contents Read text file contents from Devbox filesystem #
POST /v1/devboxes/{id}/remove_tunnel Remove a tunnel from the Devbox #
POST /v1/devboxes/{id}/resume Resume a suspended Devbox #
POST /v1/devboxes/{id}/shutdown Shutdown a running Devbox #
POST /v1/devboxes/{id}/snapshot_disk Synchronously create a disk snapshot of a running Devbox #
POST /v1/devboxes/{id}/snapshot_disk_async Start an asynchronous disk snapshot of a running Devbox #
POST /v1/devboxes/{id}/suspend Suspend a running Devbox #
POST /v1/devboxes/{id}/upload_file Upload binary file contents to Devbox filesystem #
GET /v1/devboxes/{id}/usage Get resource usage for a Devbox #
POST /v1/devboxes/{id}/wait_for_status Wait for a Devbox to reach one of the specified statuses #
POST /v1/devboxes/{id}/write_file_contents Write text file contents to Devbox filesystem #

Documentation

Specifications

Schemas & Data

📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/runloop-ai/refs/heads/main/json-schema/runloop-devbox-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/runloop-ai/refs/heads/main/json-schema/runloop-execution-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/runloop-ai/refs/heads/main/json-schema/runloop-snapshot-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/runloop-ai/refs/heads/main/json-schema/runloop-tunnel-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/runloop-ai/refs/heads/main/json-schema/runloop-launch-parameters-schema.json
📊
JSONStructure
https://raw.githubusercontent.com/api-evangelist/runloop-ai/refs/heads/main/json-structure/runloop-devbox-structure.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/runloop-ai/refs/heads/main/json-schema/runloop-blueprint-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/runloop-ai/refs/heads/main/json-schema/runloop-benchmark-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/runloop-ai/refs/heads/main/json-schema/runloop-benchmark-run-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/runloop-ai/refs/heads/main/json-schema/runloop-scenario-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/runloop-ai/refs/heads/main/json-schema/runloop-agent-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/runloop-ai/refs/heads/main/json-schema/runloop-axon-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/runloop-ai/refs/heads/main/json-schema/runloop-object-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/runloop-ai/refs/heads/main/json-schema/runloop-secret-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/runloop-ai/refs/heads/main/json-schema/runloop-network-policy-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/runloop-ai/refs/heads/main/json-schema/runloop-gateway-config-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/runloop-ai/refs/heads/main/json-schema/runloop-mcp-config-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/runloop-ai/refs/heads/main/json-schema/runloop-api-key-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/runloop-ai/refs/heads/main/json-schema/runloop-restricted-key-schema.json

Other Resources

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API
curl "https://apis.io/api/v1/apis/runloop-ai:runloop-ai-devbox-api"
All apis
curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

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

OpenAPI Specification

runloop-ai-devbox-api-openapi.yml Raw ↑
openapi: 3.2.0
info:
  title: RunLoop Devbox API
  version: '0.1'
  description: The RunLoop API spec that allows you to host lambda functions and Devboxes to enable scaled long running ai workflows.
  contact:
    name: Runloop AI Support
    url: https://runloop.ai
    email: support@runloop.ai
servers:
- url: https://api.runloop.ai
  description: Runloop API
  variables: {}
security:
- bearerAuth: []
tags:


# --- truncated at 32 KB (97 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/runloop-ai/refs/heads/main/openapi/runloop-ai-devbox-api-openapi.yml