Créez une clé API, choisissez un modèle, soumettez une tâche de génération asynchrone et envoyez un tour Chat API avec streaming SSE optionnel.

Ce démarrage rapide montre le chemin le plus court et sûr entre la configuration du compte, une tâche de génération API Rivya et le premier tour Chat API.

Utilisez des clés fictives dans la documentation et les exemples. Ne collez jamais une vraie clé API dans du code public, des captures d'écran, des tickets ou des documents partagés.

1. Créer une clé API

Ouvrez les paramètres des clés API, créez une clé, copiez le secret complet une seule fois et stockez-le dans votre environnement côté serveur.

Premiers scopes recommandés :

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

2. Confirmer votre URL de base

Utilisez l'URL de base de l'API de production :

https://rivya.ai

Les URL localhost servent uniquement au développement local. Les exemples publics ne doivent pas utiliser de secrets locaux.

3. Lister les modèles

curl https://rivya.ai/api/v1/models

Utilisez le champ id de la réponse comme valeur model lorsque vous créez une génération.

4. Soumettre une génération

curl https://rivya.ai/api/v1/generations \
  -H "Authorization: Bearer rvya_sk_..." \
  -H "Content-Type: application/json" \
  -H "Idempotency-Key: quickstart-001" \
  -d '{
    "model": "z-image",
    "prompt": "Image produit éditoriale nette sur fond studio doux"
  }'

La réponse renvoie un ID de tâche public. Stockez-le afin de pouvoir interroger le statut plus tard.

5. Interroger le statut

curl https://rivya.ai/api/v1/generations/task_public_id \
  -H "Authorization: Bearer rvya_sk_..."

Les valeurs de statut sont :

queued
processing
succeeded
failed

6. Vérifier les crédits

curl https://rivya.ai/api/v1/credits \
  -H "Authorization: Bearer rvya_sk_..."

Utilisez ceci pour confirmer le solde actuel du compte avant ou après les tests.

7. Optionnel : ajouter des webhooks

Si votre serveur peut recevoir des callbacks HTTPS signés, créez un endpoint webhook :

curl https://rivya.ai/api/v1/webhooks \
  -H "Authorization: Bearer rvya_sk_..." \
  -H "Content-Type: application/json" \
  -d '{
    "name": "Webhook production",
    "url": "https://example.com/rivya/webhook",
    "event_types": ["generation.succeeded", "generation.failed"]
  }'

Enregistrez le signing_secret affiché une seule fois dans la réponse et vérifiez chaque livraison avant de faire confiance au payload.

8. Optionnel : envoyer un tour Chat

Pour les modèles de chat, appelez l'API Chat au lieu de POST /api/v1/generations :

curl https://rivya.ai/api/v1/chat/completions \
  -H "Authorization: Bearer rvya_sk_..." \
  -H "Content-Type: application/json" \
  -H "Idempotency-Key: quickstart-chat-001" \
  -d '{
    "model": "gpt-5-2-chat",
    "message": "Rédige un plan de lancement concis pour une nouvelle campagne visuelle produit"
  }'

Utilisez le session_id renvoyé pour continuer la session créée par l'API. Les pièces jointes image doivent référencer des valeurs file_id de l'API Files.

Optionnel : utiliser la bêta du SDK TypeScript

Les intégrations TypeScript côté serveur peuvent utiliser la bêta du SDK local :

import { RivyaClient } from "@rivya/sdk";

const rivya = new RivyaClient({
  apiKey: process.env.RIVYA_API_KEY
});

const generation = await rivya.generations.create({
  model: "z-image",
  prompt: "Image produit éditoriale nette sur fond studio doux"
});

Lisez SDK TypeScript Rivya avant de l'adopter. Le SDK inclut la prise en charge du streaming Chat côté serveur dans la bêta privée.

Démarrage rapide de l'API Rivya