Aperçu de l'API Rivya

Rivya API v1 est le contrat développeur permettant d'appeler les capacités de modèles Rivya prises en charge depuis votre produit, lorsque l'accès à l'API publique est activé pour le déploiement et disponible pour votre compte.

Le contrat implémenté couvre la génération asynchrone d'images, de vidéos et d'audio, ainsi que les tours Chat API avec réponses complètes ou en streaming SSE. Il utilise les ID de modèles Rivya, les crédits du compte, des ID de tâches publics et des sessions de chat côté serveur. Une route documentée ne garantit pas que chaque environnement, compte ou modèle du catalogue puisse l'appeler ; vérifiez l'accès en direct et l'état du modèle avant l'intégration.

À quoi sert l'API

Utilisez l'API lorsque vous voulez :

• soumettre des jobs de génération image, vidéo ou audio depuis votre propre app

• envoyer des tours de chat non-streaming ou streaming et continuer des sessions de chat créées par l'API

• garder la facturation dans le même portefeuille de crédits de compte Rivya

• interroger le statut des tâches par ID de tâche public

• utiliser des nouvelles tentatives idempotentes pour des requêtes de production plus sûres

• garder l'usage Studio et API sous la même limite de compte

L'API est une couche produit Rivya. Les réponses publiques utilisent uniquement les noms Rivya et les champs publics.

Portée de la version actuelle

Les endpoints v1 implémentés incluent :

• 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

Le contrat actuel inclut les webhooks signés pour les résultats asynchrones, l'API Chat et une bêta du SDK TypeScript avec streaming côté serveur. Les appels webhook exigent l'activation de cette fonction et de l'accès à l'API publique pour le déploiement.

Authentification

Les endpoints de génération, de statut et de crédits nécessitent :

Authorization: Bearer rvya_sk_...

Créez et faites tourner les clés depuis les paramètres des clés API. Lisez Authentification API avant d'utiliser une clé en production.

Modèle de facturation

Les appels API utilisent les mêmes crédits de compte Rivya que le Studio.

Les jobs de génération réservent ou consomment des crédits au démarrage de la tâche. Les tours Chat réservent des crédits avant l'appel modèle et règlent les crédits finaux à partir de l'utilisation des tokens lorsque le message assistant est enregistré. Si une génération ou un tour Chat échoue selon les règles d'échec existantes de Rivya, le même traitement de remboursement s'applique.

Lisez Crédits API et Crédits et facturation dans Rivya pour le modèle de portefeuille visible par l'utilisateur.

Premier chemin d'intégration

1. Créez une clé API dans les paramètres.

2. Appelez Lister les modèles API pour choisir un ID de modèle public.

3. Lisez la référence API des modèles pour les paramètres du modèle.

4. Si le modèle a besoin de médias de référence, importez-les avec API Files.

5. Soumettez un job avec Créer une génération.

6. Interrogez le statut de génération jusqu'à la réussite ou l'échec de la tâche. Si les webhooks sont activés pour le déploiement et le compte, vous pouvez aussi vous abonner aux webhooks API pour recevoir des événements signés.

7. Pour les modèles de chat, utilisez API Chat au lieu de l'endpoint de génération. Les pièces jointes image du Chat doivent référencer des valeurs file_id de l'API Files.

Pages associées

• Démarrage rapide API

• Authentification API

• SDK TypeScript Rivya

• Référence API des modèles

• API Chat

• Webhooks API

• Erreurs et limites API