Sandbox work and access

Execute Sandbox command

Runs the command synchronously by default (timeout configurable via timeoutSeconds, 600s cap). With detached: true the command starts in the background and a process id is returned immediately; poll /sandboxes/{sandboxId}/commands/{processId} for status and logs. With stream: true the output arrives as the command writes it, as newline-delimited JSON (application/x-ndjson): {"type":"started"}, then {"type":"stdout"|"stderr","data":"..."} per chunk, and last {"type":"exit",...} (the synchronous result without stdout/stderr) or {"type":"error","error":"...","message":"..."}. Returns 400 invalid_timeout when timeoutSeconds is not an integer in 1-600. A command sent while the sandbox is still starting (right after a resume) waits up to 60s for it to be ready instead of failing; 409 boat_starting (retryable) is returned only if it is still not ready by then. A sandbox that is not starting (error, stopped) returns 409 sandbox_not_ready with retryable: false and its state at once: resume or recover it first. Command execution is never retried automatically: a 502 boat_direct_failed means the command may already be running on the sandbox.

POST

sandboxes

{sandboxId}

commands

Execute a command in a sandbox

curl --request POST \
  --url https://boat.dev/api/v1/sandboxes/{sandboxId}/commands \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "command": "<string>",
  "cwd": "<string>",
  "timeoutSeconds": 30,
  "detached": false,
  "stream": false
}
'

import requests

url = "https://boat.dev/api/v1/sandboxes/{sandboxId}/commands"

payload = {
    "command": "<string>",
    "cwd": "<string>",
    "timeoutSeconds": 30,
    "detached": False,
    "stream": False
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    command: '<string>',
    cwd: '<string>',
    timeoutSeconds: 30,
    detached: false,
    stream: false
  })
};

fetch('https://boat.dev/api/v1/sandboxes/{sandboxId}/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://boat.dev/api/v1/sandboxes/{sandboxId}/commands",
  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([
    'command' => '<string>',
    'cwd' => '<string>',
    'timeoutSeconds' => 30,
    'detached' => false,
    'stream' => false
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$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://boat.dev/api/v1/sandboxes/{sandboxId}/commands"

	payload := strings.NewReader("{\n  \"command\": \"<string>\",\n  \"cwd\": \"<string>\",\n  \"timeoutSeconds\": 30,\n  \"detached\": false,\n  \"stream\": false\n}")

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

	req.Header.Add("Authorization", "Bearer <token>")
	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://boat.dev/api/v1/sandboxes/{sandboxId}/commands")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"command\": \"<string>\",\n  \"cwd\": \"<string>\",\n  \"timeoutSeconds\": 30,\n  \"detached\": false,\n  \"stream\": false\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://boat.dev/api/v1/sandboxes/{sandboxId}/commands")

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

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"command\": \"<string>\",\n  \"cwd\": \"<string>\",\n  \"timeoutSeconds\": 30,\n  \"detached\": false,\n  \"stream\": false\n}"

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

{
  "ok": true,
  "type": "command.finished",
  "success": true,
  "exitCode": 123,
  "stdout": "<string>",
  "stderr": "<string>",
  "timedOut": true,
  "signal": "<string>",
  "oomKilled": true,
  "stdoutTruncated": true,
  "stderrTruncated": true,
  "cwd": "<string>",
  "startedAt": "2023-11-07T05:31:56Z",
  "finishedAt": "2023-11-07T05:31:56Z"
}

{
  "ok": false,
  "type": "sandbox.error",
  "status": 400,
  "code": "invalid_json",
  "message": "Request body must be valid JSON.",
  "error": {
    "code": "invalid_json",
    "message": "Request body must be valid JSON.",
    "status": 400
  },
  "requestId": "req_01HX..."
}

{
  "ok": false,
  "type": "sandbox.error",
  "status": 401,
  "code": "unauthorized",
  "message": "Unauthorized",
  "error": {
    "code": "unauthorized",
    "message": "Unauthorized",
    "status": 401
  },
  "requestId": "req_01HX..."
}

{
  "ok": false,
  "type": "sandbox.error",
  "status": 409,
  "code": "provider_not_configured",
  "message": "Prompting is locked until Codex is configured on the Agents page.",
  "requestId": "req_01HX...",
  "error": {
    "code": "<string>",
    "message": "<string>",
    "status": 123,
    "details": {}
  }
}

{
  "ok": false,
  "type": "sandbox.error",
  "status": 409,
  "code": "provider_not_configured",
  "message": "Prompting is locked until Codex is configured on the Agents page.",
  "requestId": "req_01HX...",
  "error": {
    "code": "<string>",
    "message": "<string>",
    "status": 123,
    "details": {}
  }
}

Authorizations

Authorization

string

header

required

Boat bearer token in the form boat_.... Service API keys authenticate sandbox operations.

Path Parameters

sandboxId

string

required

Public Sandbox id returned by create/list/get sandbox calls.

Pattern: ^bx_[23456789abcdefghjkmnpqrstuvwxyz]{8}$

Body

application/json

command

string

required

cwd

string

Relative working directory inside the sandbox work directory.

timeoutSeconds

integer

default:30

Command timeout in seconds. Values outside 1-600 are rejected with a 400 invalid_timeout error.

Required range: 1 <= x <= 600

detached

boolean

default:false

Start the command in the background and return a process id immediately instead of waiting for it to finish. Output goes to a log file on the sandbox; poll the status endpoint for it.

stream

boolean

default:false

Stream the output as the command writes it: the response is newline-delimited JSON (application/x-ndjson), one CommandStreamFrame per line. Ignored with detached.

Response

Command result (synchronous), process start confirmation (detached), or the output stream (stream: true).

Option 1
Option 2

boolean

required

Example:

true

type

string

required

Stable success envelope discriminator added by v1.

Allowed value: "command.finished"

success

boolean

required

exitCode

integer | null

required

stdout

string

required

stderr

string

required

timedOut

boolean

required

signal

string | null

oomKilled

boolean

True when the memory ceiling killed the command or one of its processes and the command failed.

stdoutTruncated

boolean

stderrTruncated

boolean

cwd

string

startedAt

string<date-time>

finishedAt

string<date-time>

Execute a command in a sandbox

curl --request POST \
  --url https://boat.dev/api/v1/sandboxes/{sandboxId}/commands \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "command": "<string>",
  "cwd": "<string>",
  "timeoutSeconds": 30,
  "detached": false,
  "stream": false
}
'

import requests

url = "https://boat.dev/api/v1/sandboxes/{sandboxId}/commands"

payload = {
    "command": "<string>",
    "cwd": "<string>",
    "timeoutSeconds": 30,
    "detached": False,
    "stream": False
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    command: '<string>',
    cwd: '<string>',
    timeoutSeconds: 30,
    detached: false,
    stream: false
  })
};

fetch('https://boat.dev/api/v1/sandboxes/{sandboxId}/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://boat.dev/api/v1/sandboxes/{sandboxId}/commands",
  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([
    'command' => '<string>',
    'cwd' => '<string>',
    'timeoutSeconds' => 30,
    'detached' => false,
    'stream' => false
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$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://boat.dev/api/v1/sandboxes/{sandboxId}/commands"

	payload := strings.NewReader("{\n  \"command\": \"<string>\",\n  \"cwd\": \"<string>\",\n  \"timeoutSeconds\": 30,\n  \"detached\": false,\n  \"stream\": false\n}")

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

	req.Header.Add("Authorization", "Bearer <token>")
	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://boat.dev/api/v1/sandboxes/{sandboxId}/commands")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"command\": \"<string>\",\n  \"cwd\": \"<string>\",\n  \"timeoutSeconds\": 30,\n  \"detached\": false,\n  \"stream\": false\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://boat.dev/api/v1/sandboxes/{sandboxId}/commands")

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

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"command\": \"<string>\",\n  \"cwd\": \"<string>\",\n  \"timeoutSeconds\": 30,\n  \"detached\": false,\n  \"stream\": false\n}"

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

{
  "ok": true,
  "type": "command.finished",
  "success": true,
  "exitCode": 123,
  "stdout": "<string>",
  "stderr": "<string>",
  "timedOut": true,
  "signal": "<string>",
  "oomKilled": true,
  "stdoutTruncated": true,
  "stderrTruncated": true,
  "cwd": "<string>",
  "startedAt": "2023-11-07T05:31:56Z",
  "finishedAt": "2023-11-07T05:31:56Z"
}

{
  "ok": false,
  "type": "sandbox.error",
  "status": 400,
  "code": "invalid_json",
  "message": "Request body must be valid JSON.",
  "error": {
    "code": "invalid_json",
    "message": "Request body must be valid JSON.",
    "status": 400
  },
  "requestId": "req_01HX..."
}

{
  "ok": false,
  "type": "sandbox.error",
  "status": 401,
  "code": "unauthorized",
  "message": "Unauthorized",
  "error": {
    "code": "unauthorized",
    "message": "Unauthorized",
    "status": 401
  },
  "requestId": "req_01HX..."
}

{
  "ok": false,
  "type": "sandbox.error",
  "status": 409,
  "code": "provider_not_configured",
  "message": "Prompting is locked until Codex is configured on the Agents page.",
  "requestId": "req_01HX...",
  "error": {
    "code": "<string>",
    "message": "<string>",
    "status": 123,
    "details": {}
  }
}

{
  "ok": false,
  "type": "sandbox.error",
  "status": 409,
  "code": "provider_not_configured",
  "message": "Prompting is locked until Codex is configured on the Agents page.",
  "requestId": "req_01HX...",
  "error": {
    "code": "<string>",
    "message": "<string>",
    "status": 123,
    "details": {}
  }
}