Resumen de la API de Rivya

Rivya API v1 es el punto de entrada para desarrolladores que quieren llamar a capacidades de modelos de Rivya desde su propio producto.

La API pública admite generación asíncrona de imágenes, video y audio, además de turnos de Chat API con respuestas sin streaming o con streaming SSE. Usa IDs de modelo de Rivya, créditos de cuenta de Rivya, IDs públicos de tarea para generación y sesiones de chat del lado del servidor para Chat API.

Para qué sirve la API

Usa la API cuando quieras:

• enviar trabajos de generación de imagen, video o audio desde tu propia aplicación
• enviar turnos de chat con o sin streaming y continuar sesiones de chat creadas por API
• mantener la facturación dentro de la misma cartera de créditos de la cuenta de Rivya
• consultar el estado de una tarea por ID público de tarea
• usar reintentos idempotentes para solicitudes de producción más seguras
• mantener el uso de Studio y API dentro del mismo límite de cuenta

La API es una capa de producto de Rivya. Las respuestas públicas usan solo nombres de Rivya y campos públicos.

Alcance de la versión actual

Endpoints v1 actuales:

• GET /api/v1/models
• POST /api/v1/generations
• POST /api/v1/files
• GET /api/v1/files/{fileId}
• POST /api/v1/chat/completions
• GET /api/v1/chat/sessions
• GET /api/v1/chat/sessions/{sessionId}
• GET /api/v1/generations/{taskId}
• GET /api/v1/credits
• GET /api/v1/webhooks
• POST /api/v1/webhooks
• GET /api/v1/webhook-events
• GET /api/v1/openapi.json

La versión actual incluye webhooks firmados para resultados de generación asíncrona, Chat API y una beta del SDK TypeScript con soporte de streaming del lado del servidor.

Autenticación

Los endpoints de generación, estado y créditos requieren:

Authorization: Bearer rvya_sk_...

Crea y rota claves desde configuración de claves de API. Lee Autenticación de API antes de usar una clave en producción.

Modelo de facturación

Las llamadas a la API usan los mismos créditos de cuenta de Rivya que Studio.

Los trabajos de generación reservan o consumen créditos cuando la tarea empieza. Los turnos de Chat reservan créditos antes de llamar al modelo y liquidan los créditos finales a partir del uso de tokens cuando se guarda el mensaje del asistente. Si una generación o un turno de chat falla bajo las reglas de fallo existentes de Rivya, se aplica el mismo manejo de reembolsos.

Lee Créditos de API y Créditos y facturación en Rivya para entender el modelo de cartera visible para el usuario.

Primera ruta de integración

1. Crea una clave de API en Settings.
2. Llama a Listar modelos de API para elegir un ID de modelo público.
3. Lee Referencia de API de modelos para revisar los parámetros del modelo.
4. Si el modelo necesita medios de referencia, súbelos con Files API.
5. Envía un trabajo con Crear generación.
6. Consulta Estado de generación hasta que la tarea termine con éxito o error, o suscríbete a API Webhooks para recibir eventos de finalización firmados.
7. Para modelos de chat, usa Chat API en lugar del endpoint de generación. Los adjuntos de imagen en Chat deben referenciar valores file_id de Files API.

Páginas relacionadas

• Inicio rápido de API
• Autenticación de API
• SDK TypeScript de Rivya
• Referencia de API de modelos
• Chat API
• API Webhooks
• Errores y límites de API