Execute a command and stream output via SSE

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.

POST /sandboxes/{sandbox_id}/exec/stream

Execute a command and stream output via SSE

cURL

curl --request POST \
  --url https://api-staging.superserve.ai/sandboxes/{sandbox_id}/exec/stream \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <api-key>' \
  --data '
{
  "command": "<string>",
  "args": [
    "<string>"
  ],
  "env": {},
  "working_dir": "<string>",
  "timeout_s": 30
}
'

200

{
  "timestamp": "2023-11-07T05:31:56Z",
  "stdout": "<string>",
  "stderr": "<string>",
  "exit_code": 123,
  "finished": true,
  "error": "<string>"
}

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.

Show child attributes

working_dir · string

Working directory (default /home/user).

timeout_s · integer · default: 30

Timeout in seconds.

Response

200

text/event-stream

SSE stream. Each line starting with data: contains a JSON ExecStreamEvent. The final event has finished: true.

A single SSE event payload emitted by the exec/stream endpoint. stdout/stderr are JSON strings — see ExecResult for the UTF-8 caveat on binary output. The stream also emits SSE comment frames (: keepalive\n\n) every 15s to keep proxies from closing idle connections; parsers MUST ignore lines that don't start with data: .

timestamp · string<date-time>

stdout · string

Stdout chunk (present when the process wrote to stdout).

stderr · string

Stderr chunk (present when the process wrote to stderr).

exit_code · integer

Process exit code (present on the final event).

finished · boolean

True on the final event.

error · string

Error message if the exec itself failed (present on the final event on error).