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

Documentation Index

Fetch the complete documentation index at: https://docs.openhands.dev/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

​
command
string
required

The bash command to execute

​
kind
string
required
Allowed value: "BashCommand"
​
cwd
string | null

The current working directory

​
timeout
integer
default:300

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

​
id
string
​
timestamp
string<date-time>