Update a Custom Tool

put

{protocol}://{base-url}/ai/api/v1/config/tool/{tool_config_id}

Update a custom tool configuration.

Path Params

tool_config_id

uuid

required

The tool config ID.

Body Params

Request schema for updating an existing tool configuration.

Note: Only user-created configs can be updated, not system defaults.
All fields are optional. Type-specific fields are only applied if the tool
is of the matching type.

name

length ≥ 2

New display name for the tool.

description

length ≥ 2

New description for the tool.

This will be included in agent prompts to help the LLM understand
when and how to use this tool.

function_name

length ≥ 1

The unique name identifying this tool to an LLM.

scorer_ref

DefaultToolScorerRef | null

Reference to the Tool Scorer to use when using tool-based evaluation.

requires_approval

Whether this tool requires user approval before execution.

input_parameter_schema

object | null

JSON schema describing the tool's input parameters

smtp_config

SMTPConfig | null

SMTP server configuration (for SMTP tools)

http_config

HTTPConfig | null

HTTP endpoint configuration (for HTTP tools)

auth_config

AuthConfigUpdate | null

Authentication configuration updates

Responses

404

Custom tool not found.

Language

Credentials

URL

Loading…

Response

Choose an example:

application/json

200Successful Response

401Authentication required. No valid session cookie or bearer token provided, or authentication failed.

422Validation Error

500Internal server error during request processing.