API-Authentifizierung

Die Rivya API nutzt API Keys für Server-zu-Server-Zugriff.

Ein API Key ist nicht dasselbe wie eine Browser-Login-Session. Verwende keine Cookies, keinen Better-Auth-Sessionzustand und kein persönliches Browser-Token als Credential für die Public API.

Header-Format

Sende den Key im Header Authorization:

Authorization: Bearer rvya_sk_...

Der vollständige Key wird nur einmal beim Erstellen angezeigt. Rivya speichert einen Hash und ein sichtbares Präfix, nicht das vollständige Secret.

Key erstellen

1. Melde dich bei Rivya an.
2. Öffne die API-Keys-Einstellungen.
3. Erstelle einen Key mit den Scopes, die du brauchst.
4. Kopiere den vollständigen Key sofort.
5. Speichere ihn in einem serverseitigen Secret Manager oder einer Umgebungsvariable.

Lege den Key nicht in clientseitigem JavaScript, Mobile-App-Bundles, öffentlichen Repos, Analytics-Events oder Logs ab.

Aktuelle Scopes

Die erste Version dokumentiert diese Scopes:

• models:read
• generations:create
• generations:read
• files:create
• files:read
• credits:read
• webhooks:manage
• chat:create
• chat:read

Neue Keys, die in den Einstellungen erstellt werden, enthalten standardmäßig die dokumentierten Scopes. Ältere Keys müssen möglicherweise neu erstellt werden, bevor du Files API, API Webhooks oder Chat API verwendest.

Widerrufen und rotieren

Wenn ein Key offengelegt wurde:

1. Widerrufe den alten Key in den Einstellungen.
2. Erstelle einen neuen Key.
3. Aktualisiere dein serverseitiges Secret.
4. Bestätige mit GET /api/v1/credits, dass der neue Key funktioniert.
5. Entferne den alten Key aus Build-Systemen, Logs und Deployment-Variablen.

Widerrufene Keys geben api_key_revoked zurück.

Authentifizierungsfehler

Häufige Authentifizierungsfehler:

• api_key_missing
• api_key_invalid
• api_key_revoked
• api_key_expired
• api_scope_denied
• public_api_disabled

Siehe API-Fehler und Limits für die vollständige öffentliche Fehlertabelle.

Verwandte Seiten

• API Quickstart
• API Credits
• API-Fehler und Limits
• Authentifizierung und Zugriff in Rivya