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": "search_products",
  "description": "Search the product catalog",
  "type": "CLIENT",
  "config": {
    "parameters": {}
  }
}
'
{
  "id": "0084f07b-6106-4cd8-be32-a66a64284b31",
  "name": "search_knowledge_base",
  "description": "Search the knowledge base for product information",
  "type": "CLIENT",
  "config": {},
  "createdAt": "2023-11-07T05:31:56Z",
  "updatedAt": "2023-11-07T05:31:56Z",
  "usageCount": 123
}

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
​
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
​
config
ClientToolConfig · object

Updated type-specific configuration

Response

Successfully updated tool

​
id
string<uuid>

Unique identifier for the tool

Example:

"0084f07b-6106-4cd8-be32-a66a64284b31"

​
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

​
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