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"
}
'

import requests

url = "https://api.anam.ai/v1/tools/{id}"

payload = { "name": "open_scheduler" }
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.put(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'PUT',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({name: 'open_scheduler'})
};

fetch('https://api.anam.ai/v1/tools/{id}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.anam.ai/v1/tools/{id}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PUT",
  CURLOPT_POSTFIELDS => json_encode([
    'name' => 'open_scheduler'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.anam.ai/v1/tools/{id}"

	payload := strings.NewReader("{\n  \"name\": \"open_scheduler\"\n}")

	req, _ := http.NewRequest("PUT", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.put("https://api.anam.ai/v1/tools/{id}")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"name\": \"open_scheduler\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.anam.ai/v1/tools/{id}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Put.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"name\": \"open_scheduler\"\n}"

response = http.request(request)
puts response.read_body

{
  "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
}

{
  "error": "The tool changed since you read it. Read it again and reapply your change.",
  "code": "TOOL_CHANGED"
}

{
  "error": "Service temporarily unavailable",
  "message": "We could not check your API key. Please retry shortly."
}

PUT

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"
}
'

import requests

url = "https://api.anam.ai/v1/tools/{id}"

payload = { "name": "open_scheduler" }
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.put(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'PUT',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({name: 'open_scheduler'})
};

fetch('https://api.anam.ai/v1/tools/{id}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.anam.ai/v1/tools/{id}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PUT",
  CURLOPT_POSTFIELDS => json_encode([
    'name' => 'open_scheduler'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.anam.ai/v1/tools/{id}"

	payload := strings.NewReader("{\n  \"name\": \"open_scheduler\"\n}")

	req, _ := http.NewRequest("PUT", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.put("https://api.anam.ai/v1/tools/{id}")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"name\": \"open_scheduler\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.anam.ai/v1/tools/{id}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Put.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"name\": \"open_scheduler\"\n}"

response = http.request(request)
puts response.read_body

{
  "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
}

{
  "error": "The tool changed since you read it. Read it again and reapply your change.",
  "code": "TOOL_CHANGED"
}

{
  "error": "Service temporarily unavailable",
  "message": "We could not check your API key. Please retry shortly."
}

Authorizations

Authorization

string

header

required

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

Path Parameters

string<uuid>

required

Tool ID

Body

application/json

Fields to change; fields left out keep their values. config replaces the whole stored config. System tools can't be changed, and a tool can't become SYSTEM.

name

string

New name for the tool, saved as on create (characters other than letters, digits, _, . and - become _). A stored config.name that matches the old name is renamed too; sessions use the tool's own name.

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

disableInterruptions

boolean

default:false

The user can't interrupt the persona while this tool runs. Defaults to false.

Example:

false

expectedUpdatedAt

string<date-time> | null

The tool's updatedAt from your last read, or null if it was null. When the tool has changed since, the update is refused with 409 instead of overwriting that change.

config

CLIENT · object

Settings in the shape for the tool's type; fields of other shapes are stored but not used. null saves an empty config.

CLIENT
SERVER_RAG
SERVER_WEBHOOK

Show child attributes

Response

Successfully updated tool

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 the organization's live personas using this tool

Use the API

Sessions

Meetings

Avatar Videos

Personas

Avatars

Voices

Pronunciation Dictionaries

LLMs

Knowledge

Tools

Share Links

Engine

update tool

Authorizations

Path Parameters

Body

Response