api-server codebase. The interactive API surface is generated from NestJS Swagger decorators and checked in as mintlify_docs/api-reference/openapi.json.
The CLI and Python SDK cover the most common workflows, while this site documents the full HTTP surface. Some operational resources in the sidebar are intentionally API-first even when the CLI does not expose every endpoint as a first-class command.
What The Current API Server Exposes
Authentication
Username/password login, refresh tokens, OAuth, TOTP, profile updates, and API key management.
Sandboxes
Workspace-scoped sandboxes with image or snapshot boot, file upload, exec, logs, ports, TTL, and snapshots.
Browser Sessions
Remote browser sessions with CDP, VNC, rrweb recording, stealth mode, proxies, and browser profiles.
Notebooks
Notebook sessions plus notebook document, kernel, file, and output APIs.
Workspaces
Workspace lifecycle, membership, secrets, billing, rate limits, and Google OAuth connections.
Deployments
App and static-site deployment APIs backed by snapshots and versioned releases.
Automation & AI
AI gateway routing, workflow orchestration, and analytics surfaces exposed by the current API server.
Operational APIs
Browser profiles, captcha and proxy integrations, managed agents, and webhook ingress routes.
How To Use This Docs Site
Start With A Guide
Use the Guides tab for end-to-end flows such as authentication, sandbox creation, browser sessions, notebook sessions, or workspace setup.
Use Resource Overviews
Each API section starts with a resource overview page that lists the current endpoints exposed by
api-server.Start Here
- New integration: start with Authentication, then Quickstart.
- Runtime workloads: see Sandbox Creation, Browser Sessions, and Notebook Sessions.
- Platform resources: see Workspaces, Billing, Images, and Clusters.
- Automation and AI: see AI Gateway, Workflows, and Analytics.
- Operational APIs: see Browser Profiles, Captcha, Proxy, Managed Agents, and Webhooks.
- Raw endpoint coverage: open API Reference.