Get a tool
Read one tool. API tools return their full configuration; other types return the same fields as the list endpoint.
Autorisierungen
Scoped API token. Required scopes are listed on each operation in x-required-scopes.
Pfadparameter
ID of the tool.
Abfrageparameter
Compute is_active against this voice agent (tools other than API tools only).
Deprecated alias of agent_id (the agent's prompt id). Use agent_id.
Antwort
The tool.
- API tool
- Other tool
Full configuration of an API tool. Secrets are never returned.
ID of the tool.
Tool name as the agent's model sees it. Equals function_definition.name.
What the tool does. Empty for API tools; the model reads function_definition.description.
Always external:api.
"external:api"ID of the integration created for this tool.
ID of the action record backing this tool.
How the API is called.
OpenAI-style function schema the agent's model uses to decide when and how to call the tool.
Only returned by create. True when agent_id was supplied and the tool was enabled for that agent.