Sandbox API Flow

Create, execute, manage files, and tear down a sandbox.

Sandbox API Flow

This guide shows a typical end-to-end flow using the Sandbox API.

1) Register and get an API key

curl -X POST https://api.sandbox.stateset.com/api/v1/register \
  -H "Content-Type: application/json" \
  -d '{"first_name": "Your", "last_name": "Name", "organization_name": "Company", "email": "[e-mail]"}'

2) Create a sandbox

curl -X POST https://api.sandbox.stateset.com/api/v1/sandbox/create \
  -H "Authorization: ApiKey YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"timeout_seconds": 300}'

3) Execute a command

curl -X POST https://api.sandbox.stateset.com/api/v1/sandbox/SANDBOX_ID/execute \
  -H "Authorization: ApiKey YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"command": "python3 -c \"print(Hello World!)\""}'

4) Write a file

curl -X POST https://api.sandbox.stateset.com/api/v1/sandbox/SANDBOX_ID/files/write \
  -H "Authorization: ApiKey YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"path": "/workspace/hello.txt", "content": "SGVsbG8h", "encoding": "base64"}'

5) Read a file

curl -X POST https://api.sandbox.stateset.com/api/v1/sandbox/SANDBOX_ID/files/read \
  -H "Authorization: ApiKey YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"path": "/workspace/hello.txt"}'

6) Stop the sandbox

curl -X POST https://api.sandbox.stateset.com/api/v1/sandbox/SANDBOX_ID/stop \
  -H "Authorization: ApiKey YOUR_API_KEY"

Related Documentation

• Sandbox Quickstart
• API Reference