Skip to main content
POST
/
v1
/
bot
/
chat
/
execute-tool
Execute Tool
curl --request POST \
  --url https://api.boostgpt.co/v1/bot/chat/execute-tool \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "project_id": "<string>",
  "bot_id": "<string>",
  "chat_id": "<string>",
  "execution_data": {
    "executionId": "<string>",
    "originalQuery": "<string>",
    "executionType": "SINGLE",
    "context": "<string>",
    "toolName": "<string>",
    "parameters": {},
    "tools": [
      {
        "name": "<string>",
        "parameters": {}
      }
    ],
    "executedTools": [
      {
        "name": "<string>",
        "executionId": "<string>"
      }
    ]
  },
  "model": "<string>",
  "instruction": "<string>",
  "bypass_rate_limit": true,
  "chat_mode": "ask"
}
'
{
  "success": true,
  "result": {},
  "executionId": "<string>"
}

Authorizations

​
Authorization
string
header
required

Enter your API key

Body

application/json
​
project_id
string
required

Project ID

​
bot_id
string
required

Agent ID

​
chat_id
string
required

Chat ID

​
execution_data
object
required
​
model
string

Override model for execution

​
instruction
string

Custom instruction

Maximum string length: 1000
​
bypass_rate_limit
boolean

Bypass rate limiting

​
chat_mode
enum<string>
default:ask

Chat mode. 'ask' for normal chat, 'edit' for agent-powered code editing, 'plan' for conversational plan-then-execute workflow

Available options:
ask,
edit,
plan

Response

Tool executed successfully

​
success
boolean

Execution success status

​
result
object

Tool execution result

​
executionId
string

Execution ID