Skip to main content
POST

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

Headers

Idempotency-Key
string

A unique identifier (1 to 255 printable ASCII characters) so that retries of the same request return the same response without placing a second call. Cached for 24 hours. Reusing the key with a different body returns 409 idempotency_conflict.

Maximum string length: 255
Example:

"lead-abc-2026-04-30-001"

Body

application/json
agent_id
string
required

The Ryvo uuid of the agent, or its ElevenLabs id (agent_...). Must belong to your account.

Example:

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

to
string
required

The destination number in E.164 format.

Pattern: ^\+[1-9]\d{6,14}$
Example:

"+5215555550100"

metadata
object

Optional variables passed to the agent as dynamic variables. At most 5 KB. Keys up to 64 characters; values must be strings (up to 2000 characters), numbers, booleans or null.

Example:

Response

The call was placed.

id
string
required

The call handle (call_<conversation_id>). Accepted by GET /v1/calls/{id}.

Example:

"call_conv_01abcdef"

agent_id
string
required

The agent_id you sent.

Example:

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

to
string
required
Example:

"+5215555550100"

status
enum<string>
required

To learn how the call ended, subscribe to call.completed and call.failed webhooks or poll GET /v1/calls/{id}.

Available options:
initiated
created_at
string<date-time>
required
Example:

"2026-04-30T18:32:11.123Z"