Sandflare JavaScript SDK

The official JavaScript and TypeScript SDK for creating and managing Sandflare sandboxes.

Install

npm install @sandflare/sdk

Quick start

import { Sandbox } from '@sandflare/sdk'

const sandbox = await Sandbox.create('agent', { memoryMb: 512 })
const result = await sandbox.runNode('console.log(2 + 3)')

console.log(result.stdout.trim())

await sandbox.delete()

Python-style workloads

import { Sandbox } from '@sandflare/sdk'

const sandbox = await Sandbox.create('python-agent', { memoryMb: 512 })
const result = await sandbox.runPython('print(2 + 3)')

console.log(result.stdout.trim())

await sandbox.delete()

Environment variables

• SANDFLARE_API_KEY: preferred API key
• SANDFLARE_API_URL: optional API base URL override
• PANDAAGENT_API_KEY: legacy API key alias
• PANDAAGENT_BASE_URL: legacy base URL alias

Main sandbox methods

• Sandbox.create(label, options)
• Sandbox.get(name)
• Sandbox.list()
• sandbox.health()
• sandbox.exec(cmd, options)
• sandbox.execStream(cmd, options)
• sandbox.runNode(code, options)
• sandbox.runPython(code, options)
• sandbox.runCode(code, options) for JavaScript/Node snippets
• sandbox.writeFile(path, content)
• sandbox.readFile(path)
• sandbox.uploadFile(path, content)
• sandbox.downloadFile(path)
• sandbox.ls(path)
• sandbox.install(pkg, runtime)
• sandbox.createSnapshot()
• sandbox.listSnapshots()
• sandbox.delete()
• sandbox.metrics() — live CPU/memory/disk usage
• sandbox.killProcess(pid) — kill a process by PID
• sandbox.gitClone(repo, options) — clone a git repo into sandbox
• sandbox.execStreamIter(cmd) — async generator for streaming stdout/stderr
• sandbox.openTerminal(opts) — open WebSocket terminal

Custom templates

Build a sandbox template from a Dockerfile:

• Template.build(name, dockerfile, options) — start a build job
• Template.waitForBuild(id, options) — poll until ready
• Template.getBuildStatus(id, options) — get current build status
• Template.list(options) — list all templates
• Template.delete(id, options) — delete a custom template

Local development

cd sdk/javascript
npm install
npm run build

Docs

• Docs: https://docs.sandflare.io
• API base URL: https://api.sandflare.io