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
string | null

Agent region code to move the agent to, for future calls. When the agent's project has a World part, an update made with an API key moves the project with it, to the place that region runs in. The agent's current region changes nothing. Send a new region or a world_part_code, not both. See Change an agent's region.

Pattern: ^[a-z0-9]+(?:-[a-z0-9]+)*$
Example:

"eu-west"

world_part_code
string

Gateway code of the place to move the agent's project to, from Region availability. The agent moves to an agent region at that place, and a project shown as Not connected gets connected. A place where no agent of the agent's runtime runs is refused with 422. Send a new region or a world_part_code, not both.

Maximum string length: 20
Pattern: ^[a-z0-9]+(?:-[a-z0-9]+)*$
Example:

"eu-north"

models
object

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

llm_router_enabled
boolean | null

Routes the agent's LLM traffic through SLNG's managed LLM routing layer. Omit to keep the current setting.

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
tool_refs
object[] | null

Complete shared tool attachment list. PATCH rejects attachment changes; use PUT.

Maximum array length: 128
mcp_refs
object[] | null

Complete MCP attachment list. PATCH rejects attachment changes; use PUT.

Maximum array length: 128
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
template_variable_options
object | null

Per-variable options for the input variables used in the prompt and greetings, keyed by variable name. Use this to mark an input variable optional.

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
tool_mode
enum<string>
required

Tool system fixed when the agent was created. New agents use shared.

Available options:
legacy,
shared
tools
object[]
required
deprecated
read-only

Legacy compatibility output. New shared agents return an empty array. Use tool_refs and mcp_refs for all new configuration.

tool_refs
object[]
required
mcp_refs
object[]
required
livekit_deployment
string
required

Name of the runtime deployment serving this agent.

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
project_id
string<uuid> | null

The project the agent belongs to.

Example:

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

world_part_code
string | null

Gateway code of the place the agent's project runs in. Null when the project shows Not connected under World part.

Example:

"eu-west"

world_part_label
string | null

Display name of world_part_code.

models_validation_error
string | null

Set when the stored models configuration no longer validates against the current rules. In that case models is returned as stored, without validation.

llm_router_enabled
boolean

Whether the agent's LLM traffic is routed through SLNG's managed LLM routing layer.

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"