Authentification
L’API Venice utilise des clés API pour l’authentification. Créez et gérez vos clés API dans vos paramètres API. Toutes les requêtes API nécessitent une authentification HTTP Bearer :Votre clé API est un secret. Ne la partagez pas et ne l’exposez pas dans du code côté client.
Compatibilité OpenAI
L’API de Venice implémente la spécification API d’OpenAI, garantissant la compatibilité avec les clients et outils OpenAI existants. Cela vous permet d’intégrer Venice en utilisant l’interface OpenAI familière tout en accédant aux fonctionnalités uniques de Venice et à ses modèles non censurés.Configuration
Configurez votre client pour utiliser l’URL de base de Venice (https://api.venice.ai/api/v1) et effectuez votre première requête :
Fonctionnalités spécifiques à Venice
Prompts système
Venice fournit des prompts système par défaut conçus pour garantir des réponses de modèle non censurées et naturelles. Vous avez deux options pour gérer les prompts système :- Comportement par défaut : Vos prompts système sont ajoutés aux valeurs par défaut de Venice
- Comportement personnalisé : Désactiver entièrement les prompts système de Venice
Désactiver les prompts système de Venice
Utilisez l’optionvenice_parameters pour supprimer les prompts système par défaut de Venice :
Paramètres Venice
L’objetvenice_parameters vous permet d’accéder aux fonctionnalités spécifiques à Venice qui ne sont pas disponibles dans l’API OpenAI standard :
Ces paramètres peuvent également être spécifiés en tant que suffixes de modèle ajoutés au nom du modèle (par ex.
zai-org-glm-5:enable_web_search=auto). Voir Suffixes de fonctionnalité de modèle pour plus de détails.Mise en cache des prompts
Venice prend en charge la mise en cache des prompts sur certains modèles afin de réduire la latence et les coûts pour le contenu répété. Pour les modèles pris en charge, Venice met automatiquement en cache les prompts système — aucune modification de code requise. Vous pouvez également marquer manuellement le contenu pour la mise en cache en utilisant la propriétécache_control sur le contenu du message.
Voir Mise en cache des prompts pour les détails sur le fonctionnement du cache, la facturation et les bonnes pratiques.
Référence des en-têtes de réponse
Toutes les réponses de l’API Venice incluent des en-têtes HTTP qui fournissent des métadonnées sur la requête, les limites de débit, les informations sur le modèle et le solde du compte. En plus des codes d’erreur renvoyés par les réponses API, vous pouvez inspecter ces en-têtes pour obtenir l’ID unique d’une requête API particulière, surveiller les limites de débit et suivre le solde de votre compte. Venice recommande de journaliser les ID de requête (en-têteCF-RAY) dans les déploiements en production pour un dépannage plus efficace avec notre équipe de support, si le besoin se présente.
Le tableau ci-dessous fournit une référence complète de tous les en-têtes que vous pouvez rencontrer :
Notes importantes
- Casse des noms d’en-tête : Les en-têtes HTTP sont insensibles à la casse, mais Venice utilise des minuscules avec des tirets pour la cohérence
- Valeurs string : Les valeurs booléennes dans les en-têtes sont renvoyées sous forme de chaînes (
"true"ou"false") - Valeurs numériques : Les grands nombres et valeurs de solde peuvent être renvoyés sous forme de chaînes pour éviter une perte de précision
- En-têtes optionnels : Tous les en-têtes ne sont pas renvoyés dans chaque réponse ; leur présence dépend de l’endpoint et du contexte de la requête
- Compression : Utilisez
Accept-Encoding: gzip, brdans les requêtes pour recevoir des réponses compressées lorsque cela est pris en charge
Exemple : Accéder aux en-têtes de réponse
Bonnes pratiques
- Limites de débit : Surveillez les en-têtes
x-ratelimit-remaining-requestsetx-ratelimit-remaining-tokenset implémentez un backoff exponentiel - Surveillance du solde : Suivez les en-têtes
x-venice-balance-usdetx-venice-balance-diempour éviter les interruptions de service - Prompts système : Testez avec et sans les prompts système de Venice pour trouver celui qui convient le mieux à votre cas d’usage
- Clés API : Gardez vos clés API en sécurité et faites-les tourner régulièrement
- Journalisation des requêtes : Journalisez les valeurs d’en-tête
CF-RAYpour le dépannage avec le support - Dépréciation de modèle : Vérifiez les en-têtes
x-venice-model-deprecation-warninglors de l’utilisation des modèles
Différences avec l’API d’OpenAI
Bien que Venice maintienne une grande compatibilité avec la spécification API d’OpenAI, il existe certaines différences clés :- venice_parameters : Des configurations supplémentaires comme
enable_web_search,character_slugetstrip_thinking_responsepour des fonctionnalités étendues - Prompts système : Venice ajoute vos prompts système aux valeurs par défaut qui optimisent les réponses non censurées (désactivez avec
include_venice_system_prompt: false) - Écosystème de modèles : Venice propose sa propre gamme de modèles, y compris des modèles non censurés et de raisonnement — utilisez les ID de modèle Venice plutôt que les mappages OpenAI
- En-têtes de réponse : En-têtes uniques pour le suivi du solde (
x-venice-balance-usd,x-venice-balance-diem), les avertissements de dépréciation de modèle et les indicateurs de sécurité de contenu - Politiques de contenu : Politiques plus permissives avec des modèles non censurés dédiés et un filtrage de contenu optionnel
Stabilité de l’API
Venice maintient la compatibilité ascendante pour les endpoints et paramètres v1. Pour la politique de cycle de vie des modèles, les avis de dépréciation et les conseils de migration, voir Dépréciations.Spécification OpenAPI et données brutes
Pour un accès programmatique à la documentation et aux données de l’API Venice — y compris pour une utilisation avec RAG (Retrieval-Augmented Generation) — les ressources suivantes sont disponibles :- Spec OpenAPI (YAML) — la spécification API complète au format YAML
- Source de la documentation API — toutes les pages de documentation (format
.mdx) sous forme d’archive téléchargeable
Les champs de requête non listés dans cette documentation peuvent être transmis mais ne sont ni validés ni garantis fonctionner.