Skip to main content
GET
Get an agent version

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"

version
integer
required

The version number (1 or higher). A malformed or unknown version is 404.

Required range: x >= 1
Example:

3

Response

The version.

version
integer
required
Example:

3

created_at
string<date-time>
required
system_prompt
string
required
Example:

"You are the receptionist of Acme Dental. Book appointments and answer questions about opening hours."

first_message
string
required
Example:

"Hi, this is Acme Dental. How can I help you?"

language
string | null
required
Example:

"es-MX"

llm
object
required

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

stt
object
required

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

voice
object
required

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

knowledge_base
object
required

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

dynamic_variables
object
required
Example:
conversation
object
required

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

tool_ids
string<uuid>[]
required