Skip to main content
POST
/
api
/
bash
/
execute_bash_command
{
  "kind": "BashOutput",
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "timestamp": "2023-11-07T05:31:56Z",
  "command_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "order": 0,
  "exit_code": 123,
  "stdout": "<string>",
  "stderr": "<string>"
}

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<uuid>
required
​
kind
string
default:BashOutput
Allowed value: "BashOutput"
​
id
string<uuid>
​
timestamp
string<date-time>
​
order
integer
default:0

The order for this output, sequentially starting with 0

​
exit_code
integer | null

Exit code None implies the command is still running.

​
stdout
string | null

The standard output from the command

​
stderr
string | null

The error output from the command