API Rivya

Développez sur la couche de modèles multimodaux de Rivya

L'API Rivya offre aux équipes produit une interface publique, liée au compte, pour appeler les modèles Rivya depuis leurs propres applications. Commencez par des tâches asynchrones d'image, de vidéo et d'audio, ajoutez des tours de Chat API avec streaming SSE optionnel lorsqu'un modèle prend en charge le chat, et gardez la facturation dans le même portefeuille de crédits Rivya.
Lire la documentation APICréer une clé API

Format du démarrage rapide

Couche de modèles

Catalogue dynamique

Facturation

Crédits partagés

Première version

Tâches + Chat

Accès

Clés API

MéthodePOST
Endpoint/api/v1/generations

La requête réelle nécessite une clé API Rivya et des crédits disponibles sur le compte. Les exemples publics utilisent des secrets factices et n'appellent pas les modèles anonymement.

Requête
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"
  }'
Réponse
{
  "id": "task_public_id",
  "status": "queued",
  "model": "z-image",
  "reserved_credits": 20,
  "result": null,
  "error": null
}

Ce qui est livré en premier

Une couche d'API publique alignée avec le produit Rivya

L'API est conçue comme une surface produit Rivya. Elle utilise les ID de modèles Rivya, les crédits Rivya, les états de tâches publics et une documentation connectée au catalogue de modèles.

API de génération d'images

Soumettez des tâches d'image avec un prompt et les paramètres de modèle pris en charge, puis interrogez les résultats publics.

API de génération vidéo

Lancez des tâches vidéo asynchrones avec les mêmes contrôles de tâches et de crédits que Studio.

API de génération audio

Utilisez les modèles audio accessibles par API dans le même périmètre de compte, de solde et d'historique.

Portefeuille de crédits partagé

Les appels API et l'utilisation de Studio puisent dans le même solde Rivya, avec réservation de crédits et gestion des échecs.

Parcours de démarrage

Du compte à la première requête API

01

Créer une clé

Connectez-vous, ouvrez API Keys dans les Paramètres, créez une clé avec un périmètre défini et enregistrez immédiatement le secret complet.

02

Choisir un modèle

Lisez la référence des modèles API ou appelez /api/v1/models pour inspecter les ID de modèles, les paramètres, les capacités chat et la disponibilité des entrées avant de soumettre.

03

Soumettre, interroger ou s'abonner

Envoyez une requête de génération idempotente, interrogez l'endpoint public de tâche, utilisez des webhooks signés pour les callbacks de génération ou envoyez un tour Chat API avec streaming SSE optionnel.

Périmètre de version

Un périmètre clair, sans promesses cachées

La page de destination peut mentionner de futures surfaces, mais le texte produit actuel ne doit pas suggérer que des API inachevées sont déjà disponibles.

Chat API

Disponible

Disponible pour les tours sans streaming et en streaming SSE, avec sessions créées par API, crédits de compte et pièces jointes image optionnelles via Files API.

Files API

Disponible

Disponible pour les importations d'images, de vidéos et d'audios de référence. Utilisez-la avant la génération lorsqu'une page modèle demande params.referenceMediaItems.

Webhooks utilisateur

Disponible

Disponible pour les intégrations de production qui veulent des callbacks signés pour les tâches de génération réussies ou échouées.

Débogueur en ligne

Prévisualisez la requête, puis exécutez-la avec votre propre clé API

Le débogueur démarre en mode mock pour chaque visiteur. Le sélecteur de génération liste les modèles hors chat testables sans importation de fichiers, tandis que le panneau Files permet aux utilisateurs connectés de tester /api/v1/files avec une clé API temporaire. Les exemples Chat se trouvent dans la documentation API.

État du compte

Vérification du compte

Préfixe de la clé active

Créez d'abord une clé

Crédits actuels

Connectez-vous pour vérifier

Aperçu mockPublic API réelleAucune clé API active

Le mode mock n'appelle jamais de modèle et ne consomme jamais de crédits.

Collez la clé uniquement pour cette requête. Le débogueur ne la conserve pas après actualisation.

Test d'importation Files API

Importez des médias de référence via POST /api/v1/files, puis copiez l'URL renvoyée et le duration token dans params.referenceMediaItems pour un modèle qui prend en charge les entrées de référence.

Le mode mock n'effectue jamais d'uploadLe mode live utilise /api/v1/files

Le modèle sélectionné contrôle les types MIME, la taille et les règles de durée autorisés. Les importations live nécessitent votre clé API temporaire et peuvent appeler le vrai service d'importation.

Créer une clé APILire la documentation API
Aperçu de la requête
{
  "model": "z-image",
  "prompt": "Photo produit éditoriale dans un studio épuré",
  "params": {
    "aspect_ratio": "1:1"
  }
}
Réponse
{
  "id": "mock_task_001",
  "status": "queued",
  "model": "z-image",
  "reserved_credits": 1,
  "final_credits": 0,
  "result": null,
  "error": null
}
Réponse Files API
{
  "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
}
Paramètres de génération
{
  "params": {
    "referenceMediaItems": [
      {
        "url": "https://media.example/reference.png",
        "kind": "image",
        "name": "reference.png",
        "mimeType": "image/png"
      }
    ]
  }
}

État de la tâche

Crédits de base estimés

1

État

queued

Documentation API

Consultez l'authentification, les corps de requête, les réponses, l'idempotence, les paramètres de modèle et les codes d'erreur.

Ouvrir la documentation

Gestion des clés API

Créez, copiez une seule fois, révoquez et renouvelez les clés API depuis l'espace Paramètres protégé.

Gérer les clés

Débogage en ligne

Utilisez d'abord les exemples mock ; le débogage réel nécessite une connexion, une clé API et des crédits de compte.

Prévisualiser le flux