Box work and access

Execute Box 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 /boxes/{boxId}/commands/{processId} for status and logs. Returns 400 invalid_timeout when timeoutSeconds is not an integer in 1-600. Returns 409 box_starting (retryable) while the Box is still provisioning — wait until the Box state is ready before running commands. Command execution is never retried automatically: a 502 box_direct_failed means the command may already be running on the Box.

POST

boxes

{boxId}

commands

Execute a command in a Box

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

import requests

url = "https://ascii.dev/api/box/v1/boxes/{boxId}/commands"

payload = {
    "command": "<string>",
    "cwd": "<string>",
    "timeoutSeconds": 30,
    "detached": 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})
};

fetch('https://ascii.dev/api/box/v1/boxes/{boxId}/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://ascii.dev/api/box/v1/boxes/{boxId}/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
  ]),
  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://ascii.dev/api/box/v1/boxes/{boxId}/commands"

	payload := strings.NewReader("{\n  \"command\": \"<string>\",\n  \"cwd\": \"<string>\",\n  \"timeoutSeconds\": 30,\n  \"detached\": 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://ascii.dev/api/box/v1/boxes/{boxId}/commands")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"command\": \"<string>\",\n  \"cwd\": \"<string>\",\n  \"timeoutSeconds\": 30,\n  \"detached\": false\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://ascii.dev/api/box/v1/boxes/{boxId}/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}"

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

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

{
  "ok": false,
  "type": "box.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": "box.error",
  "status": 401,
  "code": "unauthorized",
  "message": "Unauthorized",
  "error": {
    "code": "unauthorized",
    "message": "Unauthorized",
    "status": 401
  },
  "requestId": "req_01HX..."
}

{
  "ok": true,
  "type": "<string>",
  "status": 123,
  "code": "<string>",
  "message": "<string>",
  "requestId": "<string>",
  "error": {
    "code": "<string>",
    "message": "<string>",
    "status": 123,
    "details": {}
  }
}

{
  "ok": true,
  "type": "<string>",
  "status": 123,
  "code": "<string>",
  "message": "<string>",
  "requestId": "<string>",
  "error": {
    "code": "<string>",
    "message": "<string>",
    "status": 123,
    "details": {}
  }
}

Authorizations

Authorization

string

header

required

Box bearer token in the form box_.... Service API keys authenticate Box operations.

Path Parameters

boxId

string

required

Public Box id returned by create/list/get box calls.

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

Body

application/json

command

string

required

cwd

string

Relative working directory inside the Box 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 Box; poll the status endpoint for it.

Response

Command result (synchronous) or process start confirmation (detached).

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

stdoutTruncated

boolean

stderrTruncated

boolean

cwd

string

startedAt

string<date-time>

finishedAt

string<date-time>

Execute a command in a Box

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

import requests

url = "https://ascii.dev/api/box/v1/boxes/{boxId}/commands"

payload = {
    "command": "<string>",
    "cwd": "<string>",
    "timeoutSeconds": 30,
    "detached": 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})
};

fetch('https://ascii.dev/api/box/v1/boxes/{boxId}/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://ascii.dev/api/box/v1/boxes/{boxId}/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
  ]),
  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://ascii.dev/api/box/v1/boxes/{boxId}/commands"

	payload := strings.NewReader("{\n  \"command\": \"<string>\",\n  \"cwd\": \"<string>\",\n  \"timeoutSeconds\": 30,\n  \"detached\": 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://ascii.dev/api/box/v1/boxes/{boxId}/commands")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"command\": \"<string>\",\n  \"cwd\": \"<string>\",\n  \"timeoutSeconds\": 30,\n  \"detached\": false\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://ascii.dev/api/box/v1/boxes/{boxId}/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}"

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

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

{
  "ok": false,
  "type": "box.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": "box.error",
  "status": 401,
  "code": "unauthorized",
  "message": "Unauthorized",
  "error": {
    "code": "unauthorized",
    "message": "Unauthorized",
    "status": 401
  },
  "requestId": "req_01HX..."
}

{
  "ok": true,
  "type": "<string>",
  "status": 123,
  "code": "<string>",
  "message": "<string>",
  "requestId": "<string>",
  "error": {
    "code": "<string>",
    "message": "<string>",
    "status": 123,
    "details": {}
  }
}

{
  "ok": true,
  "type": "<string>",
  "status": 123,
  "code": "<string>",
  "message": "<string>",
  "requestId": "<string>",
  "error": {
    "code": "<string>",
    "message": "<string>",
    "status": 123,
    "details": {}
  }
}