Choose A Client
Python SDK
Application code, notebooks, scripts, agents, and the broadest management surface.
TypeScript SDK
Node and browser apps that create machines, run commands, manage files, use templates, volumes, and Functions.
CLI
Terminal workflows, CI scripts, local credential setup, MCP schemas, and operator inspection.
Raw HTTP API
Direct REST, SSE, and WebSocket integration from any language.
Local MCP
Let Codex, Claude Code, Cursor, VS Code, or another agent call Nullspace tools.
Configuration
API key, API URL, environment variables,
.env, and local config precedence.Install
nullspace-sdk, the
Python import package is nullspace, the CLI command is nullspace, and the
TypeScript package is @nullspace/sdk.
Supported Python versions are 3.11, 3.12, and 3.13. The TypeScript SDK
requires Node 18+.
Configure
For scripts, CI, and agents:.env, and
local config. The TypeScript SDK reads explicit constructor options and
environment variables when process.env is available. See
SDK Config for precedence.
First Machine
Surface Map
| Surface | Use it for |
|---|---|
| Machines | Create, connect, list, snapshot, fork, hibernate/resume, set timeout, and destroy isolated runtimes. |
| Commands | Run foreground, streaming, and background commands; inspect processes and logs. |
| Filesystem | Read, write, upload, download, search, replace, and watch machine files. |
| Code interpreter | Run stateful notebook-style code with structured results and artifacts. |
| Templates | Build reusable environments from images, Dockerfiles, and builder steps. |
| Volumes | Create persistent shared filesystems, mount them into machines, and transfer data. |
| Functions | Package code as named jobs or services backed by isolated machines. |
| Computer use | Automate GUI desktops, screenshots, input, viewer sessions, and recordings. |
| Networking | Preview URLs, WebSockets, custom proxies, tokens, and traffic policy. |
| Access | PTY, SSH, and retained-machine debugging. |
| Observability | Lifecycle history, webhooks, monitor streams, metrics, and usage. |
Reference Paths
Python SDK task guides
Install, configure, and use Python SDK surfaces.
Python SDK objects
Object-level reference for machine, commands, files, templates, volumes, code, desktop, and errors.
TypeScript SDK
TypeScript install, configuration, examples, exported types, and coverage notes.
CLI
CLI installation, authentication, commands, schema, and exit codes.
API reference
Generated OpenAPI operations, schemas, and examples.
Supported clients
Compare SDKs, CLI, MCP, HTTP, and console surfaces.