Rivya API

Baue auf Rivyas multimodaler Modellschicht

Die Rivya API gibt Produktteams einen öffentlichen, kontobasierten Weg, Rivya-Modelle aus eigenen Apps aufzurufen. Starte mit asynchronen Bild-, Video- und Audio-Jobs, ergänze Chat API-Turns mit optionalem SSE-Streaming, wenn ein Modell chatfähig ist, und halte die Abrechnung in derselben Rivya-Credit-Wallet.
API-Dokumentation lesenAPI Key erstellen

Quickstart-Form

Modellschicht

Dynamischer Katalog

Abrechnung

Gemeinsame Credits

Erste Version

Jobs + Chat

Zugriff

API Keys

MethodePOST
Endpunkt/api/v1/generations

Die echte Anfrage benötigt einen Rivya API Key und verfügbare Kontocredits. Öffentliche Beispiele nutzen Platzhalter-Secrets und rufen Modelle nicht anonym auf.

Anfrage
curl https://rivya.ai/api/v1/generations \
  -H "Authorization: Bearer rvya_sk_..." \
  -H "Content-Type: application/json" \
  -H "Idempotency-Key: demo-job-001" \
  -d '{
    "model": "z-image",
    "prompt": "Editorial product photo on a clean studio set"
  }'
Antwort
{
  "id": "task_public_id",
  "status": "queued",
  "model": "z-image",
  "reserved_credits": 20,
  "result": null,
  "error": null
}

Was zuerst ausgeliefert wird

Eine Public-API-Schicht, die mit dem Rivya-Produkt verbunden bleibt

Die API ist als Rivya-Produktoberfläche gedacht. Sie nutzt Rivya-Modell-IDs, Rivya-Credits, öffentliche Aufgabenstatus und Dokumentation, die mit dem Modellkatalog verbunden bleibt.

API für Bildgenerierung

Reiche Bild-Jobs mit Prompt und unterstützten Modellparametern ein und frage anschliessend öffentliche Ergebnisse ab.

API für Videogenerierung

Führe asynchrone Video-Jobs mit denselben Aufgaben- und Credit-Kontrollen aus, die Studio verwendet.

API für Audiogenerierung

Nutze per API zugängliche Audiomodelle über dasselbe Konto, Guthaben und dieselbe Verlaufsgrenze.

Gemeinsame Credit-Wallet

API-Aufrufe und Studio-Nutzung ziehen aus demselben Rivya-Guthaben, mit reservierten Credits und Fehlerbehandlung.

Startpfad

Vom Konto zur ersten API-Anfrage

01

Key erstellen

Melde dich an, öffne API Keys in den Einstellungen, erstelle einen Key mit Scopes und speichere das vollständige Secret sofort.

02

Modell wählen

Lies die API-Modellreferenz oder rufe /api/v1/models auf, um Modell-IDs, Parameter, Chat-Fähigkeiten und Eingabebereitschaft vor dem Einreichen zu prüfen.

03

Einreichen, abfragen oder abonnieren

Sende eine idempotente Generierungsanfrage, frage den öffentlichen Aufgabenendpunkt ab, nutze signierte Webhooks für Generierungs-Callbacks oder sende einen Chat API-Turn mit optionalem SSE-Streaming.

Versionsgrenze

Klarer Umfang, keine versteckten Versprechen

Die Landingpage kann zukünftige Oberflächen erwähnen, aber die aktuelle Produktcopy darf nicht andeuten, dass unfertige APIs bereits live sind.

Chat API

Verfügbar

Verfügbar für nicht-streamende und SSE-streamende Turns mit API-erstellten Sessions, Kontocredits und optionalen Files API-Bildanhängen.

Files API

Verfügbar

Verfügbar für Referenzbild-, Video- und Audio-Uploads. Nutze sie vor der Generierung, wenn eine Modellseite params.referenceMediaItems verlangt.

User Webhooks

Verfügbar

Verfügbar für Produktionsintegrationen, die signierte Callbacks für erfolgreiche oder fehlgeschlagene Generierungsaufgaben wünschen.

Online-Debugger

Anfrage zuerst prüfen, dann mit deinem eigenen API Key ausführen

Der Debugger startet für jeden Besucher im Mock-Modus. Der Generierungsselektor listet Nicht-Chat-Modelle, die ohne Datei-Upload getestet werden können, während das Files-Panel angemeldeten Nutzern erlaubt, /api/v1/files mit einem temporären API Key zu testen. Chat-Beispiele stehen in der API-Dokumentation.

Kontostatus

Konto wird geprüft

Aktives Key-Präfix

Erstelle zuerst einen Key

Aktuelle Credits

Zum Prüfen anmelden

Mock-VorschauLive Public APIKein aktiver API Key

Der Mock-Modus ruft nie ein Modell auf und verbraucht keine Credits.

Füge den Key nur für diese Anfrage ein. Der Debugger speichert ihn nach einer Aktualisierung nicht.

Files API Upload-Test

Lade Referenzmedien über POST /api/v1/files hoch und kopiere dann die zurückgegebene URL sowie das duration token in params.referenceMediaItems für ein Modell, das Referenzeingaben unterstützt.

Mock lädt nie hochLive nutzt /api/v1/files

Das ausgewählte Modell steuert erlaubte MIME-Typen, Grösse und Dauerregeln. Live-Uploads benötigen deinen temporären API Key und können den echten Upload-Service aufrufen.

API Key erstellenAPI-Dokumentation lesen
Anfragevorschau
{
  "model": "z-image",
  "prompt": "Editoriales Produktfoto in einem aufgeräumten Studio-Set",
  "params": {
    "aspect_ratio": "1:1"
  }
}
Antwort
{
  "id": "mock_task_001",
  "status": "queued",
  "model": "z-image",
  "reserved_credits": 1,
  "final_credits": 0,
  "result": null,
  "error": null
}
Files API-Antwort
{
  "id": "file_mock_001",
  "object": "file",
  "kind": "image",
  "file_name": "reference.png",
  "mime_type": "image/png",
  "size_bytes": 245760,
  "url": "https://media.example/reference.png",
  "duration_seconds": null,
  "duration_token": null,
  "created_at": "2026-05-11T00:00:00.000Z",
  "expires_at": null
}
Generierungsparameter
{
  "params": {
    "referenceMediaItems": [
      {
        "url": "https://media.example/reference.png",
        "kind": "image",
        "name": "reference.png",
        "mimeType": "image/png"
      }
    ]
  }
}

Aufgabenstatus

Geschätzte Basiscredits

1

Status

queued

API-Dokumentation

Lies Authentifizierung, Request Bodies, Antworten, Idempotenz, Modellparameter und Fehlercodes.

Docs öffnen

API-Key-Verwaltung

Erstelle, kopiere einmalig, widerrufe und rotiere API Keys im geschützten Einstellungsbereich.

Keys verwalten

Online-Debugging

Nutze zuerst Mock-Beispiele; echtes Debugging benötigt Login, einen API Key und Kontocredits.

Ablauf prüfen