Skip to main content
PUT
update tool

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

id
string<uuid>
required

Tool ID

Body

application/json

Fields to update on the tool. Only the fields you include are changed; omit a field to leave it unchanged. System tools cannot be modified.

name
string

Updated name for the tool

Required string length: 1 - 64
Example:

"search_products"

description
string

Updated description of what the tool does

Required string length: 1 - 1024
Example:

"Search the product catalog"

type
enum<string>

Updated tool type

Available options:
CLIENT,
SERVER_RAG,
SERVER_WEBHOOK,
SYSTEM
disableInterruptions
boolean
default:false

When true, interruptions are disabled while this tool is executing. Defaults to false.

Example:

false

config
ClientToolConfig · object

Updated type-specific configuration

Response

Successfully updated tool

id
string<uuid>

Unique identifier for the tool

Example:

"00000000-0000-0000-0000-000000000000"

name
string

Name of the tool

Example:

"search_knowledge_base"

description
string

Description of what the tool does

Example:

"Search the knowledge base for product information"

type
enum<string>

Type of tool

Available options:
CLIENT,
SERVER_RAG,
SERVER_WEBHOOK,
SYSTEM
config
object

Type-specific configuration

disableInterruptions
boolean
default:false

When true, interruptions are disabled while this tool is executing

createdAt
string<date-time>

When the tool was created

updatedAt
string<date-time> | null

When the tool was last updated

usageCount
integer

Number of personas using this tool

Last modified on July 10, 2026