Skip to main content
GET
Get an agent

Autorizaciones

Authorization
string
header
requerido

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_...

Parámetros de ruta

id
string<uuid>
requerido

The Ryvo uuid of the agent.

Ejemplo:

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

Respuesta

The agent.

id
string<uuid>
requerido
Ejemplo:

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

runtime
enum<string>
requerido

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

Opciones disponibles:
engine,
elevenlabs
Ejemplo:

"engine"

name
string
requerido
Ejemplo:

"Sales assistant"

status
enum<string>
requerido
Opciones disponibles:
draft,
active,
paused,
archived,
error
Ejemplo:

"active"

language
string | null
requerido
Ejemplo:

"es-MX"

created_at
string<date-time>
requerido
Ejemplo:

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

updated_at
string<date-time>
requerido
Ejemplo:

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

phone_numbers
object[]
requerido

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

config
object
requerido

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_...).

Ejemplo:

"agent_8801kpabc123"

current_version
integer

Only on engine agents. The latest saved version.

Ejemplo:

4

published_version
integer

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

Ejemplo:

3