v4

latestOpenAPI 3.1.02026-08-086635375.7 KB

Tools

update tool

Update an existing tool

put/v1/tools/{id}

Path parameters

idstring uuid required

Tool ID

Request body

namestring

Updated name for the tool

descriptionstring

Updated description of what the tool does

type'CLIENT' | 'SERVER_RAG' | 'SERVER_WEBHOOK' | 'SYSTEM'

Updated tool type

disableInterruptionsboolean

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

Example request

{
  "name": "search_products",
  "description": "Search the product catalog"
}

Response

Successfully updated tool

idstring uuid

Unique identifier for the tool

namestring

Name of the tool

descriptionstring

Description of what the tool does

type'CLIENT' | 'SERVER_RAG' | 'SERVER_WEBHOOK' | 'SYSTEM'

Type of tool

configobject

Type-specific configuration

disableInterruptionsboolean

When true, interruptions are disabled while this tool is executing

createdAtstring date-time

When the tool was created

updatedAtstring date-time nullable

When the tool was last updated

usageCountinteger

Number of personas using this tool

Example response

{
  "id": "00000000-0000-0000-0000-000000000000",
  "name": "search_knowledge_base",
  "description": "Search the knowledge base for product information"
}