Run Command (Stream)

curl --request POST \
  --url https://api.declaw.ai/sandboxes/{sandbox_id}/commands/stream \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <api-key>' \
  --data '
{
  "cmd": "<string>",
  "cwd": "<string>",
  "envs": {},
  "timeout": 123,
  "user": "<string>"
}
'

import requests

url = "https://api.declaw.ai/sandboxes/{sandbox_id}/commands/stream"

payload = {
    "cmd": "<string>",
    "cwd": "<string>",
    "envs": {},
    "timeout": 123,
    "user": "<string>"
}
headers = {
    "X-API-Key": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {'X-API-Key': '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({cmd: '<string>', cwd: '<string>', envs: {}, timeout: 123, user: '<string>'})
};

fetch('https://api.declaw.ai/sandboxes/{sandbox_id}/commands/stream', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.declaw.ai/sandboxes/{sandbox_id}/commands/stream",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'cmd' => '<string>',
    'cwd' => '<string>',
    'envs' => [
        
    ],
    'timeout' => 123,
    'user' => '<string>'
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json",
    "X-API-Key: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.declaw.ai/sandboxes/{sandbox_id}/commands/stream"

	payload := strings.NewReader("{\n  \"cmd\": \"<string>\",\n  \"cwd\": \"<string>\",\n  \"envs\": {},\n  \"timeout\": 123,\n  \"user\": \"<string>\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("X-API-Key", "<api-key>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.declaw.ai/sandboxes/{sandbox_id}/commands/stream")
  .header("X-API-Key", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"cmd\": \"<string>\",\n  \"cwd\": \"<string>\",\n  \"envs\": {},\n  \"timeout\": 123,\n  \"user\": \"<string>\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.declaw.ai/sandboxes/{sandbox_id}/commands/stream")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["X-API-Key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"cmd\": \"<string>\",\n  \"cwd\": \"<string>\",\n  \"envs\": {},\n  \"timeout\": 123,\n  \"user\": \"<string>\"\n}"

response = http.request(request)
puts response.read_body

POST

sandboxes

{sandbox_id}

commands

stream

Run Command (Stream)

curl --request POST \
  --url https://api.declaw.ai/sandboxes/{sandbox_id}/commands/stream \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <api-key>' \
  --data '
{
  "cmd": "<string>",
  "cwd": "<string>",
  "envs": {},
  "timeout": 123,
  "user": "<string>"
}
'

import requests

url = "https://api.declaw.ai/sandboxes/{sandbox_id}/commands/stream"

payload = {
    "cmd": "<string>",
    "cwd": "<string>",
    "envs": {},
    "timeout": 123,
    "user": "<string>"
}
headers = {
    "X-API-Key": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {'X-API-Key': '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({cmd: '<string>', cwd: '<string>', envs: {}, timeout: 123, user: '<string>'})
};

fetch('https://api.declaw.ai/sandboxes/{sandbox_id}/commands/stream', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.declaw.ai/sandboxes/{sandbox_id}/commands/stream",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'cmd' => '<string>',
    'cwd' => '<string>',
    'envs' => [
        
    ],
    'timeout' => 123,
    'user' => '<string>'
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json",
    "X-API-Key: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.declaw.ai/sandboxes/{sandbox_id}/commands/stream"

	payload := strings.NewReader("{\n  \"cmd\": \"<string>\",\n  \"cwd\": \"<string>\",\n  \"envs\": {},\n  \"timeout\": 123,\n  \"user\": \"<string>\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("X-API-Key", "<api-key>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.declaw.ai/sandboxes/{sandbox_id}/commands/stream")
  .header("X-API-Key", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"cmd\": \"<string>\",\n  \"cwd\": \"<string>\",\n  \"envs\": {},\n  \"timeout\": 123,\n  \"user\": \"<string>\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.declaw.ai/sandboxes/{sandbox_id}/commands/stream")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["X-API-Key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"cmd\": \"<string>\",\n  \"cwd\": \"<string>\",\n  \"envs\": {},\n  \"timeout\": 123,\n  \"user\": \"<string>\"\n}"

response = http.request(request)
puts response.read_body

Executes a command inside the sandbox and streams its output to the client in real-time using Server-Sent Events (SSE). The response has Content-Type: text/event-stream. Use this endpoint when you want to display output incrementally as the command runs, rather than waiting for it to complete.

Path Parameters

string

required

The sandbox identifier. Format: sbx-<8 chars>.

Request Body

string

required

The shell command to execute.Example: "for i in 1 2 3; do echo $i; sleep 0.5; done"

string

Working directory for the command.

object

Additional environment variables scoped to this command.

number

Per-command timeout in seconds.

string

Unix user to run the command as.

Response

The response has Content-Type: text/event-stream. Each SSE event carries a JSON payload. The stream terminates when the command exits.

SSE Event Format

event: stdout
data: {"stream":"stdout","data":"1\n"}

event: stdout
data: {"stream":"stdout","data":"2\n"}

event: exit
data: {"exit_code":0}

The stream proxies SSE events directly from the envd daemon inside the VM, so the exact event format may include additional fields.

Example

from declaw import Sandbox

sbx = Sandbox.connect("sbx-a1b2c3d4", api_key="YOUR_API_KEY", domain="api.declaw.ai")

for event in sbx.commands.run_stream("for i in 1 2 3; do echo $i; sleep 0.5; done"):
    if event.stream == "stdout":
        print(event.data, end="")

import { Sandbox } from "@declaw/sdk";

const sbx = await Sandbox.connect("sbx-a1b2c3d4", {
  apiKey: "YOUR_API_KEY",
  domain: "api.declaw.ai",
});

const stream = await sbx.commands.runStream(
  "for i in 1 2 3; do echo $i; sleep 0.5; done"
);
for await (const event of stream) {
  if (event.stream === "stdout") {
    process.stdout.write(event.data);
  }
}

curl -X POST https://api.declaw.ai/sandboxes/sbx-a1b2c3d4/commands/stream \
  -H "X-API-Key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -H "Accept: text/event-stream" \
  -d '{ "cmd": "for i in 1 2 3; do echo $i; sleep 0.5; done" }' \
  --no-buffer

Error Responses

Status	Cause
`400`	Invalid request body
`401`	Missing or invalid API key
`404`	Sandbox not found
`409`	Sandbox is paused — resume it before running commands
`410`	Sandbox has been killed
`502`	envd daemon inside the VM is unreachable
`503`	Sandbox has no VM

Run Command List Commands

Sandbox API

Command API

Filesystem API

Volumes API

Run Command (Stream)

Path Parameters

Request Body

Response

SSE Event Format

Example

Error Responses

​Path Parameters

​Request Body

​Response

​SSE Event Format

​Example

​Error Responses

Path Parameters

Request Body

Response

SSE Event Format

Example

Error Responses