Skip to main content
The API Reference is generated from the repository OpenAPI spec. Most operations under /v1/... are customer-facing hosted private-beta APIs used by the Python SDK, CLI, MCP server, and console.

​
Public Integration Surfaces

Use the generated reference for:
  • Sandbox lifecycle, execution, processes, files, snapshots, metrics, public URLs, and timeouts.
  • Code interpreter contexts, runs, streaming, packages, and artifacts.
  • Desktop automation, managed viewer sessions, recordings, and PTY sessions.
  • Templates, template builds, logs, tags, aliases, visibility, and namespace workflows.
  • Volumes, direct volume files, uploads, downloads, and attached-volume actions.
  • Lifecycle events, lifecycle webhooks, monitor streams, and operator-issued private-beta API keys.
These surfaces are also documented by topic throughout this site. Self-serve Auth, account, and key-management operations remain in the generated OpenAPI contract because the plumbing exists in the repository. They are dormant for the current private-beta e2e and are not public signup surfaces until NULLSPACE_SELF_SERVE_AUTH_ENABLED=true is explicitly launched.

​
Internal Operations

Routes under /internal/... are operator and platform-control APIs. They remain in the repository spec so the open-source platform can validate its full contract, but they are marked x-excluded and should not appear in the public generated API Reference. Do not build product integrations against internal runtime-host registration, runtime-host heartbeat, readiness, volume-backend maintenance, credential rotation, host-loss, or provisioning routes unless the Nullspace team explicitly asks you to operate the platform itself.

​
Hosted Endpoint

Hosted private-beta examples use NULLSPACE_API_URL: 
export NULLSPACE_API_URL=https://api.your-nullspace-domain
Current private-beta endpoint values live in Hosted endpoints. Local development defaults to http://localhost:3000 when no base URL is set.