Skip to main content
GET
Get a tool

Autorisierungen

Authorization
string
header
erforderlich

Scoped API token. Required scopes are listed on each operation in x-required-scopes.

Pfadparameter

id
integer
erforderlich

ID of the tool.

Abfrageparameter

agent_id
integer

Compute is_active against this voice agent (tools other than API tools only).

prompt_id
integer

Deprecated alias of agent_id (the agent's prompt id). Use agent_id.

Antwort

The tool.

Full configuration of an API tool. Secrets are never returned.

id
integer
erforderlich

ID of the tool.

name
string
erforderlich

Tool name as the agent's model sees it. Equals function_definition.name.

description
string | null
erforderlich

What the tool does. Empty for API tools; the model reads function_definition.description.

function_type
string
erforderlich

Always external:api.

Allowed value: "external:api"
integration_id
integer
erforderlich

ID of the integration created for this tool.

ai_action_id
integer | null
erforderlich

ID of the action record backing this tool.

external_api
object
erforderlich

How the API is called.

function_definition
object
erforderlich

OpenAI-style function schema the agent's model uses to decide when and how to call the tool.

enabled_for_agent
boolean

Only returned by create. True when agent_id was supplied and the tool was enabled for that agent.