Crea una clave API, elige un modelo, envía un trabajo asíncrono de generación y manda un turno de Chat API con streaming SSE opcional.

Este inicio rápido muestra el camino seguro más corto desde la configuración de cuenta hasta un trabajo de generación de Rivya API, más el primer turno de Chat API.

Usa claves de ejemplo en la documentación y en los ejemplos. Nunca pegues una clave API real en código público, capturas, incidencias o documentos compartidos.

Los ejemplos describen el contrato implementado de la API pública v1. Antes de probarlos, confirma que el despliegue tiene habilitado el acceso y que tu cuenta puede usarlo. Que una ruta o una página de modelo esté documentada no demuestra por sí solo que la solicitud funcione en todos los entornos.

1. Crear una clave API

Abre ajustes de API Keys, crea una clave, copia el secreto completo una sola vez y guárdalo en el entorno de tu servidor.

Scopes recomendados para la primera clave:

models:read
generations:create
generations:read
files:create
files:read
credits:read
webhooks:manage
chat:create
chat:read

2. Confirmar la base URL

Usa la base URL de la API de producción:

https://rivya.ai

Las URL de localhost son solo para desarrollo local. Los ejemplos públicos no deben usar secretos locales.

3. Listar modelos

curl https://rivya.ai/api/v1/models

Usa el campo id de la respuesta como valor de model al crear una generación.

4. Enviar una generación

curl https://rivya.ai/api/v1/generations \
  -H "Authorization: Bearer rvya_sk_..." \
  -H "Content-Type: application/json" \
  -H "Idempotency-Key: quickstart-001" \
  -d '{
    "model": "z-image",
    "prompt": "A clean editorial product image on a soft studio background"
  }'

La respuesta devuelve un ID público de tarea. Guárdalo para poder consultar el estado más tarde.

5. Consultar estado

curl https://rivya.ai/api/v1/generations/task_public_id \
  -H "Authorization: Bearer rvya_sk_..."

Los valores de estado son:

queued
processing
succeeded
failed

6. Comprobar créditos

curl https://rivya.ai/api/v1/credits \
  -H "Authorization: Bearer rvya_sk_..."

Úsalo para confirmar el saldo actual de la cuenta antes o después de probar.

7. Opcional: añadir webhooks

Si el acceso a webhooks está habilitado para el despliegue y la cuenta, y tu servidor puede recibir devoluciones HTTPS firmadas, crea un destino:

curl https://rivya.ai/api/v1/webhooks \
  -H "Authorization: Bearer rvya_sk_..." \
  -H "Content-Type: application/json" \
  -d '{
    "name": "Production webhook",
    "url": "https://example.com/rivya/webhook",
    "event_types": ["generation.succeeded", "generation.failed"]
  }'

Guarda el signing_secret de visualización única de la respuesta y verifica cada entrega antes de confiar en el payload.

8. Opcional: enviar un turno de Chat

Para modelos de chat, llama a Chat API en lugar de POST /api/v1/generations:

curl https://rivya.ai/api/v1/chat/completions \
  -H "Authorization: Bearer rvya_sk_..." \
  -H "Content-Type: application/json" \
  -H "Idempotency-Key: quickstart-chat-001" \
  -d '{
    "model": "claude-sonnet-5-chat",
    "message": "Write a concise launch plan for a new product image campaign"
  }'

Usa el session_id devuelto para continuar la sesión creada por API. Los adjuntos de imagen deben referenciar valores file_id de Files API.

Opcional: usar la beta del SDK TypeScript

Las integraciones TypeScript de servidor pueden usar la beta del SDK local:

import { RivyaClient } from "@rivya/sdk";

const rivya = new RivyaClient({
  apiKey: process.env.RIVYA_API_KEY
});

const generation = await rivya.generations.create({
  model: "z-image",
  prompt: "A clean editorial product image on a soft studio background"
});

Lee Rivya TypeScript SDK antes de adoptarlo. El SDK incluye soporte de streaming de Chat del lado del servidor en la beta privada.

Inicio rápido de Rivya API