tools
tools

List available tools

List all available tools based on the specified mode and filters.

Returns a catalog of tools that can be executed in the current context.

When background=true is set, each tool in the response gains three extra fields used by the per-agent Tools override UI:

  • default_visible: whether the tool is in the default set for the given agent's connected channels (agent_id) or, if no agent is specified, assuming all channels connected.
  • required_channel: the channel literal the tool requires, or null.
  • schema_bytes: cached byte cost of the tool's OpenAI function schema — the UI multiplies this by the caller's selection to estimate per-agent token cost.
get/api/tools/catalog

Request

  • Base URL: https://api.dialogbrain.com (the document declares no server; this is the origin it was published from)
  • URL: https://api.dialogbrain.com/api/tools/catalog
  • Auth: none declared

Query parameters

mode'draft' | 'auto' | 'supervised' | 'autonomous' | 'background_draft' | 'post_approval' | 'sandbox' | 'voice'

Execution modes for the AI agent.

include_approval_requiredboolean
categorystring nullable
searchstring nullable
planner_onlyboolean
backgroundboolean
include_hiddenboolean
agent_idinteger nullable

Response

Successful Response

object required

Changes

No recorded changes to this operation across all 5 revisions of this API.