Run Command

POST
/workspaces
/:workspace
/sandboxes
/:sandbox_id
/commands

Run a command in a sandbox.

Request

REQUIRED SCOPES

WORKSPACE, SANDBOX_MANAGE

URL PARAMETERS

workspacerequired string

The workspace name.

sandbox_idrequired string

The ID of the sandbox.

POST PARAMETERS

commandrequired string

Command to execute in the sandbox.

runtimestring

Runtime environment for command execution (default: BASH). Available values: BASH, JAVASCRIPT, TYPESCRIPT, PYTHON.

Last modified on Sep 25, 2025

Get Command List Commands

Example:

curl -X POST "https://api.buddy.works/workspaces/:workspace/sandboxes/:sandbox_id/commands" \
-H "Authorization: Bearer <YOUR-TOKEN>" \
-H "Content-Type: application/json" \
-d '{
  "command": "ls -al",
  "runtime": "BASH"
}'

EXAMPLE RESPONSE
{
  "url": "https://api.buddy.works/workspaces/buddy/sandboxes/mydn9rjrqvq8d/command/68d5030dfff30824fb1d3e35",
  "id": "68d5030dfff30824fb1d3e35",
  "command": "ls -al",
  "runtime": "BASH",
  "status": "INPROGRESS"
}

STATUS
200 OK

LIMITS
X-Rate-Limit-Limit: 1
X-Rate-Limit-Remaining: 999