Was Ist Die Rivya API?

Die Rivya API ist der Entwicklervertrag, mit dem du unterstützte Rivya-Modellfunktionen aus deinem eigenen Produkt, Skript oder Arbeitsablauf nutzen kannst, wenn der Public-API-Zugriff für die Bereitstellung aktiviert und für dein Konto verfügbar ist.

Sie ist kein separates Produkt neben Rivya Studio. Sie nutzt dieselbe Kontogrenze, dasselbe Credit-Guthaben und dieselbe öffentliche Modellschicht, die Nutzer in Rivya sehen. Der Unterschied liegt im Start der Arbeit: Statt sich durch das Studio zu klicken, sendet deine Anwendung Anfragen mit einem API-Schlüssel.

Wenn du Einzelheiten zu den Endpunkten brauchst, beginne mit der Übersicht zur Rivya API und dem Schnellstart für die Rivya API. Dieser Artikel erklärt auf Produktebene, wofür die API gedacht ist, wo sie passt und wann sie nicht der erste Pfad sein sollte.

Die Kurzversion

Rivya API v1 erlaubt einem berechtigten, eingeloggten Konto, API Keys zu erstellen und API-bereite Rivya-Modelle außerhalb des Webinterfaces aufzurufen. Die Entwicklerseiten beschreiben den implementierten Vertrag; aktives Deployment, Kontoberechtigungen und Modellbereitschaft entscheiden, ob eine Anfrage ausgeführt werden kann.

Die implementierte API-Oberfläche umfasst:

• Model Discovery über die API-Modellliste

• asynchrone Generierungsaufgaben für Bilder, Videos und Audio

• das Hochladen über die Datei-API für Modelle, die Referenzmedien brauchen

• regelmäßige Abfrage des Generierungsstatus mit öffentlichen Aufgaben-IDs

• Prüfung der Konto-Credits

• Chatnachrichten über die Chat API, einschließlich optionaler Übertragung per SSE

• signierte Webhooks für Generation Completion

• ein TypeScript-SDK in der Betaphase für Teams, die einen fertigen Client benötigen

Der öffentliche Bereich Für Entwickler ist der beste Einstieg, wenn du eine geführte Übersicht, Links zu den Einstellungen für API-Schlüssel und einen sicheren Ablauf zur Fehlersuche suchst.

Warum Rivya Eine API Hat

Studio ist nützlich, wenn eine Person noch Modelle auswählt, Anweisungen ausarbeitet, Ergebnisse prüft und über den nächsten Schritt entscheidet.

Die API ist nützlich, wenn diese Entscheidung zu einem wiederholbaren Produkt- oder Betriebsworkflow geworden ist.

Häufige Beispiele bei aktiviertem API-Zugriff:

• ein Produkt soll Bildvarianten erzeugen, nachdem ein Nutzer ein Briefing einreicht

• ein Marketing-Arbeitsablauf soll visuelle Entwürfe aus strukturierten Kampagneneingaben erstellen

• ein internes Werkzeug muss Video- oder Audioaufgaben einreichen, ohne dass jemand den Browser öffnen muss

• ein Support- oder Inhaltssystem soll eine Chatnachricht innerhalb der eigenen Oberfläche von einem Modell verarbeiten lassen

• ein Serverdienst soll signierte Rückmeldungen erhalten, wenn Generierungsaufgaben abgeschlossen sind

In diesen Fällen hält die Rivya API die Arbeit mit demselben Rivya-Konto verbunden, statt eine separate Infrastruktur für Abrechnung, Modellauswahl und Aufgabenstatus zu erzwingen.

Was Die API Nicht Ersetzt

Die API ersetzt nicht jeden Grund, Rivya direkt zu nutzen.

Nutze Studio oder die öffentlichen Arbeitsflächen, wenn:

• die Anweisung noch menschliche Erkundung braucht

• die Modellwahl nicht stabil ist

• ein Kreativschaffender Ergebnisse visuell vergleichen muss

• das Projekt vom gespeicherten Verlauf und manueller Prüfung abhängt

• das Team noch nicht entschieden hat, welches Eingabe- und Ergebnisformat wiederholbar werden soll

Nutze die API, wenn der Arbeitsablauf klar genug ist, um automatisiert zu werden.

Diese Grenze ist wichtig. Eine vage kreative Frage gehört meist zuerst in Studio. Ein bekannter Produktablauf mit vorhersehbaren Eingaben kann in die API wechseln.

Die Wichtigsten Bausteine

Betrachte die API als sechs verbundene Teile.

Die API-Dokumentation ist die Quelle für die Struktur von Anfragen und Antworten. Dieser Artikel hilft dir zu entscheiden, welchen Teil du zuerst brauchst.

Wie Credits Funktionieren

Die API-Nutzung greift auf dasselbe Credit-Guthaben des Rivya-Kontos wie das Studio zu.

Das bedeutet, dass die API kein anonymer Modellproxy ist. Eine Anfrage gehört zu einem Rivya-Konto, nutzt einen von diesem Konto erstellten API-Schlüssel und folgt derselben produktweiten Credit-Grenze, die unter API-Credits beschrieben ist.

Für Teams ist das nützlich, weil Studio-Experimente und API-Nutzung in einem gemeinsamen Betriebsmodell bleiben. Du kannst ein Modell manuell testen und anschließend den wiederholbaren Teil in eine Integration verschieben, ohne eine zweite Abrechnungsebene zu schaffen.

Wie Dateien eingebunden werden

Einige Modelle laufen allein mit Text. Andere brauchen ein Referenzbild, ein Video oder eine Audiodatei.

Für API-Integrationen sollten diese Referenzen über die Datei-API laufen. Beim Hochladen entsteht ein verwalteter Dateidatensatz, der an unterstützte Modellparameter übergeben werden kann.

Die praktische Regel ist einfach:

• wenn ein Modell nur Texteingaben akzeptiert, beginne mit dem Generierungsendpunkt

• wenn ein Modell Referenzmedien braucht, lade zuerst die Datei hoch

• wenn das Modell ein Chatmodell mit Bildanhängen ist, nutze Chat API und file IDs

Richte deine Integration nicht an browsergebundenen Hochladeabläufen oder gespeicherten Studio-Sitzungen aus. Die API hat aus gutem Grund einen eigenen öffentlichen Bereich für Dateien.

Wo Webhooks Helfen

Regelmäßige Statusabfragen sind der einfachste erste Integrationspfad. Reiche eine Generierungsaufgabe ein, speichere die öffentliche Aufgaben-ID und frage den Zustand ab, bis die Aufgabe erfolgreich abgeschlossen ist oder scheitert.

Wenn Webhooks für das Deployment aktiviert sind, werden sie mit wachsender Produktionsnähe der Integration nützlich:

• du willst keinen Hintergrundprozess, der jede Aufgabe regelmäßig abfragt

• deine App muss einen Datensatz aktualisieren, wenn Generation abgeschlossen ist

• du willst ein signiertes Event, das sicher erneut versucht werden kann

• fehlgeschlagene Aufgaben müssen einem klaren Wiederherstellungspfad folgen

Für den signierten Event-Vertrag nutze API Webhooks. Bestätige die Verfügbarkeit, bevor du das Design darauf aufbaust. Halte den Webhook-Empfänger eng begrenzt: Signaturen prüfen, doppelte Events behandeln und keine geheimen Werte protokollieren.

Ein Gutes Erstes API-Projekt

Das beste erste API-Projekt ist meistens klein und konkret.

Zum Beispiel:

1. bestätigen, dass API-Zugriff für Deployment und Konto aktiviert ist

2. in den Einstellungen einen API-Schlüssel erstellen

3. die Modellliste aufrufen

4. ein API-bereites Modell wählen

5. eine Generierungsaufgabe mit Idempotenzschlüssel einreichen

6. den Statusendpunkt regelmäßig abfragen

7. Credits vor und nachher prüfen

8. erst dann die Datei-API, Chat-API oder von der Bereitstellung angebotene Webhooks hinzufügen

Dieser Pfad gibt dir eine funktionierende Integration, ohne alle API-Features in den ersten Test zu mischen.

Wann Die API Der Falsche Startpunkt Ist

Die API ist wahrscheinlich nicht der richtige erste Schritt, wenn:

• das Team noch keine Modellfamilie gewählt hat

• sich das gewünschte Ergebnis bei jedem Durchlauf noch ändert

• die Anweisung von subjektivem Geschmack und manueller Prüfung abhängt

• die Integration Credit-Nutzung vor den Menschen verstecken würde, die sie verstehen müssen

• das Produkt eine öffentliche Demo braucht, bevor es Automatisierung braucht

In diesen Fällen starte mit Bild, Video, Audio, Chat oder KI-Modelle. Sobald der Pfad wiederholbar ist, verschiebe den stabilen Teil in die API.

Wohin Als Nächstes

• Öffne den Bereich Für Entwickler für den öffentlichen API-Einstieg und die Fehlersuche.

• Lies den Schnellstart für die Rivya API, um die erste sichere Anfrage zu senden.

• Lies API Authentication, bevor du einen Key auf einen Server legst.

• Lies API-Modelle, bevor du Modell-IDs auswählst.

• Lies Wann die Rivya API statt Studio sinnvoll ist, wenn die Produktgrenze noch unklar ist.

• Lies So erstellst du einen multimodalen KI-Arbeitsablauf mit der Rivya API, wenn du eine vollständige Bild-, Video-, Audio- oder Chat-Integration planst.