Skip to main content
POST
Execute Tool

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
chat_mode
enum<string>
default:ask

Override the chat mode for this step. Omitted, the chat saved mode is used.

Available options:
ask,
edit,
plan
stream
boolean
default:false

Return the continuation as a text/event-stream instead of one JSON response

memory
boolean

Override whether the continuation may search the agent knowledge. Omitted, it inherits the setting of the turn being resumed.

source_ids
string[]

Override the knowledge search scope for this step. Omitted, it inherits the turn scope; send [] to clear it.

tags
string[]

Override the tag scope for this step. Omitted, it inherits the turn tags; send [] to clear it.

Response

Tool executed successfully

success
boolean

Execution success status

result
object

Tool execution result

executionId
string

Execution ID