Rivya API

Crea sobre la capa de modelos multimodales de Rivya

Rivya API da a los equipos de producto una forma pública y basada en cuenta de llamar modelos de Rivya desde sus propias apps. Empieza con trabajos asíncronos de imagen, video y audio, añade turnos de Chat API con streaming SSE opcional cuando el modelo admita chat, y conserva la facturación dentro de la misma billetera de créditos de Rivya.
Leer la documentación de la APICrear una clave de API

Forma del inicio rápido

Capa de modelos

Catálogo dinámico

Facturación

Créditos compartidos

Primera versión

Trabajos + Chat

Acceso

Claves de API

MétodoPOST
Endpoint/api/v1/generations

La solicitud real requiere una clave de Rivya API y créditos disponibles en la cuenta. Los ejemplos públicos usan secretos de marcador de posición y no llaman modelos de forma anónima.

Solicitud
curl https://rivya.ai/api/v1/generations \
  -H "Authorization: Bearer rvya_sk_..." \
  -H "Content-Type: application/json" \
  -H "Idempotency-Key: demo-job-001" \
  -d '{
    "model": "z-image",
    "prompt": "Editorial product photo on a clean studio set"
  }'
Respuesta
{
  "id": "task_public_id",
  "status": "queued",
  "model": "z-image",
  "reserved_credits": 20,
  "result": null,
  "error": null
}

Lo que llega primero

Una capa de API pública alineada con el producto Rivya

La API está diseñada como una superficie de producto de Rivya. Usa IDs de modelos de Rivya, créditos de Rivya, estados públicos de tareas y documentación conectada al catálogo de modelos.

API de generación de imágenes

Envía trabajos de imagen con prompt y parámetros de modelo compatibles, y luego consulta los resultados públicos.

API de generación de video

Ejecuta trabajos de video asíncronos con los mismos controles de tarea y créditos que usa Studio.

API de generación de audio

Usa modelos de audio accesibles por API desde la misma cuenta, saldo y límite de historial.

Billetera de créditos compartida

Las llamadas de API y el uso de Studio consumen el mismo saldo de Rivya, con créditos reservados y manejo de fallos.

Ruta de inicio

De una cuenta a la primera solicitud de API

01

Crea una clave

Inicia sesión, abre API Keys en Settings, crea una clave con alcance definido y guarda el secreto completo de inmediato.

02

Elige un modelo

Lee la referencia de modelos de la API o llama a /api/v1/models para revisar IDs de modelo, parámetros, capacidades de chat y preparación de entrada antes de enviar.

03

Envía, consulta o suscríbete

Envía una solicitud de generación idempotente, consulta el endpoint público de tareas, usa webhooks firmados para callbacks de generación o envía un turno de Chat API con streaming SSE opcional.

Límite de versión

Alcance claro, sin promesas ocultas

La página de destino puede mencionar superficies futuras, pero el texto actual del producto no debe sugerir que APIs sin terminar ya están activas.

Chat API

Disponible

Disponible para turnos sin streaming y con streaming SSE, con sesiones creadas por API, créditos de cuenta y adjuntos de imagen opcionales mediante Files API.

Files API

Disponible

Disponible para subir imágenes, videos y audio de referencia. Úsala antes de generar cuando una página de modelo pida params.referenceMediaItems.

Webhooks de usuario

Disponible

Disponibles para integraciones de producción que quieren callbacks firmados cuando las tareas de generación se completan o fallan.

Depurador en línea

Previsualiza la solicitud y luego ejecútala con tu propia clave de API

El depurador empieza en modo mock para todos los visitantes. El selector de generación lista modelos que no son de chat y pueden probarse sin subir archivos, mientras que el panel Files permite a usuarios con sesión iniciada probar /api/v1/files con una clave de API temporal. Los ejemplos de chat están en la documentación de la API.

Estado de la cuenta

Comprobando cuenta

Prefijo de clave activa

Crea primero una clave

Créditos actuales

Inicia sesión para comprobar

Vista previa mockPublic API en vivoSin clave de API activa

El modo mock nunca llama a un modelo ni consume créditos.

Pega la clave solo para esta solicitud. El depurador no la guarda después de actualizar la página.

Prueba de subida de Files API

Sube medios de referencia con POST /api/v1/files, luego copia la URL y el token de duración devueltos en params.referenceMediaItems para un modelo que admita entradas de referencia.

Mock nunca sube archivosEn vivo usa /api/v1/files

El modelo seleccionado controla los tipos MIME permitidos, el tamaño y las reglas de duración. Las subidas en vivo requieren tu clave de API temporal y pueden llamar al servicio real de subida.

Crear clave de APILeer documentación de la API
Vista previa de solicitud
{
  "model": "z-image",
  "prompt": "Foto editorial de producto en un set de estudio limpio",
  "params": {
    "aspect_ratio": "1:1"
  }
}
Respuesta
{
  "id": "mock_task_001",
  "status": "queued",
  "model": "z-image",
  "reserved_credits": 1,
  "final_credits": 0,
  "result": null,
  "error": null
}
Respuesta de Files API
{
  "id": "file_mock_001",
  "object": "file",
  "kind": "image",
  "file_name": "reference.png",
  "mime_type": "image/png",
  "size_bytes": 245760,
  "url": "https://media.example/reference.png",
  "duration_seconds": null,
  "duration_token": null,
  "created_at": "2026-05-11T00:00:00.000Z",
  "expires_at": null
}
Parámetros de generación
{
  "params": {
    "referenceMediaItems": [
      {
        "url": "https://media.example/reference.png",
        "kind": "image",
        "name": "reference.png",
        "mimeType": "image/png"
      }
    ]
  }
}

Estado de tarea

Créditos base estimados

1

Estado

queued

Documentación de la API

Lee sobre autenticación, cuerpos de solicitud, respuestas, idempotencia, parámetros de modelo y códigos de error.

Abrir documentación

Gestión de claves de API

Crea, copia una vez, revoca y rota claves de API desde el área protegida de Settings.

Gestionar claves

Depuración en línea

Usa primero ejemplos mock; la depuración real requiere inicio de sesión, una clave de API y créditos de cuenta.

Previsualizar flujo