Skip to main content
GET
Get 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"

Response

The agent.

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