Link to this sectionAPI-Schlüssel#

Ultralytics Platform API-Schlüssel ermöglichen einen sicheren, programmatischen Zugriff für Remote-Training, Inferenz und Automatisierung. Erstelle benannte Schlüssel mit AES-256-GCM-Verschlüsselung für verschiedene Anwendungsfälle.

Link to this sectionAPI-Key erstellen#

Erstelle einen neuen API-Schlüssel:

1. Gehe zu Einstellungen > API-Schlüssel
2. Klicke auf Schlüssel erstellen
3. Gib einen Namen für den Schlüssel ein (z. B. "Training Server")
4. Klicke auf Schlüssel erstellen

Link to this sectionSchlüsselname#

Gib deinem Schlüssel einen beschreibenden Namen:

• training-server - Für Remote-Trainingsmaschinen
• ci-pipeline - Für CI/CD-Integration
• local-dev - Für die lokale Entwicklung

Link to this sectionSchlüsselanzeige#

Nach der Erstellung wird der Schlüssel einmalig angezeigt:

Link to this sectionSchlüsselformat#

API-Schlüssel folgen diesem Format:

• Präfix: ul_ identifiziert Ultralytics-Schlüssel
• Körper: 40 zufällige hexadezimale Zeichen
• Gesamt: 43 Zeichen

Link to this sectionSchlüsselsicherheit#

• Schlüssel werden mit AES-256-GCM-Verschlüsselung gespeichert
• Die Authentifizierung verwendet einen SHA-256-Hash für ein schnelles indiziertes Nachschlagen
• Vollständige Schlüsselwerte werden niemals im Klartext gespeichert

Link to this sectionVerwendung von API-Schlüsseln#

Link to this sectionUmgebungsvariable#

Setze deinen Schlüssel als Umgebungsvariable:

export ULTRALYTICS_API_KEY="YOUR_API_KEY"

Link to this sectionYOLO CLI#

Setze den Schlüssel über die YOLO CLI:

yolo settings api_key="YOUR_API_KEY"

Link to this sectionIm Code#

Verwende den Schlüssel in deinen Python-Skripten:

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 sectionHTTP-Header#

Füge den Schlüssel in API-Anfragen ein:

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

Siehe die REST API Referenz für alle verfügbaren Endpunkte.

Link to this sectionRemote-Training#

Aktiviere das Metrik-Streaming mit deinem Schlüssel.

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

Siehe Cloud Training für das vollständige Handbuch zum Remote-Training.

Link to this sectionSchlüssel verwalten#

Link to this sectionSchlüssel anzeigen#

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

Jede Schlüsselkarte zeigt den Namen des Schlüssels, den vollständigen entschlüsselten Schlüsselwert (kopierbar), die relative Erstellungszeit und eine Schaltfläche zum Widerrufen.

Link to this sectionSchlüssel widerrufen#

Widerrufe einen Schlüssel, der kompromittiert wurde oder nicht mehr benötigt wird:

1. Finde den Schlüssel im Bereich API-Schlüssel
2. Klicke auf die Schaltfläche Widerrufen (Papierkorb)
3. Bestätige den Widerruf

Link to this sectionSchlüssel neu generieren#

Falls ein Schlüssel kompromittiert wurde:

1. Erstelle einen neuen Schlüssel mit demselben Namen
2. Aktualisiere deine Anwendungen
3. Widerrufe den alten Schlüssel

Link to this sectionWorkspace API-Schlüssel#

API-Schlüssel sind auf den aktuell aktiven Workspace beschränkt:

• Persönlicher Workspace: Schlüssel authentifizieren sich als dein persönliches Konto
• Team-Workspace: Schlüssel authentifizieren sich im Kontext des Teams

Beim Wechseln der Workspaces in der Seitenleiste zeigt der Bereich API-Schlüssel die Schlüssel für diesen Workspace an. Die Rolle Editor oder höher ist erforderlich, um Workspace-API-Schlüssel zu verwalten. Siehe Teams für Rollendetails.

Link to this sectionBest Practices für die Sicherheit#

Link to this sectionWas du tun solltest#

• Speichere Schlüssel in Umgebungsvariablen
• Verwende separate Schlüssel für verschiedene Umgebungen
• Widerrufe ungenutzte Schlüssel zeitnah
• Rotiere Schlüssel regelmäßig
• Verwende beschreibende Namen, um die Zwecke der Schlüssel zu identifizieren

Link to this sectionWas du nicht tun solltest#

• Vermeide das Committen von Schlüsseln in die Versionskontrolle
• Vermeide das Teilen von Schlüsseln zwischen Anwendungen
• Vermeide das Protokollieren von Schlüsseln in der Anwendungsausgabe
• Vermeide das Einbetten von Schlüsseln in clientseitigen Code

Link to this sectionSchlüsselrotation#

Rotiere Schlüssel regelmäßig aus Sicherheitsgründen:

1. Erstelle einen neuen Schlüssel mit demselben Namen
2. Aktualisiere Anwendungen, um den neuen Schlüssel zu verwenden
3. Überprüfe, ob die Anwendungen korrekt funktionieren
4. Widerrufe den alten Schlüssel

Link to this sectionFehlerbehebung#

Link to this sectionFehler: Ungültiger Schlüssel#

Lösungen:

1. Überprüfe, ob der Schlüssel korrekt kopiert wurde (einschließlich des ul_-Präfixes)
2. Prüfe, ob der Schlüssel widerrufen wurde
3. Bestätige, dass die Umgebungsvariable gesetzt ist
4. Stelle sicher, dass du ultralytics>=8.4.60 verwendest

Link to this sectionZugriff verweigert#

Lösungen:

1. Überprüfe, ob du der Eigentümer der Ressource bist oder den entsprechenden Workspace-Zugriff hast
2. Prüfe, ob der Schlüssel zum richtigen Workspace gehört
3. Erstelle bei Bedarf einen neuen Schlüssel

Link to this sectionRatenbegrenzung#

Lösungen:

1. Reduziere die Häufigkeit der Anfragen — siehe die Tabelle für Ratenbegrenzungen für Limits pro Endpunkt
2. Implementiere exponentielles Backoff unter Verwendung des Retry-After-Headers
3. Verwende einen dedizierten Endpunkt für unbegrenzten Inferenzdurchsatz

Link to this sectionFAQ#

Link to this sectionWie viele Schlüssel kann ich erstellen?#

Es gibt kein hartes Limit für API-Schlüssel. Erstelle so viele wie nötig für verschiedene Anwendungen und Umgebungen.

Link to this sectionLaufen Schlüssel ab?#

Schlüssel laufen nicht automatisch ab. Sie bleiben gültig, bis sie widerrufen werden. Erwäge die Implementierung einer Rotation aus Sicherheitsgründen.

Link to this sectionKann ich meinen Schlüssel nach der Erstellung sehen?#

Yes, full key values are visible in the key list on Settings > API Keys. The Platform decrypts and displays your keys so you can copy them anytime.

Link to this sectionSind Schlüssel regionsspezifisch?#

Schlüssel funktionieren regionsübergreifend, greifen jedoch nur auf Daten in der Region deines Kontos zu.

Link to this sectionKann ich Keys mit Teammitgliedern teilen?#

Bessere Vorgehensweise: Lass jedes Teammitglied seinen eigenen Key erstellen. Für Team-Workspaces kann jedes Mitglied mit der Rolle „Editor“ oder höher Keys erstellen, die auf diesen Workspace beschränkt sind.