Skip to main content
PATCH
Update Tool

Authorizations

X-API-Key
string
header
required

Workspace API key (e.g. kej_live_...)

Path Parameters

tool_id
string
required

Body

application/json

Partial update for a tool.

name
string | null
Required string length: 1 - 100
display_name
string | null
description
string | null
http_config
HttpConfigInput · object | null

HTTP configuration for a tool.

dynamic_parameters
DynamicParameterInput · object[] | null
static_parameters
StaticParameterInput · object[] | null
response_schema
Response Schema · object | null
timeout
integer | null
Required range: 1000 <= x <= 60000
retry_count
integer | null
Required range: 0 <= x <= 5
precomputable
boolean | null

Voice only: speculative execution flag. Ignored for chat.

agent_reaction
enum<string> | null

Voice only: agent's reaction when the tool fires. Ignored for chat.

Available options:
speaks,
silent,
speaks-once

Response

Successful Response

A custom HTTP tool (public-safe response).

id
string
required
name
string
required
tool_type
string
required
timeout
integer
required
retry_count
integer
required
display_name
string | null
description
string | null
http_config
Http Config · object | null
parameters
Parameters · object | null
response_schema
Response Schema · object | null
precomputable
boolean
default:false
agent_reaction
enum<string>
default:speaks

How the voice agent reacts when a tool call fires.

Ultravox-specific. Ignored by chat tool-calling.

  • SPEAKS: agent speaks naturally around the tool call (Ultravox default)
  • SILENT: agent stays silent until the tool returns
  • SPEAKS_ONCE: agent speaks at most one filler line during the tool call
Available options:
speaks,
silent,
speaks-once
created_at
string | null
updated_at
string | null