Passer au contenu principal
Une clé Admin peut gérer toutes vos autres clés API via l’API. Attribuez à chaque application, environnement ou client sa propre clé Inference, plafonnez ce que chacune peut dépenser, suivez l’utilisation par clé, et modifiez ou révoquez des clés sans ouvrir le tableau de bord.

Créer

Émettez une clé avec un plafond de dépense

Suivre

Voyez ce que dépense chaque clé

Modifier

Augmentez un plafond ou prolongez une expiration

Révoquer

Désactivez une clé immédiatement

Fonctionnement

Clé AdminVotre clé de contrôleCrée, modifie et révoque des clésLit l’utilisation et la facturationReste sur votre serveur
Inferencecust:acme50 $ / moisModèles privés uniquement
Inferencecust:globex5 $ / moisUniquement depuis 11.22.33.0/24
Inferencestaging10 $ / jourExpire le 30 juin
Les clés Admin peuvent appeler tous les endpoints, y compris ceux qui gèrent les clés et lisent la facturation. Les clés Inference peuvent appeler les modèles mais ne peuvent ni gérer les clés ni lire la facturation : ce sont donc les clés que vous distribuez.
Créez votre première clé Admin dans le tableau de bord : suivez Génération d’une clé API et choisissez Admin comme type de clé. Conservez-la dans un gestionnaire de secrets côté serveur, jamais dans du code côté client.
Les exemples de cette page lisent la clé Admin depuis VENICE_ADMIN_KEY :

Créer une clé

Cet exemple crée une clé Inference pour un client, plafonnée à 50 $ par mois et expirant le 30 juin 2027 :
Response
data.apiKey est la valeur secrète de la clé, et cette réponse est la seule occasion de la voir. Stockez-la immédiatement. Si vous la perdez, révoquez la clé et créez-en une nouvelle. Conservez également data.id : tous les autres appels de cette page l’utilisent.

Paramètres de la clé

Définissez ces paramètres lors de la création d’une clé, ou modifiez-les ultérieurement avec PATCH /api_keys. Le corps de la requête est strict : un champ inconnu renvoie 400. Vous pouvez créer jusqu’à 20 clés par minute et conserver jusqu’à 500 clés actives. Contactez le support si vous avez besoin de davantage.
Vous développez un agent ? Un portefeuille détenant du VVV staké sur Base peut générer sa propre clé sans compte Venice. Consultez Création de clé API pour agent autonome.

Suivre l’utilisation

Une clé

Response (trimmed)
Cette clé a utilisé 12,50 surses50sur ses 50 du mois. currentPeriodUsage n’apparaît que sur les clés disposant d’un plafond en USD ou en DIEM, et les montants d’utilisation sont des chaînes à quatre décimales. Les réponses renvoient consumptionLimits (au pluriel), tandis que les requêtes envoient consumptionLimit (au singulier).

Dépenses par clé au fil du temps

GET /billing/usage-analytics renvoie les totaux par clé dans byKey et une ligne par jour dans byKeyDaily, prêtes à être représentées dans un graphique. Passez lookback (7d par défaut, jusqu’à 90d) ou une paire startDate et endDate couvrant jusqu’à 90 jours. Les résultats sont mis en cache pendant 10 minutes.
cURL
Response (trimmed)

Chaque débit, par clé

GET /billing/usage-history liste chaque débit, et chaque entrée porte l’apiKeyId auquel il a été facturé. Utilisez-le pour rapprocher vos dépenses ou facturer vos propres clients. Les entrées sont renvoyées de la plus ancienne à la plus récente. Renvoyez nextCursor en tant que cursor, seul, jusqu’à ce qu’il soit null. Envoyez Accept: text/csv pour obtenir du CSV à la place.
Les débits ont un amount négatif : la boucle le soustrait donc pour obtenir un total positif par clé et par devise. Les entrées sans apiKeyId proviennent de l’application web Venice, ou sont des écritures de compte telles que des achats de crédits.

Si une clé peut dépenser en ce moment

GET /api_keys/rate_limits fonctionne avec n’importe quelle clé et renseigne sur la clé qui l’appelle. accessPermitted indique si la clé peut dépenser en ce moment, et balances montre ce qu’il lui reste à dépenser.
cURL
GET /api_keys/rate_limits/log, avec une clé Admin, renvoie vos 50 derniers dépassements de limite de débit, chacun avec son apiKeyId et son modelId.

Modifier les limites et les paramètres

Envoyez l’id de la clé et uniquement les champs que vous souhaitez modifier. Tout le reste demeure inchangé. Cet exemple porte le plafond à 100 $ par mois :
Envoyez plutôt l’un de ces champs pour effectuer d’autres modifications : Une nouvelle limitPeriod s’applique immédiatement : passer à LIFETIME impute donc toutes les dépenses passées de la clé à son plafond. apiKeyType ne peut pas être modifié ; créez plutôt une nouvelle clé.

Révoquer ou faire tourner une clé

La réponse est { "success": true }. La révocation est immédiate : la requête suivante de la clé reçoit 401 Authentication failed, et la clé disparaît de GET /api_keys. Ses débits passés restent dans l’historique d’utilisation. Pour faire tourner une clé sans interruption de service :
1

Créer la clé de remplacement

Créez une nouvelle clé avec les mêmes paramètres et stockez sa valeur secrète.
2

La déployer

Basculez votre application sur la nouvelle valeur secrète.
3

Révoquer l'ancienne clé

Une fois que le lastUsedAt de l’ancienne clé dans GET /api_keys ne bouge plus, supprimez-la.

Erreurs que vos appelants peuvent rencontrer

Consultez Codes d’erreur pour la liste complète.

Bonnes pratiques

  • Conservez les clés Admin sur votre serveur et ne distribuez que des clés Inference.
  • Attribuez à chaque application, environnement et client sa propre clé, afin que chacune puisse être suivie et révoquée individuellement.
  • Indiquez votre propre identifiant dans description. Les analyses d’utilisation étiquettent les clés avec cette valeur.
  • Plafonnez et faites expirer chaque clé que vous confiez à un tiers, et restreignez les clés de serveur à serveur à vos IP avec ipAllowlist.

Référence API

Créer une clé API

Tous les champs acceptés à la création.

Mettre à jour une clé API

Modifiez les limites, l’expiration, la confidentialité et les IP.

Lister les clés API

Toutes les clés actives avec leur utilisation.

Supprimer une clé API

Révoquez une clé.

Analyses d'utilisation

Dépenses par clé, par modèle et par jour.

Historique d'utilisation

Chaque débit, avec sa clé API.