Create a new tool

Creates a new tool with the specified configurations and returns the tool details including the generated tool ID.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
required

The id of the application to retrieve tools from.

Body Params
string
enum
required

The code of the tool type.

Allowed:
integer
required

ID of the catalog item this tool uses (e.g., references 'Contact Center', 'Dialogflow').

config
object

Configuration settings for the general tool, stored as JSON. This can include a 'custom output' key with a
string value. For specific catalog tools like 'Contact Center' or 'Dialogflow' (identified by catalog_id),
this 'config' field is mandatory and must contain a 'custom output' key with a non-empty string value.
This validation is performed by the service.

string
required

Name of the tool configuration.

string

Description of the tool configuration.

boolean

Flag indicating if human review is required for this tool's output.

string | null

Message to display if human review is triggered.

string | null

Keyword to approve the agent actions.

argsSchema
object | null

JSON schema, defining expected input parameters. Tool-specific behavior:

GENERAL tools:

  • contactCenter, dialogflow, dummyTool: Must be null/empty, no custom args.
  • webSearch: If null or empty, defaults to standard 'query' parameter (required).
  • userProfileMemory: required custom argsSchema.

RETRIEVAL tools: If null or empty, defaults to standard 'query' parameter (required).

API tools: Can be null/empty or customized.
NOTE: For API tools, 'params' and 'argsSchema' must match (they represent the same data).

MCP tools: Can be null/empty or customized. NOTE: For MCP tools, 'params' and 'argsSchema' must match (they represent the same data).

Responses

Language
Credentials
Header
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json