curl --request PATCH \
--url https://tavusapi.com/v2/tools/{tool_id} \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--data '
{
"name": "get_current_weather"
}
'{
"tool_id": "tabc123def456",
"owner_id": 3675,
"name": "get_weather",
"description": "Get the current weather for a city",
"parameters": {
"type": "object",
"properties": {
"city": {
"type": "string",
"description": "City name"
}
},
"required": [
"city"
]
},
"delivery": {
"app_message": true,
"api": {
"url": "https://api.example.com/v1/weather/{city}",
"method": "POST",
"timeout": 10,
"headers": {
"X-Service": "weather-bot"
},
"auth": {
"type": "none",
"token": "<string>",
"username": "<string>",
"password": "<string>",
"name": "X-API-Key",
"value": "<string>",
"location": "header",
"secret": "<string>",
"token_url": "https://auth.example.com/oauth/token",
"client_id": "<string>",
"client_secret": "<string>",
"scope": "<string>"
},
"body_template": {},
"query_params": {
"units": "metric"
},
"content_type": "application/json"
}
},
"is_system_tool": false,
"trigger_type": "in_call",
"origin": "llm",
"on_call": "generate_filler",
"on_resolve": "generate_response",
"static_filler": "Sure, let me grab that for you.",
"created_at": "2026-05-15T10:30:00",
"updated_at": "2026-05-15T10:30:00"
}{
"error": "Bad Request. Cannot modify system tools"
}{
"message": "Invalid access token"
}Update Tool
Update one or more fields on a tool. Only fields present in the body are changed; omitted fields keep their stored value. System tools cannot be updated.
Secrets and the ******** placeholder. Get Tool returns secret fields scrubbed to ********. If you do a read-modify-write and PATCH that exact value back, the request is rejected - re-encrypting the placeholder would silently corrupt the stored secret. To keep the existing secret, omit the field from the auth object on PATCH.
Sending delivery: null resets delivery to the default { app_message: true }.
curl --request PATCH \
--url https://tavusapi.com/v2/tools/{tool_id} \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--data '
{
"name": "get_current_weather"
}
'{
"tool_id": "tabc123def456",
"owner_id": 3675,
"name": "get_weather",
"description": "Get the current weather for a city",
"parameters": {
"type": "object",
"properties": {
"city": {
"type": "string",
"description": "City name"
}
},
"required": [
"city"
]
},
"delivery": {
"app_message": true,
"api": {
"url": "https://api.example.com/v1/weather/{city}",
"method": "POST",
"timeout": 10,
"headers": {
"X-Service": "weather-bot"
},
"auth": {
"type": "none",
"token": "<string>",
"username": "<string>",
"password": "<string>",
"name": "X-API-Key",
"value": "<string>",
"location": "header",
"secret": "<string>",
"token_url": "https://auth.example.com/oauth/token",
"client_id": "<string>",
"client_secret": "<string>",
"scope": "<string>"
},
"body_template": {},
"query_params": {
"units": "metric"
},
"content_type": "application/json"
}
},
"is_system_tool": false,
"trigger_type": "in_call",
"origin": "llm",
"on_call": "generate_filler",
"on_resolve": "generate_response",
"static_filler": "Sure, let me grab that for you.",
"created_at": "2026-05-15T10:30:00",
"updated_at": "2026-05-15T10:30:00"
}{
"error": "Bad Request. Cannot modify system tools"
}{
"message": "Invalid access token"
}Path Parameters
Body
Response
Tool updated
A standalone tool definition. Returned by every tool endpoint and embedded in the data array of the PAL-tool endpoints.
How the tool call is dispatched. Exactly one channel must be enabled:
app_message: truealone - the call is delivered to your frontend over the Daily data channel as aconversation.tool_callevent.apiset withapp_message: false- Tavus makes an HTTPS request toapi.url.
If delivery is omitted on create, the default is { "app_message": true }.
Show child attributes
Show child attributes

