Rivya API Überblick

Rivya API v1 ist der Entwicklervertrag, um unterstützte Rivya-Modellfunktionen aus deinem eigenen Produkt aufzurufen, wenn der Public-API-Zugriff für die Bereitstellung aktiviert und für dein Konto verfügbar ist.

Der implementierte Vertrag umfasst asynchrone Bild-, Video- und Audiogenerierung sowie Nachrichten über die Chat API mit vollständigen oder per SSE übertragenen Antworten. Er nutzt Rivya-Modell-IDs, Konto-Credits, öffentliche Aufgaben-IDs und serverseitige Chatsitzungen. Eine dokumentierte Route verspricht nicht, dass jede Umgebung, jedes Konto oder jedes Katalogmodell sie aufrufen kann; prüfe vor der Integration den aktuellen Zugriff und die API-Bereitschaft des Modells.

Wofür die API gedacht ist

Nutze die API, wenn du:

• Bild-, Video- oder Audio-Generierungsaufgaben aus deiner eigenen Anwendung einreichen möchtest

• Chatnachrichten mit vollständiger oder fortlaufend übertragener Antwort senden und über die API erstellte Chatsitzungen fortsetzen möchtest

• die Abrechnung im selben Credit-Guthaben des Rivya-Kontos halten möchtest

• den Aufgabenstatus über eine öffentliche Aufgaben-ID regelmäßig abfragen 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

Zu den implementierten v1-Endpunkten gehören:

• 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

Der aktuelle Vertrag umfasst signierte Webhooks für asynchrone Generierungsergebnisse, die Chat API und ein TypeScript-SDK in der Betaphase mit serverseitiger SSE-Übertragung. Webhook-Aufrufe setzen voraus, dass die Webhook-Funktion und der Public-API-Zugriff für die Bereitstellung aktiviert sind.

Authentifizierung

Endpunkte für Generierung, Status und Credits erfordern:

Authorization: Bearer rvya_sk_...

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

Abrechnungsmodell

API-Aufrufe nutzen dieselben Rivya-Konto-Credits wie Studio.

Generierungsaufgaben reservieren oder verbrauchen Credits, wenn die Aufgabe startet. Chatnachrichten reservieren Credits vor dem Modellaufruf und rechnen die endgültigen Credits anhand der Token-Nutzung ab, sobald die Assistentenantwort gespeichert wird. Wenn eine Generierung oder Chatnachricht nach den bestehenden Rivya-Fehlerregeln fehlschlägt, gilt dieselbe Rückerstattungslogik.

Lies API-Credits und Credits und Abrechnung in Rivya, um das Guthabenmodell aus Nutzersicht zu verstehen.

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 der Datei-API hoch.

5. Reiche eine Aufgabe mit Generierung erstellen ein.

6. Frage den Generierungsstatus regelmäßig ab, bis die Aufgabe erfolgreich ist oder fehlschlägt. Wenn Webhooks für Bereitstellung und Konto aktiviert sind, kannst du alternativ über API Webhooks signierte Abschlussereignisse abonnieren.

7. Nutze für Chatmodelle die Chat-API statt des Generierungsendpunkts. Bildanhänge im Chat müssen file_id-Werte der Datei-API referenzieren.

Verwandte Seiten

• API Quickstart

• API-Authentifizierung

• Rivya TypeScript SDK

• Modell-API-Referenz

• Chat API

• API Webhooks

• API-Fehler und Limits