Skip to main content
POST
Run a command

Authorizations

Authorization
string
header
required

A Cool Computers API key, user access token, or claimed agent access token in the Authorization header. Follow https://www.cool.computer/auth.md for agent registration and https://www.cool.computer/authentication.md for direct user credentials.

Path Parameters

id
string
required

Stable public computer identifier.

Minimum string length: 1
Example:

"cmp_123"

Body

application/json
execution_id
string
required

Stable caller identity bound to the target computer and used to reconnect without relaunching the command.

Pattern: ^cmp_[0-9a-f]{24}\.exec\.[0-9a-f]{32}$
command
string
required
Minimum string length: 1
cwd
string
uid
integer
Required range: x >= 0
gid
integer
Required range: x >= 0
shell
string | null
env
object

Response

Completed command output.

execution_id
string
required
Pattern: ^cmp_[0-9a-f]{24}\.exec\.[0-9a-f]{32}$
status
enum<string>
required
Available options:
succeeded,
failed,
cancelled,
owner_lost
stdout
string
required

Retained stdout. Check dropped_bytes and dropped_frames before treating it as complete.

stderr
string
required

Retained stderr. Check dropped_bytes and dropped_frames before treating it as complete.

exit_code
integer
required
signal
string
error
string

Explicit owner or launch failure when status is owner_lost or failed.

dropped_bytes
integer
Required range: x >= 0
dropped_frames
integer
Required range: x >= 0