Skip to main content

Documentation Index

Fetch the complete documentation index at: https://ryvo-3dab4d1a.mintlify.app/llms.txt

Use this file to discover all available pages before exploring further.

1. Crea tu API key

Entra a app.ryvo.so/developers, click en Nueva API key, ponle un nombre (ej. “n8n producción”) y copia el token completo.
El token se muestra una sola vez. Si lo pierdes, revoca esa key y crea una nueva.

2. Encuentra el agent_id

En el portal entra a Agentes y copia el ID del agente que quieres usar. Tiene formato agent_xxx....

3. Dispara tu primera llamada

curl -X POST https://api.ryvo.so/v1/calls \
  -H "Authorization: Bearer ryvo_live_..." \
  -H "Content-Type: application/json" \
  -H "Idempotency-Key: $(uuidgen)" \
  -d '{
    "agent_id": "agent_8801kpabc123",
    "to": "+5215555550100",
    "metadata": {
      "lead_name": "Juan García",
      "deal_id": "OPP-42"
    }
  }'
Respuesta esperada:
{
  "id": "call_conv_01abcdef",
  "agent_id": "agent_8801kpabc123",
  "to": "+5215555550100",
  "status": "initiated",
  "created_at": "2026-04-30T18:32:11.123Z"
}

4. (Opcional) Recibe el resultado por webhook

Si quieres saber cómo terminó la llamada, configura un webhook en app.ryvo.so/developers. Vas a recibir un POST con eventos como:
{
  "id": "evt_abc123",
  "type": "call.completed",
  "created_at": "2026-04-30T18:35:42.123Z",
  "data": {
    "id": "call_conv_01abcdef",
    "agent_id": "agent_8801kpabc123",
    "status": "completed",
    "duration_seconds": 211,
    "transcript_summary": "El lead aceptó agendar una demo para el 5 de mayo a las 11am.",
    "started_at": "2026-04-30T18:32:13Z",
    "ended_at": "2026-04-30T18:35:44Z"
  }
}
Lee Webhooks → Verificar firmas para validar que el evento viene de Ryvo y no de un atacante.

Próximos pasos

Manejo de errores

Códigos que devolvemos y qué significa cada uno.

Idempotencia

Cómo no disparar 2 llamadas si reintentas.

Eventos

Lista completa de eventos y sus payloads.

Referencia API

Todos los endpoints en detalle.