# Superserve ## Docs - [Get an API key](https://docs.superserve.ai/api-key.md): Create an API key and configure the SDK to authenticate with Superserve. - [Execute a command and stream output via SSE](https://docs.superserve.ai/api-reference/exec/execute-a-command-and-stream-output-via-sse.md): Runs a command and streams stdout/stderr chunks as Server-Sent Events. Each event is a JSON payload. The final event includes `exit_code` and `finished: true`. A paused sandbox is resumed automatically before the command runs and stays active afterward. - [Execute a command inside a sandbox](https://docs.superserve.ai/api-reference/exec/execute-a-command-inside-a-sandbox.md): Runs a command inside the sandbox and waits for it to finish, returning stdout, stderr, and exit code. A paused sandbox is resumed automatically before the command runs and stays active afterward. - [Create a new sandbox](https://docs.superserve.ai/api-reference/sandboxes/create-a-new-sandbox.md): Creates a sandbox from a template (defaults to `superserve/base` when `from_template` is omitted). When the request returns successfully, the sandbox is ready to use — you can run commands against it immediately. - [Delete a sandbox](https://docs.superserve.ai/api-reference/sandboxes/delete-a-sandbox.md) - [Get a sandbox by ID](https://docs.superserve.ai/api-reference/sandboxes/get-a-sandbox-by-id.md) - [List all sandboxes](https://docs.superserve.ai/api-reference/sandboxes/list-all-sandboxes.md): Returns sandboxes belonging to the authenticated team, optionally filtered by metadata tags. - [Partially update a running sandbox](https://docs.superserve.ai/api-reference/sandboxes/partially-update-a-running-sandbox.md): Applies a partial update to a running sandbox. Each top-level field in the request body is optional; only fields that are present are applied. Omitted top-level fields are left unchanged. Nested objects are full replacements when present — to clear a list, send it as an empty array. - [Pause a running sandbox](https://docs.superserve.ai/api-reference/sandboxes/pause-a-running-sandbox.md): Snapshots the sandbox's full state (memory + disk), suspends the VM, and transitions to `paused`. Resume it later to continue exactly where it left off — same memory, same running processes, same files. - [Resume a paused sandbox](https://docs.superserve.ai/api-reference/sandboxes/resume-a-paused-sandbox.md): Restores the sandbox from its paused snapshot. Transitions back to `active` with all state intact — same memory, same processes, same files. - [Cancel an in-flight build](https://docs.superserve.ai/api-reference/templates/cancel-an-in-flight-build.md): Cancels an in-flight build. No-op for builds already in a terminal state. - [Create a template and kick off the first build](https://docs.superserve.ai/api-reference/templates/create-a-template-and-kick-off-the-first-build.md): Creates a template and queues the first build. The response includes both the template id and the build id, so clients can immediately poll `GET /templates/{id}` for overall status or subscribe to `GET /templates/{id}/builds/{build_id}/logs` for live output. - [Delete a template](https://docs.superserve.ai/api-reference/templates/delete-a-template.md): Delete a template owned by the caller's team. Returns `409` if any active or paused sandbox still references this template, or if a build is currently in progress; cancel those first. - [Get a build by ID](https://docs.superserve.ai/api-reference/templates/get-a-build-by-id.md) - [Get a template by ID](https://docs.superserve.ai/api-reference/templates/get-a-template-by-id.md) - [List recent builds for a template](https://docs.superserve.ai/api-reference/templates/list-recent-builds-for-a-template.md) - [List templates visible to the caller](https://docs.superserve.ai/api-reference/templates/list-templates-visible-to-the-caller.md): Returns the caller's team's templates plus the curated system templates (available to everyone, identified by the `superserve/` name prefix — e.g. `superserve/base`, `superserve/python-3.11`, `superserve/node-22`). Filter by `name_prefix=`. - [Rebuild an existing template](https://docs.superserve.ai/api-reference/templates/rebuild-an-existing-template.md): Queues a new build for this template. Used to retry after a failed build, or to rebuild when the base image has been updated. - [Stream build logs via SSE](https://docs.superserve.ai/api-reference/templates/stream-build-logs-via-sse.md): Server-Sent Events stream of the build's stdout/stderr. Connecting replays buffered output from the start of the build, then streams live as it arrives. Closes when the build reaches a terminal state. - [Run commands in a sandbox](https://docs.superserve.ai/commands/overview.md): Execute shell commands inside a sandbox with sync or streaming output. - [Stream command output](https://docs.superserve.ai/commands/streaming.md): Subscribe to stdout and stderr chunks as they arrive over Server-Sent Events. - [Errors](https://docs.superserve.ai/errors.md): Typed errors thrown by the Superserve SDK and when to catch each one. - [Read and write files](https://docs.superserve.ai/filesystem/read-write.md): Upload and download files to and from a sandbox's filesystem. - [Introduction](https://docs.superserve.ai/introduction.md): Superserve provides sandbox infrastructure to run code in isolated cloud environments powered by Firecracker MicroVMs. - [Quickstart](https://docs.superserve.ai/quickstart.md): Create your first sandbox, run a command, and read a file - in under five minutes. - [Connect to an existing sandbox](https://docs.superserve.ai/sandbox/connect.md): Reconnect to a sandbox you created earlier using its ID, and list sandboxes on your team. - [Create a sandbox](https://docs.superserve.ai/sandbox/create.md): Spin up an isolated Firecracker MicroVM in seconds, ready to run commands immediately. - [Environment variables](https://docs.superserve.ai/sandbox/environment-variables.md): Inject environment variables at sandbox creation - applied to every process spawned inside the VM. - [Pause, resume, and delete](https://docs.superserve.ai/sandbox/lifecycle.md): Manage sandbox state - pause to save compute costs, resume on demand, delete when you're done. - [Metadata tags](https://docs.superserve.ai/sandbox/metadata.md): Attach string key-value tags to sandboxes, update them later, and filter sandboxes by tag. - [Network rules](https://docs.superserve.ai/sandbox/networking.md): Lock down sandbox egress to specific CIDRs or domains with allow and deny lists. - [Commands](https://docs.superserve.ai/sdk-reference/commands.md): sandbox.commands - run shell commands with sync results or streaming output. - [Files](https://docs.superserve.ai/sdk-reference/files.md): sandbox.files - read and write files inside a sandbox's filesystem. - [Sandbox](https://docs.superserve.ai/sdk-reference/sandbox.md): The Sandbox class - factory methods, sandbox methods, properties, and types. - [Template](https://docs.superserve.ai/sdk-reference/template.md): The Template class - factory methods, instance methods, properties, and types. - [BuildSpec reference](https://docs.superserve.ai/templates/build-spec.md): How to describe a template's base image, build steps, and runtime defaults - [Create a template](https://docs.superserve.ai/templates/create.md): Build your first team template, stream logs, launch a sandbox from it - [Rebuild, cancel, delete](https://docs.superserve.ai/templates/lifecycle.md): Manage a template over time: trigger new builds, cancel in-flight ones, delete stale templates - [Templates](https://docs.superserve.ai/templates/overview.md): Reusable base images with build steps that sandboxes boot from ## OpenAPI Specs - [openapi](https://raw.githubusercontent.com/superserve-ai/sandbox/refs/heads/main/api/openapi.yaml)