Erstelle einen API-Schlüssel, wähle ein Modell, reiche eine asynchrone Generierungsaufgabe ein und sende eine Nachricht über die Chat API mit optionaler SSE-Übertragung.

Dieser Schnellstart zeigt den kürzesten sicheren Weg von der Kontoeinrichtung zu einer Generierungsaufgabe über die Rivya API und zur ersten Nachricht über die Chat API.

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

Die Beispiele beschreiben den implementierten Vertrag der Public API v1. Prüfe vor dem Test, ob der Public-API-Zugriff für die Bereitstellung aktiviert und für dein Konto verfügbar ist. Ein dokumentierter Endpunkt oder eine Modellseite beweist allein nicht, dass eine Anfrage in jeder Umgebung ausgeführt werden kann.

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 Generierung erstellst.

4. Generierung 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": "Ein klares redaktionelles Produktbild vor einem weichen Studiohintergrund"
  }'

Die Antwort gibt eine öffentliche Aufgaben-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 der Webhook-Zugriff für Bereitstellung und Konto aktiviert ist und dein Server signierte HTTPS-Rückmeldungen empfangen kann, erstelle einen Webhook-Endpunkt:

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 einmalig ausgegebene signing_secret aus der Antwort und verifiziere jede Zustellung, bevor du den Nutzdaten vertraust.

8. Optional: Chatnachricht senden

Rufe für Chatmodelle die 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": "claude-sonnet-5-chat",
    "message": "Erstelle einen knappen Einführungsplan für eine neue Produktbildkampagne"
  }'

Nutze die zurückgegebene session_id, um die über die API erstellte Sitzung fortzusetzen. Bildanhänge müssen file_id-Werte der Datei-API 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: "Ein klares redaktionelles Produktbild vor einem weichen Studiohintergrund"
});

Lies Rivya TypeScript SDK, bevor du es einsetzt. Das SDK unterstützt die serverseitige SSE-Übertragung von Chatantworten in der privaten Betaphase.

Rivya API Quickstart