Skip to main content
POST
/
api
/
bash
/
execute_bash_command
Execute Bash Command
curl --request POST \
  --url https://api.example.com/api/bash/execute_bash_command \
  --header 'Content-Type: application/json' \
  --data '
{
  "command": "<string>",
  "cwd": "<string>",
  "timeout": 300
}
'
{
  "command_id": "<string>",
  "kind": "BashOutput",
  "id": "<string>",
  "timestamp": "2023-11-07T05:31:56Z",
  "order": 0,
  "exit_code": 123,
  "stdout": "<string>",
  "stderr": "<string>"
}

Documentation Index

Fetch the complete documentation index at: https://allhandsai-docs-v1-local-agent-server-guide.mintlify.app/llms.txt

Use this file to discover all available pages before exploring further.

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
default:BashOutput
Allowed value: "BashOutput"
​
id
string
​
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