Skip to main content
POST
Run one connection tool

Authorizations

Authorization
string
header
required

The session token of an admin of your company. Company API, partner and droplet installation tokens are refused.

Path Parameters

id
string<uuid>
required

The connection's id.

bot_id
string<uuid>
required

The bot's id.

run_id
string<uuid>
required

The id of one of the bot's runs.

Body

application/json
tool
string
required

The tool's name, as the connection lists it.

tool_arguments
object

The tool's arguments, matching its input schema. Omit it for none; null or any other non-object is refused (invalid_arguments). Filtered from Rails' request logs.

Response

The tool's answer, or why it was refused.

Either answer, what the tool returned, or refused, why Rails did not run it.

status
integer
required
meta
object
required

Response metadata on every body. List endpoints add pagination.

answer
object
refused
object