Documentation Rivya AI

Authentification API

Authentifiez les requêtes API Rivya avec des clés API Bearer, des permissions limitées, l'affichage unique du secret, la révocation et la rotation.

Dernière révision le 2026/05/10

L'API Rivya utilise des clés API pour l'accès serveur à serveur.

Une clé API n'est pas la même chose qu'une session de connexion navigateur. N'utilisez pas les cookies, l'état de session Better Auth ni un jeton personnel de navigateur comme identifiant d'API publique.

Format de l'en-tête

Envoyez la clé dans l'en-tête Authorization :

Authorization: Bearer rvya_sk_...

La clé complète n'est affichée qu'une seule fois lors de sa création. Rivya stocke un hash et un préfixe visible, pas le secret complet.

Créer une clé

  1. Connectez-vous à Rivya.
  2. Ouvrez les paramètres des clés API.
  3. Créez une clé avec les scopes dont vous avez besoin.
  4. Copiez immédiatement la clé complète.
  5. Stockez-la dans un gestionnaire de secrets côté serveur ou une variable d'environnement.

Ne placez pas la clé dans du JavaScript côté client, des bundles d'application mobile, des dépôts publics, des événements analytics ou des logs.

Scopes actuels

La première version documente ces scopes :

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

Les nouvelles clés créées dans les paramètres incluent par défaut les scopes documentés. Les anciennes clés peuvent devoir être recréées avant d'utiliser l'API Files, les webhooks API ou l'API Chat.

Révoquer et effectuer une rotation

Si une clé est exposée :

  1. Révoquez l'ancienne clé depuis les paramètres.
  2. Créez une nouvelle clé.
  3. Mettez à jour votre secret côté serveur.
  4. Confirmez que la nouvelle clé fonctionne avec GET /api/v1/credits.
  5. Supprimez l'ancienne clé des systèmes de build, des logs et des variables de déploiement.

Les clés révoquées renvoient api_key_revoked.

Erreurs d'authentification

Erreurs d'authentification courantes :

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

Consultez Erreurs et limites API pour le tableau complet des erreurs publiques.

Pages associées

Guide des paramètres de compte Rivya

Gérez le profil Rivya, la facturation, les crédits, la sécurité, l'avatar, les newsletters, les options de mot de passe, la suppression du compte et les paramètres d'authentification.

Journal des modifications API

Suivez les mises à jour de la documentation Rivya API v1, des endpoints, de la référence des modèles, du schéma et des futures surfaces.

Table des matières

Format de l'en-tête
Créer une clé
Scopes actuels
Révoquer et effectuer une rotation
Erreurs d'authentification
Pages associées