Get a tool
Authorizations
API key for authentication
Path Parameters
Response
Successful response
A tool the agent can invoke during a call.
The function name the model sees.
http, client HTTP tools only.
GET, POST, PUT, PATCH, DELETE HTTP tools only.
What the agent does when the tool returns.
speaks narrates the result (default). listens stays silent and waits
— right for tools that hand off, like a transfer. speaks-once speaks
only if it did not already speak just before invoking, which prevents
"Checking that for you… here is the result…" double-talk.
speaks, listens, speaks-once Declares which credentials the tool needs and how each is sent. The
secret values themselves live in authTokens.
options is a list of acceptable alternatives — satisfying any one
entry is enough, which is how you offer "either an API key or a bearer
token".
Which credential slots hold a stored value. Credential values are
never returned by this API — this map exists so a UI can render
•••••••• for a set slot and an empty field for an unset one.
Seconds with an s suffix, e.g. "2.5s" or "10s". Must be greater
than 0 and at most 40s. Defaults to 2.5s when unset.
^\d+(\.\d+)?s$"5s"
Attests the tool is side-effect free, letting the runtime run it eagerly while the agent is still speaking and discard the result if the conversation turns elsewhere. Set it only on lookups — never on a booking or a payment.
How many agents this tool is attached to.