Tools

Update tool description

PATCH

Path parameters

idstringRequired
Identifier for a Tool. Formatted as a UUID.
versionintegerRequired

Version number for a Tool.

Tools, as well as Configs and Prompts, are versioned. This versioning system supports iterative development, allowing you to progressively refine tools and revert to previous versions if needed.

Version numbers are integer values representing different iterations of the Tool. Each update to the Tool increments its version number.

Request

This endpoint expects an object.
version_description
stringOptional
An optional description of the Tool version.

Response

This endpoint returns an optional object
tool_type
enum

Type of Tool. Either BUILTIN for natively implemented tools, like web search, or FUNCTION for user-defined tools.

Allowed values: BUILTINFUNCTION
id
string
Identifier for a Tool. Formatted as a UUID.
version
integer

Version number for a Tool.

Tools, as well as Configs and Prompts, are versioned. This versioning system supports iterative development, allowing you to progressively refine tools and revert to previous versions if needed.

Version numbers are integer values representing different iterations of the Tool. Each update to the Tool increments its version number.

version_type
enum

Versioning method for a Tool. Either FIXED for using a fixed version number or LATEST for auto-updating to the latest version.

Allowed values: FIXEDLATEST
name
string
Name applied to all versions of a particular Tool.
created_on
integer
Time at which the Tool was created. Measured in seconds since the Unix epoch.
modified_on
integer
Time at which the Tool was last modified. Measured in seconds since the Unix epoch.
parameters
string

Stringified JSON defining the parameters used by this version of the Tool.

These parameters define the inputs needed for the Tool’s execution, including the expected data type and description for each input field. Structured as a stringified JSON schema, this format ensures the tool receives data in the expected format.

version_description
stringOptional
An optional description of the Tool version.
fallback_content
stringOptional
Optional text passed to the supplemental LLM in place of the tool call result. The LLM then uses this text to generate a response back to the user, ensuring continuity in the conversation if the Tool errors.
description
stringOptional
An optional description of what the Tool does, used by the supplemental LLM to choose when and how to call the function.
Built with