Rivya API Überblick

Rivya API v1 ist der Entwickler-Einstiegspunkt, um Rivya-Modellfähigkeiten aus deinem eigenen Produkt aufzurufen.

Die Public API unterstützt asynchrone Bild-, Video- und Audiogenerierung sowie Chat API-Turns mit nicht streamenden oder per SSE streamenden Antworten. Sie nutzt Rivya-Modell-IDs, Rivya Account Credits, öffentliche Task-IDs für Generationen und serverseitige Chat-Sessions für Chat API.

Wofür die API gedacht ist

Nutze die API, wenn du:

• Bild-, Video- oder Audio-Generation-Jobs aus deiner eigenen App einreichen möchtest
• nicht streamende oder streamende Chat-Turns senden und API-erstellte Chat-Sessions fortsetzen möchtest
• Billing in derselben Rivya Account-Credit-Wallet halten möchtest
• Task-Status per öffentlicher Task-ID pollen möchtest
• idempotente Retries für sicherere Produktionsanfragen nutzen möchtest
• Studio- und API-Nutzung unter derselben Kontogrenze halten möchtest

Die API ist eine Rivya-Produktebene. Öffentliche Antworten verwenden nur Rivya-Namen und öffentliche Felder.

Umfang der aktuellen Version

Aktuelle v1-Endpoints:

• 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

Die aktuelle Version enthält signierte Webhooks für asynchrone Generation-Ergebnisse, Chat API und eine TypeScript SDK-Beta mit serverseitiger Streaming-Unterstützung.

Authentifizierung

Generation-, Status- und Credit-Endpoints erfordern:

Authorization: Bearer rvya_sk_...

Erstelle und rotiere Keys in den API-Keys-Einstellungen. Lies API-Authentifizierung, bevor du einen Key in Produktion verwendest.

Billing-Modell

API-Aufrufe nutzen dieselben Rivya Account Credits wie Studio.

Generation-Jobs reservieren oder verbrauchen Credits, wenn der Task startet. Chat-Turns reservieren Credits vor dem Modellaufruf und rechnen finale Credits anhand der Token-Nutzung ab, wenn die Assistant-Nachricht gespeichert wird. Wenn eine Generation oder ein Chat-Turn nach den bestehenden Rivya-Fehlerregeln fehlschlägt, gilt dieselbe Rückerstattungslogik.

Lies API Credits und Credits & Billing in Rivya für das nutzerseitige Wallet-Modell.

Erster Integrationspfad

1. Erstelle einen API Key in den Einstellungen.
2. Rufe API Models auflisten auf, um eine öffentliche Modell-ID zu wählen.
3. Lies die Modell-API-Referenz für die Parameter des Modells.
4. Wenn das Modell Referenzmedien braucht, lade sie mit Files API hoch.
5. Reiche einen Job mit Generation erstellen ein.
6. Polle Generation-Status, bis der Task erfolgreich ist oder fehlschlägt, oder abonniere API Webhooks für signierte Abschluss-Events.
7. Nutze für Chat-Modelle Chat API statt des Generation-Endpoints. Chat-Bildanhänge müssen Files API-file_id-Werte referenzieren.

Verwandte Seiten

• API Quickstart
• API-Authentifizierung
• Rivya TypeScript SDK
• Modell-API-Referenz
• Chat API
• API Webhooks
• API-Fehler und Limits