> ## Documentation Index > Fetch the complete documentation index at: https://docs.ryvo.so/llms.txt > Use this file to discover all available pages before exploring further. # List available models > The public catalog of language models with, for each plan, whether the model is available and what it costs per turn and per voice minute in credits and USD. No authentication; cached for an hour. ## OpenAPI ````yaml /openapi.yaml get /v1/models openapi: 3.1.0 info: title: Ryvo API version: 1.0.0 description: > The Ryvo public API lets you drive your AI voice and chat agents from your own systems: trigger calls, read conversations and transcripts, manage agents, knowledge base documents, phone numbers, outbound campaigns and webhooks, and read billing, team and log data. It is the same platform the portal uses, exposed over plain HTTPS and JSON. **Base URL**: `https://api.ryvo.so` ## Authentication Every request (except `GET /v1/models`) carries an API key as a Bearer token: ``` Authorization: Bearer ryvo_live_... ``` Keys are created in the portal under **Settings > API keys** (`https://app.ryvo.so/developers`). The full token is shown once at creation time. The API is available from the Starter plan up. ## Scopes Each key carries a list of scopes in the form `resource:action`, chosen when the key is created. An endpoint requires exactly one scope (listed on each operation as `x-scope`). A key without it receives `403 insufficient_scope`, and the message names the missing scope. | Scope | Opens | |---|---| | `agents:read`, `agents:write` | `/v1/agents` | | `calls:read`, `calls:write` | `/v1/calls` | | `conversations:read` | `/v1/conversations` | | `knowledge:read`, `knowledge:write` | `/v1/knowledge` | | `phone_numbers:read`, `phone_numbers:write` | `/v1/phone-numbers` | | `campaigns:read`, `campaigns:write` | `/v1/batch-calls` | | `webhooks:read`, `webhooks:write` | `/v1/webhooks` | | `integrations:read` | `/v1/integrations` | | `team:read` | `/v1/team` | | `billing:read` | `/v1/billing` | | `logs:read` | `/v1/logs` | `GET /v1/me` only needs a valid key and reports the scopes it carries. Integrations, team and billing are read-only by design: connecting an app is a browser OAuth flow, inviting people is persistent access, and buying credits from a loop is the failure mode nobody wants. ## Pagination Every list takes `?limit=` (1 to 100, default 20) and `?cursor=`, and answers `{ "data": [...], "has_more": true|false, "next_cursor": "..."|null }`. The cursor is opaque: pass `next_cursor` back as `?cursor=` to fetch the following page, and stop when `has_more` is `false`. ## Idempotency `POST /v1/calls` accepts an `Idempotency-Key` header (1 to 255 printable ASCII characters). Retrying the same key with the same body returns the original response for 24 hours without dialing again; the same key with a different body returns `409 idempotency_conflict`. ## Rate limits Two limits apply, in this order, on fixed one-minute windows: 1. **Per IP address**: 300 requests/min across every `/v1` endpoint, except `POST /v1/calls`, which has its own bucket of 10 requests/min per IP because it dials a real phone. 2. **Per account, by plan**: shared by every key of the account (Starter 10, Pro 40, Scale and Enterprise 120 requests/min). A `429 rate_limit_exceeded` response carries a `Retry-After` header with the seconds to wait (always at least 1). ## Errors and request ids Every error uses the same envelope: `{ "error", "message", "request_id" }`. Branch on `error`, which is a stable code; `message` is for humans and may change. The stable codes are `unauthorized`, `forbidden`, `insufficient_scope`, `rate_limit_exceeded`, `invalid_json`, `invalid_body`, `invalid_query`, `not_found`, `conflict`, `unsupported_runtime`, `plan_limit`, `payment_required`, `upstream_error` and `internal_error`. `POST /v1/calls` keeps a few older codes of its own (`agent_not_found`, `agent_disabled`, `idempotency_conflict`, `invalid_idempotency_key`, `key_budget_exhausted`, `upstream_unreachable`, `service_unavailable`). Every response, success or error, carries an `X-Request-Id` header. Quote it when you report a problem. A `404 not_found` is returned both when a resource does not exist and when it belongs to another account, with the same message: the API does not confirm which ids exist. contact: name: Ryvo support email: team@ryvo.so url: https://ryvo.so servers: - url: https://api.ryvo.so description: Production security: - bearerAuth: [] tags: - name: Account description: Who the key belongs to and what it can do. - name: Agents description: >- Your agents on both runtimes. Engine agents are fully manageable (configuration, versions, publish). ElevenLabs agents are listed and can be renamed; their configuration lives in the portal. - name: Calls description: >- Voice conversations (phone and web voice) on both runtimes, and the endpoint to trigger an outbound call. - name: Conversations description: >- Every conversation on every channel (voice, chat, WhatsApp), with the same shape as calls plus the message count. - name: Knowledge base description: >- Documents and folders that Engine agents consult during a conversation. Requires the Engine module on your plan. - name: Phone numbers description: Numbers imported from your Twilio account and their agent assignment. - name: Batch calls description: >- Outbound campaigns on the ElevenLabs runtime. Uses the `campaigns:*` scopes. - name: Webhooks description: Outbound endpoints, their deliveries and the event catalog. - name: Integrations description: >- The integration catalog with the connection status of your account. Read-only. - name: Team description: Members, invitations and seats. Read-only. - name: Billing description: Plan, credits, wallet ledger, invoices and daily usage. Read-only. - name: Logs description: Requests made to this API and the account activity log. - name: Models description: The public model catalog with credits and USD per plan. No authentication. paths: /v1/models: get: tags: - Models summary: List available models description: | The public catalog of language models with, for each plan, whether the model is available and what it costs per turn and per voice minute in credits and USD. No authentication; cached for an hour. operationId: listModels responses: '200': description: The catalog. headers: Cache-Control: schema: type: string example: public, s-maxage=3600, stale-while-revalidate=600 content: application/json: schema: $ref: '#/components/schemas/ModelCatalog' security: [] components: schemas: ModelCatalog: type: object description: >- Field names in this catalog are in Spanish; they are shared with the pricing page. required: - generado_en - credito_usd - planes - modelos properties: generado_en: type: string format: date-time credito_usd: type: number description: The value of one credit in USD. example: 0.001 planes: type: array items: type: object required: - id - nombre - precio_usd properties: id: $ref: '#/components/schemas/PublicPlanId' nombre: type: string example: Pro precio_usd: type: - number - 'null' example: 99 modelos: type: array items: $ref: '#/components/schemas/Model' PublicPlanId: type: string enum: - pay_as_you_go - starter - pro - scale - enterprise Model: type: object required: - id - nombre - familia - tier - contexto - etiquetas - precios properties: id: type: string example: openai/gpt-4o-mini nombre: type: string example: GPT-4o mini familia: type: string example: openai tier: type: string example: standard contexto: type: - integer - 'null' description: Context window in tokens. example: 128000 etiquetas: type: array items: type: string enum: - reasoning - fast - vision - tools precios: type: object description: Keyed by plan id. additionalProperties: $ref: '#/components/schemas/ModelPricing' ModelPricing: type: object required: - disponible - desde_plan - creditos_por_turno - usd_por_turno - creditos_por_minuto - usd_por_minuto properties: disponible: type: boolean description: Whether the plan can pick this model. desde_plan: oneOf: - $ref: '#/components/schemas/PublicPlanId' - type: 'null' description: The first plan that offers it, when this one does not. creditos_por_turno: type: number example: 12 usd_por_turno: type: number example: 0.012 creditos_por_minuto: type: number example: 170 usd_por_minuto: type: number example: 0.17 securitySchemes: bearerAuth: type: http scheme: bearer bearerFormat: API key (ryvo_live_...) description: | 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_...` ````