Modèles API

Utilisez GET /api/v1/models pour lister les modèles Rivya avec leur état de disponibilité pour l'API publique.

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

L'endpoint est public et en lecture seule. Il renvoie la même couche de modèles publics que celle utilisée par la documentation API et le débogueur en ligne, y compris les modèles qui ne sont pas encore entièrement appelables.

Forme de réponse

La réponse utilise cette forme :

{
  "object": "list",
  "data": [
    {
      "id": "z-image",
      "display_name": "Z-Image",
      "category": "image",
      "runtime": "async_task",
      "base_credits": 1,
      "billing_type": "FIXED",
      "supported_modes": ["text-to-image"],
      "max_prompt_length": 1000,
      "reference_media": null,
      "params": [],
      "api_status": "available",
      "api_input_status": "available_text",
      "supported_api_inputs": ["text"],
      "requires_files_api": false,
      "requires_upload_for_modes": [],
      "url_input_supported": false,
      "file_kinds": [],
      "chat_capabilities": null,
      "notices": []
    }
  ]
}

Utilisez id comme valeur model dans POST /api/v1/generations pour les modèles de génération asynchrone. Pour les modèles de chat, utilisez POST /api/v1/chat/completions et vérifiez chat_capabilities.

États de disponibilité

La référence des modèles utilise ces états publics :

• available : au moins un chemin de génération API publique est disponible

• temporarily_unavailable : modèle temporairement indisponible qui ne peut pas être appelé actuellement via l'API publique v1

• studio_only : le modèle est disponible via le Studio ou une autre partie du produit, pas via Public API v1

Le champ de disponibilité des entrées est plus précis :

• available_text : les requêtes basées sur un prompt peuvent être testées directement

• available_url_input : les URL publiques ou paramètres scalaires peuvent être testés directement

• partial_requires_files : certains modes peuvent être appelés sans import ; les modes avec médias de référence doivent utiliser l'API Files

• requires_files_api : le modèle dépend de médias de référence importés via /api/v1/files

Utilisez API Files avant d'appeler les modes qui exigent des références image, vidéo ou audio importées.

Pour les modèles de chat, chat_capabilities indique si l'API Chat prend en charge les réponses non-streaming, les réponses en streaming, la recherche web, les pièces jointes image file_id, les thoughts et le reasoning effort.

Politique de comptage des modèles

La liste publique des modèles change à mesure que Rivya ajoute, retire ou restreint des modèles.

Ne vous appuyez pas sur un nombre de modèles codé en dur dans votre intégration. Lisez toujours /api/v1/models ou la référence API dynamique des modèles.

Pages associées

• Référence API des modèles

• Créer une génération

• API Chat

• Guide de sélection des modèles Rivya

• Disponibilité des modèles dans Rivya

Entrées de découverte bientôt disponibles

• coming_soon : le modèle est visible pour la découverte, mais ne peut pas être envoyé à l’API de génération ou de chat. Ces entrées renvoient supports_direct_generation: false, des champs runtime, facturation et prix nuls, ainsi que supported_modes et params vides. Choisissez api_status: available pour vos requêtes.