List Commands

curl --request GET \
  --url https://api.declaw.ai/sandboxes/{sandbox_id}/commands \
  --header 'X-API-Key: <api-key>'

import requests

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

headers = {"X-API-Key": "<api-key>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {'X-API-Key': '<api-key>'}};

fetch('https://api.declaw.ai/sandboxes/{sandbox_id}/commands', 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",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "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"
	"net/http"
	"io"
)

func main() {

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

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("X-API-Key", "<api-key>")

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

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

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.get("https://api.declaw.ai/sandboxes/{sandbox_id}/commands")
  .header("X-API-Key", "<api-key>")
  .asString();

require 'uri'
require 'net/http'

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

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

request = Net::HTTP::Get.new(url)
request["X-API-Key"] = '<api-key>'

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

{
  "[].pid": 123,
  "[].cmd": "<string>",
  "[].is_pty": true,
  "[].envs": {}
}

GET

sandboxes

{sandbox_id}

commands

List Commands

curl --request GET \
  --url https://api.declaw.ai/sandboxes/{sandbox_id}/commands \
  --header 'X-API-Key: <api-key>'

import requests

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

headers = {"X-API-Key": "<api-key>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {'X-API-Key': '<api-key>'}};

fetch('https://api.declaw.ai/sandboxes/{sandbox_id}/commands', 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",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "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"
	"net/http"
	"io"
)

func main() {

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

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("X-API-Key", "<api-key>")

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

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

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.get("https://api.declaw.ai/sandboxes/{sandbox_id}/commands")
  .header("X-API-Key", "<api-key>")
  .asString();

require 'uri'
require 'net/http'

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

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

request = Net::HTTP::Get.new(url)
request["X-API-Key"] = '<api-key>'

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

{
  "[].pid": 123,
  "[].cmd": "<string>",
  "[].is_pty": true,
  "[].envs": {}
}

Returns an array of background processes that are currently tracked for the sandbox. Only commands started with background: true appear in this list. Processes are removed from the list when they complete via wait or are killed via kill.

Path Parameters

string

required

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

Response

Returns an array of ProcessInfo objects. May be empty if no background processes are tracked.

integer

Process ID.

string

The command string that was run.

boolean

Whether the process was started with a pseudo-terminal.

object

Environment variables the process was started with.

Example

curl https://api.declaw.ai/sandboxes/sbx-a1b2c3d4/commands \
  -H "X-API-Key: YOUR_API_KEY"

from declaw import Sandbox

sbx = Sandbox.connect("sbx-a1b2c3d4", api_key="YOUR_API_KEY", domain="api.declaw.ai")
processes = sbx.commands.list()
for proc in processes:
    print(proc.pid, proc.cmd)

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

const sbx = await Sandbox.connect("sbx-a1b2c3d4", {
  apiKey: "YOUR_API_KEY",
  domain: "api.declaw.ai",
});
const processes = await sbx.commands.list();
for (const proc of processes) {
  console.log(proc.pid, proc.cmd);
}

Response

[
  {
    "pid": 42,
    "cmd": "python3 worker.py",
    "is_pty": false
  },
  {
    "pid": 43,
    "cmd": "sleep 60",
    "is_pty": false
  }
]

Error Responses

Status	Cause
`401`	Missing or invalid API key

Run Command (Stream)Kill Command

Sandbox API

Command API

Filesystem API

Volumes API

List Commands

Path Parameters

Response

Example

Error Responses

​Path Parameters

​Response

​Example

​Error Responses

Path Parameters

Response

Example

Error Responses