Tools

Create a tool

Creates an api or code tool.

The body is the Tool envelope without id or read-only fields (inputs[].required). Request body / headers and code environment are optional. availability_rules is the structured Knowledge rule object, never the internal DSL string. Authorization headers on api tools are stored but stripped on every read. A code.environment row with source=sensitive_value is write-only: create stores the submitted value (empty means an empty secret). A GET-then-POST clone does not copy the stored secret. Send it again.

post/v2/tools/

Request

  • Base URL: https://example.ada.support/api
  • URL: https://example.ada.support/api/v2/tools/
  • Auth: HTTP bearer

Request body

type'api' | 'code' required
namestring required
descriptionstring required
enabledboolean
direct_useboolean nullable

Response

The created tool

idstring required

The tool's id

type'api' | 'code' required

Which kind of tool this is, and which implementation key is present

namestring required

The tool's name, as the model sees it

descriptionstring required

What the tool does, as the model sees it

enabledboolean required

Whether the tool is available to the Agent at all

direct_useboolean nullable required

Whether the Agent may call this tool on its own, rather than only as a step inside a process.

Changes

No recorded changes to this operation across all 1 revision of this API.