Skip to main content
PUT
/
v1
/
tools
/
{id}
update tool
curl --request PUT \
  --url https://api.anam.ai/v1/tools/{id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "open_scheduler"
}
'
{
  "id": "00000000-0000-0000-0000-000000000000",
  "name": "open_calendar",
  "description": "Open the calendar UI in the client app.",
  "type": "CLIENT",
  "config": {
    "parameters": {
      "type": "object",
      "properties": {
        "date": {
          "type": "string",
          "description": "Date to jump to, in YYYY-MM-DD format."
        }
      }
    }
  },
  "createdAt": "2026-04-20T10:00:00.000Z",
  "updatedAt": null,
  "usageCount": 0
}

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 April 22, 2026