Erstelle einen API Key, wähle ein Modell, reiche einen asynchronen Generation-Job ein und sende einen Chat API-Turn mit optionalem SSE-Streaming.

Dieser Quickstart zeigt den kürzesten sicheren Weg vom Account-Setup zu einem Rivya API-Generation-Job plus dem ersten Chat API-Turn.

Nutze Platzhalter-Keys in Docs und Beispielen. Füge niemals einen echten API Key in öffentlichen Code, Screenshots, Tickets oder geteilten Dokumenten ein.

1. API Key erstellen

Öffne die API-Keys-Einstellungen, erstelle einen Key, kopiere das vollständige Secret einmal und speichere es in deiner serverseitigen Umgebung.

Empfohlene erste Scopes:

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

2. Base URL bestätigen

Nutze die Produktions-API-Base-URL:

https://rivya.ai

Localhost-URLs sind nur für lokale Entwicklung gedacht. Öffentliche Beispiele sollten keine lokalen Secrets verwenden.

3. Modelle auflisten

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

Nutze das Feld id aus der Antwort als model-Wert, wenn du eine Generation erstellst.

4. Generation einreichen

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"
  }'

Die Antwort gibt eine öffentliche Task-ID zurück. Speichere sie, damit du später den Status abfragen kannst.

5. Status abfragen

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

Statuswerte sind:

queued
processing
succeeded
failed

6. Credits prüfen

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

Nutze dies, um vor oder nach Tests das aktuelle Kontoguthaben zu bestätigen.

7. Optional: Webhooks hinzufügen

Wenn dein Server signierte HTTPS-Callbacks empfangen kann, erstelle einen Webhook-Endpoint:

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"]
  }'

Speichere das einmalige signing_secret aus der Antwort und verifiziere jede Delivery, bevor du dem Payload vertraust.

8. Optional: Chat-Turn senden

Rufe für Chat-Modelle Chat API statt POST /api/v1/generations auf:

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": "gpt-5-2-chat",
    "message": "Write a concise launch plan for a new product image campaign"
  }'

Nutze die zurückgegebene session_id, um die API-erstellte Session fortzusetzen. Bildanhänge müssen Files API-file_id-Werte referenzieren.

Optional: TypeScript-SDK-Beta verwenden

Serverseitige TypeScript-Integrationen können die lokale SDK-Beta verwenden:

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"
});

Lies Rivya TypeScript SDK, bevor du es einsetzt. Das SDK enthält serverseitige Chat-Streaming-Unterstützung in der Private Beta.

Rivya API Quickstart