Link to this sectionClés API#

Les clés API de la 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 un chiffrement AES-256-GCM pour différents cas d'usage.

Link to this sectionCréer une clé API#

Crée une nouvelle clé API :

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

Link to this sectionNom 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

Link to this sectionAffichage de la clé#

Après la création, la clé s'affiche une seule fois :

Link to this sectionFormat de la clé#

Les clés API suivent ce format :

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

Link to this sectionSécurité des clés#

• Les clés sont stockées avec un chiffrement AES-256-GCM
• L'authentification utilise un hash SHA-256 pour une recherche rapide du préfixe et une comparaison de hash
• Les valeurs complètes des clés ne sont jamais stockées en texte clair

Link to this sectionUtilisation des clés API#

Link to this sectionVariable d'environnement#

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

export ULTRALYTICS_API_KEY="YOUR_API_KEY"

Link to this sectionYOLO CLI#

Définis la clé en utilisant le YOLO CLI :

yolo settings api_key="YOUR_API_KEY"

Link to this sectionDans le code#

Utilise la clé dans tes scripts Python :

import os

# From environment (recommended)
api_key = os.environ.get("ULTRALYTICS_API_KEY")

# Or directly (not recommended for production)
api_key = "YOUR_API_KEY"

Link to this sectionEn-têtes HTTP#

Inclus la clé dans les requêtes API :

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

Consulte la Référence REST API pour tous les points de terminaison disponibles.

Link to this sectionEntraînement distant#

Active le streaming des métriques avec ta clé.

pip install "ultralytics>=8.4.60"

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

Consulte Cloud Training pour le guide complet de l'entraînement à distance.

Link to this sectionGérer les clés#

Link to this sectionVoir les clés#

All keys are listed on the Settings > API Keys tab:

Chaque fiche de clé affiche le nom de la clé, la valeur complète déchiffrée (copiable), l'heure de création relative et un bouton de révocation.

Link to this sectionRévoquer une clé#

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

1. Trouve la clé dans la section Clés API
2. Clique sur le bouton Révoquer (corbeille)
3. Confirme la révocation

Link to this sectionRégénérer une clé#

Si une clé est compromise :

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

Link to this sectionClés API d'espace de travail#

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

• Espace de travail personnel : Les clés s'authentifient comme ton compte personnel
• Espace de travail d'équipe : Les clés s'authentifient dans le contexte de l'équipe

Lorsque tu changes d'espace de travail dans la barre latérale, la section Clés API affiche les clés de cet espace. Un rôle Éditeur ou supérieur est requis pour gérer les clés API de l'espace de travail. Voir Teams pour les détails sur les rôles.

Link to this sectionBonnes pratiques de sécurité#

Link to this sectionÀ faire#

• Stocker les clés dans des variables d'environnement
• Utiliser des clés séparées pour différents environnements
• Révoquer rapidement les clés inutilisées
• Faire pivoter les clés périodiquement
• Utiliser des noms descriptifs pour identifier l'usage des clés

Link to this sectionÀ ne pas faire#

• Inclure les clés dans le contrôle de version
• Partager des clés entre applications
• Enregistrer les clés dans la sortie des applications
• Intégrer des clés dans le code côté client

Link to this sectionRotation des clés#

Fais pivoter tes clés périodiquement pour des raisons de 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é

Link to this sectionDépannage#

Link to this sectionErreur de clé invalide#

Solutions :

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

Link to this sectionPermission refusée#

Solutions :

1. Vérifie que tu es le propriétaire de la ressource ou que tu as l'accès approprié à l'espace de travail
2. Vérifie que la clé appartient au bon espace de travail
3. Crée une nouvelle clé si nécessaire

Link to this sectionLimite de débit dépassée#

Solutions :

1. Réduis la fréquence des requêtes — consulte le tableau des limites de débit pour les limites par point de terminaison
2. Implémente un backoff exponentiel en utilisant l'en-tête Retry-After
3. Utilise un point de terminaison dédié pour un débit d'inférence illimité

Link to this sectionFAQ#

Link to this sectionCombien de clés puis-je créer ?#

Il n'y a pas de limite stricte sur les clés API. Crée-en autant que nécessaire pour tes différentes applications et environnements.

Link to this sectionLes clés expirent-elles ?#

Les clés n'expirent pas automatiquement. Elles restent valides jusqu'à ce qu'elles soient révoquées. Pense à mettre en place une rotation pour plus de sécurité.

Link to this sectionPuis-je voir ma clé après sa création ?#

Oui, les valeurs complètes des clés sont visibles dans la liste des clés sous Settings > API Keys. La plateforme déchiffre et affiche tes clés afin que tu puisses les copier à tout moment.

Link to this sectionLes clés sont-elles spécifiques à une région ?#

Les clés fonctionnent dans toutes les régions, mais n'accèdent qu'aux données situées dans la région de ton compte.

Link to this sectionPuis-je partager mes clés avec des membres de mon équipe ?#

Meilleure pratique : demande à chaque membre de ton équipe de créer sa propre clé. Pour les espaces de travail d'équipe, chaque membre possédant le rôle Éditeur ou supérieur peut créer des clés limitées à cet espace de travail.