Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.superserve.ai/llms.txt

Use this file to discover all available pages before exploring further.

Install the SDK, set your API key, and create a sandbox.

​
1. Install the SDK

npm install @superserve/sdk

​
2. Set your API key

Grab your API key from the Superserve Console and export it. 
export SUPERSERVE_API_KEY=ss_live_...
See Get an API key for more options.

​
3. Create a sandbox and run a command

import { Sandbox } from "@superserve/sdk"

const sandbox = await Sandbox.create({ name: "quickstart" })

const result = await sandbox.commands.run("echo 'Hello from Superserve!'")
console.log(result.stdout)

await sandbox.files.write("/tmp/hello.txt", "Hello, world!")
const content = await sandbox.files.readText("/tmp/hello.txt")
console.log(content)

await sandbox.kill()

​
Where to go next

Run commands

Sync, streaming, cwd, env, timeouts.

Pause & resume

Checkpoint state to save money between runs.

Metadata

Tag and query sandboxes at scale.

Networking

Restrict egress to specific domains or CIDRs.