Skip to main content
POST
Execute Bash Command

Authorizations

X-Session-API-Key
string
header
required

Body

application/json
command
string
required

The bash command to execute

cwd
string | null

The current working directory

timeout
integer
default:300

The max number of seconds a command may be permitted to run.

Response

Successful Response

Output of a bash command. A single command may have multiple pieces of output depending on how large the output is.

command_id
string
required
kind
string
required
Allowed value: "BashOutput"
exit_code
integer | null

Exit code None implies the command is still running.

id
string
order
integer
default:0

The order for this output, sequentially starting with 0

stderr
string | null

The error output from the command

stdout
string | null

The standard output from the command

timestamp
string<date-time>