Zum Hauptinhalt springen

API-Keys verwalten

API-Keys ermöglichen es externen Diensten, Anwendungen und der CLYE CLI, sicher mit deiner CLYE-AI-Instanz zu kommunizieren. Sie sind der zentrale Zugangsschlüssel für alle programmatischen Zugriffe.

Was ist ein API-Key?​

Ein API-Key ist ein geheimer Token, der eine Anwendung oder einen Dienst gegenüber CLYE AI authentifiziert. Anders als ein Passwort ist ein API-Key nicht an eine Person, sondern an eine Anwendung oder Integration gebunden.

API-Keys werden benötigt für:

API-Key erstellen​

info

Nur Space-Admins und Nutzer mit entsprechenden Berechtigungen können API-Keys erstellen.

  1. Gehe zu Einstellungen → Space → API-Keys.
  2. Klicke auf API-Key erstellen.
  3. Gib einen Namen ein (z. B. "Mein CLI-Zugang" oder "LLM-Gateway-Produktion").
  4. Wähle optional die Berechtigungen (Scopes) für den Key.
  5. Klicke auf Erstellen.
warnung

Nach dem Erstellen wird der Key nur einmal angezeigt. Kopiere ihn sofort und bewahre ihn sicher auf – zum Beispiel in einem Passwort-Manager oder einer .env-Datei.

Berechtigungen (Scopes)​

Ein API-Key kann auf bestimmte Aktionen eingeschränkt werden. Typische Berechtigungen sind:

ScopeBeschreibung
ChatNachrichten senden und Chats führen
DateienDateien in Workspaces lesen und hochladen
AufgabenAufgaben erstellen, bearbeiten und abschließen
AdminSpace-Einstellungen lesen und ändern
LLM GatewayZugriff auf das LLM Gateway

Du kannst mehrere Berechtigungen pro Key kombinieren. Für jeden Key solltest du nur die Berechtigungen wählen, die die Anwendung wirklich braucht (Prinzip der minimalen Rechte).

API-Key verwenden​

In der CLYE CLI​

export AI_HUB_URL="https://deine-instanz.example.com"
export AI_HUB_API_KEY="dein-api-key-here"

ai-hub-cli connect

Im HTTP-Header​

Authorization: Bearer dein-api-key-here
Content-Type: application/json

Als Query-Parameter (für einfache Tests)​

https://deine-instanz.example.com/api/endpoint?api_key=dein-api-key-here

API-Key widerrufen​

Wenn ein Key kompromittiert ist oder nicht mehr benötigt wird, solltest du ihn sofort widerrufen:

  1. Gehe zu Einstellungen → Space → API-Keys.
  2. Finde den entsprechenden Key in der Liste.
  3. Klicke auf Widerrufen (oder das Papierkorb-Symbol).
  4. Bestätige den Widerruf.
warnung

Nach dem Widerruf können alle Dienste, die diesen Key verwenden, nicht mehr auf CLYE AI zugreifen. Stelle sicher, dass du den Key in allen Anwendungen ersetzt hast, bevor du ihn widerrufst.

Best Practices​

  • Keys rotieren: Erstelle regelmäßig neue Keys und widerrufe alte.
  • Minimale Rechte: Gib jedem Key nur die Berechtigungen, die er wirklich braucht.
  • Sicher ablegen: Speichere Keys in einem Passwort-Manager oder einer verschlüsselten .env-Datei.
  • Nicht im Code: Hinterlege Keys nie direkt im Quellcode, besonders nicht in öffentlichen Repositories.
  • Namen vergeben: Verwende aussagekräftige Namen, damit du später weißt, wofür ein Key erstellt wurde.
  • Überwachung: Prüfe regelmäßig die Liste der aktiven Keys und widerrufe ungenutzte.

Limits​

  • Die maximale Anzahl aktiver API-Keys pro Space ist begrenzt (siehe Space-Einstellungen).
  • API-Keys haben ein Ablaufdatum. Du wirst rechtzeitig benachrichtigt, wenn ein Key bald abläuft.
  • Bei wiederholter Nutzung eines widerrufenen Keys erhältst du einen HTTP-401-Fehler.

Kurz gesagt​

API-Keys sind der sichere Zugangsschlüssel für CLI, LLM Gateway und externe Integrationen. Erstelle Keys mit minimalen Rechten, bewahre sie sicher auf und widerrufe nicht mehr benötigte Keys umgehend.

Inhalt