Skip to main content
PATCH
Update agent (partial)

Authorizations

Authorization
string
header
required

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

Path Parameters

agent_id
string<uuid>
required

Voice agent ID.

Example:

"550e8400-e29b-41d4-a716-446655440000"

Body

application/json
name
string | null
Maximum string length: 255
system_prompt
string | null
greeting
string | null
inbound_greeting
string | null
outbound_greeting
string | null
language
string | null
Maximum string length: 10
region
enum<string> | null

Change the region where the agent runs.

Available options:
us-east,
eu-central,
ap-south
models
object

Model configuration for the agent runtime (STT + LLM + TTS).

idle_nudges
object | null

Optional silence recovery behavior. The runtime can send two follow-up nudges, then speak a final message and hang up.

enable_interruptions
boolean | null
tools
(Template tool · object | Utility tool · object | Webhook · object | Human transfer · object)[] | null

Built-in call control tools (hangup, voicemail detection).

sip_inbound_trunk_id
string<uuid> | null
Example:

"550e8400-e29b-41d4-a716-446655440000"

sip_outbound_trunk_id
string<uuid> | null
Example:

"550e8400-e29b-41d4-a716-446655440000"

template_defaults
object | null
runtime_variables
object[] | null

Response

Updated agent.

id
string<uuid>
required
Example:

"550e8400-e29b-41d4-a716-446655440000"

organisation_id
string<uuid>
required
Example:

"550e8400-e29b-41d4-a716-446655440000"

name
string
required
system_prompt
string
required
greeting
string
required
language
string
required
region
string
required
models
object
required

Model configuration for the agent runtime (STT + LLM + TTS).

idle_nudges
object
required

Optional silence recovery behavior. The runtime can send two follow-up nudges, then speak a final message and hang up.

enable_interruptions
boolean
required
tools
(Template tool · object | Utility tool · object | Webhook · object | Human transfer · object)[]
required
template_variables
object
required
created_at
string<date-time>
required
Example:

"2026-01-15T10:30:00Z"

updated_at
string<date-time>
required
Example:

"2026-01-15T10:30:00Z"

inbound_greeting
string | null
outbound_greeting
string | null
sip_inbound_trunk_id
string<uuid> | null
Example:

"550e8400-e29b-41d4-a716-446655440000"

sip_outbound_trunk_id
string<uuid> | null
Example:

"550e8400-e29b-41d4-a716-446655440000"

runtime_variables
object[]
deleted_at
string<date-time> | null
Example:

"2026-01-15T10:30:00Z"