API-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.

API-Schlüssel erstellen

Erstelle einen neuen API-Schlüssel:

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

Schlüsselname

Gib deinem Schlüssel einen beschreibenden Namen:

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

Schlüsselanzeige

Nach der Erstellung wird der Schlüssel einmalig angezeigt:

Schlüsselformat

API-Schlüssel folgen diesem Format:

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

Schlüsselsicherheit

• Schlüssel werden mit AES-256-GCM-Verschlüsselung gespeichert
• Die Authentifizierung verwendet einen SHA-256-Hash für schnelle Präfix-Suche und Hash-Vergleiche
• Vollständige Schlüsselwerte werden niemals im Klartext gespeichert

Verwendung von API-Schlüsseln

Umgebungsvariable

Setze deinen Schlüssel als Umgebungsvariable:

export ULTRALYTICS_API_KEY="YOUR_API_KEY"

YOLO CLI

Setze den Schlüssel über die YOLO CLI:

yolo settings api_key="YOUR_API_KEY"

Im 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"

HTTP-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.

Remote-Training

Aktiviere das Metrik-Streaming mit deinem Schlüssel.

pip install "ultralytics>=8.4.35"

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 die vollständige Anleitung zum Remote-Training.

Schlüssel verwalten

Schlüssel anzeigen

Alle Schlüssel sind auf dem Tab Settings > API Keys aufgelistet:

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

Schlüssel widerrufen

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

1. Finde den Schlüssel im Abschnitt API-Schlüssel
2. Klicke auf die Revoke (Mülleimer)-Schaltfläche
3. Bestätige den Widerruf

Schlü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

Workspace-API-Schlüssel

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

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

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

Best Practices für die Sicherheit

Tun

• 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 den Zweck des Schlüssels zu identifizieren

Lassen

• Schlüssel in die Versionskontrolle einchecken
• Schlüssel zwischen Anwendungen teilen
• Schlüssel in der Anwendungsausgabe protokollieren
• Schlüssel in clientseitigen Code einbetten

Schlüsselrotation

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

1. Erstelle einen neuen Schlüssel mit demselben Namen
2. Aktualisiere Anwendungen für die Verwendung des neuen Schlüssels
3. Überprüfe, ob die Anwendungen ordnungsgemäß funktionieren
4. Widerrufe den alten Schlüssel

Fehlerbehebung

Fehler: 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.35 verwendest

Zugriff verweigert

Lösungen:

1. Überprüfe, ob du der Ressourceninhaber bist oder über den entsprechenden Arbeitsbereichszugriff verfügst
2. Prüfe, ob der Schlüssel zum richtigen Arbeitsbereich gehört
3. Erstelle bei Bedarf einen neuen Schlüssel

Ratenbegrenzung

Lösungen:

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

FAQ

Wie viele Schlüssel kann ich erstellen?

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

Laufen Schlüssel ab?

Schlüssel laufen nicht automatisch ab. Sie bleiben bis zum Widerruf gültig. Erwäge aus Sicherheitsgründen die Implementierung einer Rotation.

Kann ich meinen Schlüssel nach der Erstellung sehen?

Ja, die vollständigen Schlüsselwerte sind in der Schlüsselliste unter Settings > API Keys sichtbar. Die Plattform entschlüsselt und zeigt deine Schlüssel an, damit du sie jederzeit kopieren kannst.

Sind Schlüssel regionsspezifisch?

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

Kann ich Schlüssel mit Teammitgliedern teilen?

Bessere Praxis: Lass jedes Teammitglied einen eigenen Schlüssel erstellen. Für Team-Workspaces kann jedes Mitglied mit der Rolle Editor oder höher Schlüssel erstellen, die auf diesen Workspace beschränkt sind.