Skip to main content
PATCH
Update an agent

Authorizations

Authorization
string
header
required

A Bearer token. Create keys in the portal under Settings > API keys (https://app.ryvo.so/developers). The token has the form ryvo_live_<64 hex characters> and is shown once.

Header: Authorization: Bearer ryvo_live_...

Path Parameters

id
string<uuid>
required

The Ryvo uuid of the agent.

Example:

"4d0f3c2a-6b7e-4a1c-9f2d-1e2b3c4d5e6f"

Body

application/json

Every field is optional; send at least one besides expected_version. Unknown keys are rejected.

name
string
Required string length: 2 - 80
status
enum<string>
Available options:
active,
paused
expected_version
integer

The current_version you last read. Defaults to the current head.

Required range: x >= 0
system_prompt
string
Required string length: 1 - 40000
first_message
string
Maximum string length: 2000
language
string
Maximum string length: 35
llm
object

Which model answers. provider and model are validated against the catalog and your plan when saving (see GET /v1/models).

stt
object

Speech recognition. settings and sample_rate are provider-specific and validated when saving.

voice
object

Text to speech. A voice_id is required to publish a voice agent.

knowledge_base
object

Which documents and folders the agent consults. Ownership is verified when saving.

dynamic_variables
object
conversation
object

Session limits, recording, turn policy, audio, pronunciation and calling hours. Unknown keys are kept.

tool_ids
string<uuid>[]
Maximum array length: 50

Response

The agent after the update.

id
string<uuid>
required
Example:

"4d0f3c2a-6b7e-4a1c-9f2d-1e2b3c4d5e6f"

runtime
enum<string>
required

engine is the Ryvo runtime; elevenlabs is the legacy voice runtime.

Available options:
engine,
elevenlabs
Example:

"engine"

name
string
required
Example:

"Sales assistant"

status
enum<string>
required
Available options:
draft,
active,
paused,
archived,
error
Example:

"active"

language
string | null
required
Example:

"es-MX"

created_at
string<date-time>
required
Example:

"2026-09-01T15:04:05.000Z"

updated_at
string<date-time>
required
Example:

"2026-09-20T10:11:12.000Z"

phone_numbers
object[]
required

The numbers assigned to the agent. Empty for Engine agents today.

config
object
required

The head definition (engine), the stored summary (elevenlabs), or null when nothing is saved yet.

provider_agent_id
string | null

Only on elevenlabs agents. The agent id at the provider (agent_...).

Example:

"agent_8801kpabc123"

current_version
integer

Only on engine agents. The latest saved version.

Example:

4

published_version
integer

Only on engine agents. The version serving traffic; 0 when never published.

Example:

3