Skip to main content
GET
Get a tool

Authorizations

X-API-Key
string
header
required

API key for authentication

Path Parameters

id
string
required

Response

Successful response

A tool the agent can invoke during a call.

id
string
name
string
description
string | null
modelToolName
string

The function name the model sees.

type
enum<string>
Available options:
http,
client
httpMethod
enum<string>

HTTP tools only.

Available options:
GET,
POST,
PUT,
PATCH,
DELETE
baseUrlPattern
string

HTTP tools only.

dynamicParameters
object
automaticParameters
object
staticParameters
object
agentReaction
enum<string> | null

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.

Available options:
speaks,
listens,
speaks-once
httpSecurityOptions
object | null

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".

setCredentials
object

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.

timeout
string | null

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.

Pattern: ^\d+(\.\d+)?s$
Example:

"5s"

readOnly
boolean
default:false

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.

agentCount
integer

How many agents this tool is attached to.

createdAt
string<date-time>
updatedAt
string<date-time>