Skip to main content
POST
/
sandboxes
/
{sandbox_id}
/
exec
Execute a command inside a sandbox
curl --request POST \
  --url https://api.superserve.ai/sandboxes/{sandbox_id}/exec \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <api-key>' \
  --data '
{
  "command": "<string>",
  "args": [
    "<string>"
  ],
  "env": {},
  "working_dir": "<string>",
  "timeout_s": 30
}
'
{
  "stdout": "<string>",
  "stderr": "<string>",
  "exit_code": 123
}

Authorizations

​
X-API-Key
string
header
required

Path Parameters

​
sandbox_id
string<uuid>
required

The unique identifier of the sandbox.

Body

application/json
​
command
string
required

Command to execute. Wrapped in /bin/sh -c unless args is provided.

Minimum string length: 1
​
args
string[]

If provided, command is used as the binary and args as arguments (no shell wrapping).

​
env
object

Environment variables for the command.

​
working_dir
string

Working directory (default /home/user).

​
timeout_s
integer
default:30

Timeout in seconds.

Response

Command executed

stdout and stderr are JSON strings, which require valid UTF-8. Non-UTF-8 bytes are replaced with U+FFFD. To capture binary output, redirect it to a file in the sandbox and download via the files API.

​
stdout
string
​
stderr
string
​
exit_code
integer