Clés API#

Les clés API de Ultralytics Platform permettent un accès programmatique sécurisé pour l'entraînement à distance, l'inférence et l'automatisation. Crée des clés nommées avec chiffrement AES-256-GCM pour différents cas d'utilisation.

Créer une clé API#

Crée une nouvelle clé API :

1. Va dans Paramètres > Clés API
2. Clique sur Ajouter une clé et sélectionne Ultralytics comme fournisseur
3. Saisis un nom pour la clé (par exemple, « Serveur d'entraînement »)
4. Clique sur Créer une clé

Nom de la clé#

Donne à ta clé un nom descriptif :

• training-server - Pour les machines d'entraînement à distance
• ci-pipeline - Pour l'intégration CI/CD
• local-dev - Pour le développement local

Affichage de la clé#

Après sa création, la clé s'affiche dans une boîte de dialogue de confirmation :

Clés de fournisseurs pour les agents et l'annotation#

L'onglet Paramètres > Clés API stocke également les clés des fournisseurs de modèles externes utilisés par les agents et les modèles payants de l'annotation guidée par classe ; l'annotation lit la clé enregistrée dans l'espace de travail du jeu de données. Seul le propriétaire de l'espace de travail peut ajouter, remplacer ou supprimer ces clés ; les membres de l'équipe peuvent voir quels fournisseurs sont connectés. Demande au propriétaire de connecter un fournisseur manquant. Pour connecter un fournisseur en tant que propriétaire :

1. Clique sur Ajouter une clé.
2. Sélectionne le fournisseur correspondant au modèle de langage ou au modèle vision-langage de ton flux de travail, ou au modèle d'annotation que tu souhaites utiliser.
3. Colle la clé API du fournisseur dans Clé API, puis clique sur Enregistrer la clé. Le lien Obtenir une clé API de la boîte de dialogue ouvre la page des clés du fournisseur.

Une clé Ultralytics n'authentifie pas les fournisseurs de modèles externes. L'utilisation des fournisseurs est facturée sur le compte associé à la clé enregistrée. Utilise la commande de modification de la ligne de clé pour remplacer une clé de fournisseur.

Format des clés#

Les clés API respectent le format suivant :

ul_a1b2c3d4e5f60718293a4b5c6d7e8f90a1b2c3d4

• Préfixe : ul_ identifie les clés Ultralytics
• Corps : 40 caractères hexadécimaux aléatoires
• Total : 43 caractères

Sécurité des clés#

• Les clés sont stockées avec le chiffrement AES-256-GCM, jamais en texte brut
• Les 11 premiers caractères (ul_ plus 8 caractères hexadécimaux) servent de préfixe d'affichage, ce qui permet d'identifier une clé sans la révéler

Utiliser les clés API#

Variable d’environnement#

Définis ta clé comme variable d'environnement :

export ULTRALYTICS_API_KEY="YOUR_API_KEY"

YOLO CLI#

Valide et enregistre la clé à l'aide de YOLO CLI avec Python>=3.11 :

yolo login YOUR_API_KEY

Supprime la clé enregistrée avec yolo logout.

En-têtes HTTP#

Inclue la clé dans les requêtes API :

curl -H "Authorization: Bearer YOUR_API_KEY" \
  https://platform.ultralytics.com/api/...

Tu peux aussi la transmettre au SDK Python (pip install "ultralytics-platform>=0.1.45"), qui lit ULTRALYTICS_API_KEY ou la clé enregistrée par yolo login si api_key est omis :

from ultralytics_platform import Platform

client = Platform(api_key="YOUR_API_KEY")

Consulte la référence de l'API REST pour connaître tous les points de terminaison disponibles.

Entraînement à distance#

Active la diffusion des métriques avec ta clé.

Installe ou mets à jour le paquet Ultralytics avec Python>=3.11 avant de commencer :

pip install -U ultralytics

export ULTRALYTICS_API_KEY="YOUR_API_KEY"
yolo train model=yolo26n.pt data=coco.yaml project=username/project name=exp1

Consulte l'entraînement dans le cloud pour le guide complet de l'entraînement à distance.

Gérer les clés#

Afficher les clés#

Toutes les clés sont répertoriées dans l'onglet Settings > API Keys :

Chaque ligne de clé affiche le nom de la clé, son préfixe, la date de création, un bouton permettant de copier la clé complète et un bouton de suppression (corbeille).

Révoquer une clé#

Révoque une clé compromise ou dont tu n'as plus besoin :

1. Repère la clé dans la section Clés API
2. Clique sur le bouton de suppression (corbeille)
3. Clique sur Supprimer la clé pour confirmer

Régénérer une clé#

Si une clé est compromise :

1. Crée une nouvelle clé portant le même nom
2. Mets à jour tes applications
3. Révoque l'ancienne clé

Clés API de l'espace de travail#

Les clés API sont associées à l'espace de travail actuellement actif :

• Espace de travail personnel : les clés authentifient l'utilisateur en tant que titulaire de ton compte personnel
• Espace de travail d'équipe : les clés authentifient l'utilisateur en tant que propriétaire de l'espace de travail d'équipe, avec toutes les autorisations du propriétaire dans cet espace

Lorsque tu changes d'espace de travail dans la barre latérale, la section Clés API affiche les clés de cet espace de travail. Comme une clé d'espace de travail confère les autorisations du propriétaire, seul le propriétaire de l'espace de travail peut en créer, afficher ou révoquer une. Consulte Équipes pour en savoir plus sur les rôles.

Clés des travailleurs sur site#

La connexion d'un hôte sur site génère une clé de travailleur distincte. Les clés de travailleur sont gérées depuis l'intégration sur site et non depuis cet onglet ; elles ne figurent jamais avec tes clés API et sont révoquées en déconnectant l'hôte, ce qui annule également les tâches en attente et en cours de cet hôte.

Bonnes pratiques de sécurité#

À faire#

• Stocke les clés dans des variables d'environnement
• Utilise des clés distinctes pour les différents environnements
• Révoque rapidement les clés inutilisées
• Fais tourner les clés périodiquement
• Utilise des noms descriptifs pour identifier l'usage des clés

Ne#

• Ne committe pas de clés dans le contrôle de version
• Ne partage pas de clés entre applications
• Ne consigne pas de clés dans la sortie de l’application
• N’intègre pas de clés dans le code côté client

Rotation des clés#

Fais régulièrement tourner les clés pour renforcer la sécurité :

1. Crée une nouvelle clé avec le même nom
2. Mets à jour les applications pour utiliser la nouvelle clé
3. Vérifie que les applications fonctionnent correctement
4. Révoque l’ancienne clé

Dépannage#

Erreur de clé invalide#

Error: Invalid API key

Solutions :

1. Vérifie que la clé a été copiée correctement (y compris le préfixe ul_)
2. Vérifie que la clé n’a pas été révoquée
3. Vérifie que la variable d’environnement est définie
4. Assure-toi d’utiliser Python>=3.11 et ultralytics>=8.4.120

Accès refusé#

Error: Permission denied for this operation

Solutions :

1. Vérifie que tu es propriétaire de la ressource ou que tu disposes des droits d’accès appropriés à l’espace de travail
2. Vérifie que la clé appartient au bon espace de travail
3. Si tu gères des clés dans un espace de travail d’équipe, vérifie que tu en es propriétaire — les autres rôles obtiennent Workspace owner access required
4. Crée une nouvelle clé si nécessaire

Limitation du débit#

Error: Rate limit exceeded

Solutions :

1. Réduis la fréquence des requêtes — consulte le tableau des limites de débit pour connaître les limites par catégorie
2. Mets en œuvre un délai exponentiel en utilisant l’en-tête Retry-After
3. Utilise un point de terminaison dédié lorsque tu as besoin d’une capacité d’inférence isolée

FAQ#