Runloop Devbox API
Create, configure, and operate Devboxes — isolated Linux microVM-backed sandbox environments purpose-built for AI coding agents. The Devbox API covers the full lifecycle (create, suspend, resume, snapshot, shutdown), synchronous and asynchronous command execution, named shell sessions, file I/O, code-repo mounts, agent and storage object mounts, network tunnels with HTTPS URLs, SSH key issuance, and rich observability (executions, metrics, logs). Includes the PTY control-plane for interactive WebSocket shell sessions.
Documentation
Documentation
https://docs.runloop.ai/docs/devboxes/overview
Documentation
https://docs.runloop.ai/docs/devboxes/lifecycle
Documentation
https://docs.runloop.ai/docs/devboxes/execute-commands
Documentation
https://docs.runloop.ai/docs/devboxes/files
Documentation
https://docs.runloop.ai/docs/devboxes/named-shells
Documentation
https://docs.runloop.ai/docs/devboxes/snapshots
Documentation
https://docs.runloop.ai/docs/devboxes/start-stop
Documentation
https://docs.runloop.ai/docs/devboxes/tunnels
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
Other Resources
JSONLD
https://raw.githubusercontent.com/api-evangelist/runloop-ai/refs/heads/main/json-ld/runloop-context.jsonld
Examples
https://raw.githubusercontent.com/api-evangelist/runloop-ai/refs/heads/main/examples/runloop-devbox-create-example.json
Examples
https://raw.githubusercontent.com/api-evangelist/runloop-ai/refs/heads/main/examples/runloop-devbox-exec-example.json
Examples
https://raw.githubusercontent.com/api-evangelist/runloop-ai/refs/heads/main/examples/runloop-snapshot-create-example.json
APIsJSON
https://raw.githubusercontent.com/api-evangelist/runloop-ai/refs/heads/main/apis.yml
Arazzo
https://raw.githubusercontent.com/api-evangelist/runloop-ai/refs/heads/main/arazzo/runloop-ai-bootstrap-devbox-from-object-workflow.yml
Arazzo
https://raw.githubusercontent.com/api-evangelist/runloop-ai/refs/heads/main/arazzo/runloop-ai-build-blueprint-and-launch-devbox-workflow.yml
Arazzo
https://raw.githubusercontent.com/api-evangelist/runloop-ai/refs/heads/main/arazzo/runloop-ai-create-scenario-and-run-workflow.yml
Arazzo
https://raw.githubusercontent.com/api-evangelist/runloop-ai/refs/heads/main/arazzo/runloop-ai-graceful-snapshot-and-shutdown-workflow.yml
Arazzo
https://raw.githubusercontent.com/api-evangelist/runloop-ai/refs/heads/main/arazzo/runloop-ai-provision-and-run-command-workflow.yml
Arazzo
https://raw.githubusercontent.com/api-evangelist/runloop-ai/refs/heads/main/arazzo/runloop-ai-publish-object-artifact-workflow.yml
Arazzo
https://raw.githubusercontent.com/api-evangelist/runloop-ai/refs/heads/main/arazzo/runloop-ai-score-running-scenario-run-workflow.yml
Arazzo
https://raw.githubusercontent.com/api-evangelist/runloop-ai/refs/heads/main/arazzo/runloop-ai-snapshot-and-restore-devbox-workflow.yml
Arazzo
https://raw.githubusercontent.com/api-evangelist/runloop-ai/refs/heads/main/arazzo/runloop-ai-suspend-and-resume-devbox-workflow.yml
Arazzo
https://raw.githubusercontent.com/api-evangelist/runloop-ai/refs/heads/main/arazzo/runloop-ai-write-execute-read-file-workflow.yml