DokumentationAPI-Schlüssel

Loslegen

API-Schlüssel

Ein Schlüssel identifiziert Ihre Anwendung gegenüber der API. Er bleibt auf Ihrem Server, wie ein Passwort.

Auf dieser Seite
  1. So sieht ein Schlüssel aus
  2. Wohin Sie ihn senden
  3. Einen Schlüssel erhalten
  4. Den Schlüssel geheim halten

So sieht ein Schlüssel aus

Ein Schlüssel beginnt immer mit lya, gefolgt von seinem Typ. Der Typ gibt an, für wen er handelt.

PräfixTypFür
lya_svc_ServiceEine Anwendung oder ein Server Ihres Arbeitsbereichs
lya_usr_PersönlichEine Person, mit ihren eigenen Rechten
lya_prt_PartnerEine mit Learnya entwickelte Integration

Learnya speichert davon nur einen Hash, der sich nicht zurücklesen lässt. Ein verlorener Schlüssel lässt sich nicht wiederherstellen, nur ersetzen.

Wohin Sie ihn senden

Im Header Authorization, nach Bearer. Die OpenAI SDKs erledigen das für Sie. Der Header x-api-key wird ebenfalls akzeptiert.

HeaderBeispiel
AuthorizationBearer lya_svc_…
x-api-keylya_svc_…

Ein abgelehnter Schlüssel erhält eine Antwort 401, ohne Angabe des Grundes. Wer Schlüssel ausprobiert, erfährt also nichts.

Einen Schlüssel erhalten

Schlüssel stehen Team-Arbeitsbereichen und Partnern offen. Wir erstellen Ihren Schlüssel mit Ihnen und legen gemeinsam fest:

  • seinen Namen, damit Sie ihn in Ihrem Arbeitsbereich wiedererkennen
  • seinen Scope, der llm:invoke enthalten muss, damit er die Modelle aufrufen kann
  • ein Ablaufdatum, wenn der Schlüssel einem befristeten Projekt dient

Der Schlüssel wird Ihnen nur einmal angezeigt, bei seiner Erstellung.

Schlüssel anfragen

Den Schlüssel geheim halten

  • Ein Schlüssel pro Anwendung, damit Sie einen sperren können, ohne die anderen anzuhalten
  • In einer Umgebungsvariable oder einem Secret-Speicher, nie im Code-Repository
  • Ein widerrufener Schlüssel funktioniert nach weniger als einer Minute nicht mehr