Zum Hauptinhalt springen
Mit API-Schlüsseln rufen Ihre Anwendungen, Skripte und Dienste DeepMask-Modelle über die DeepMask API auf. Schlüssel gehören Ihrer Organisation, nicht einer einzelnen Person. Jeder Schlüssel kann nur die Modelle nutzen, die Sie ihm freigeben, und kann ein eigenes monatliches Ausgabenlimit haben. Sie verwalten Schlüssel auf der Registerkarte Schlüssel unter Benutzereinstellungen > API. Klicken Sie dazu unten in der Chat-Seitenleiste auf Ihren Namen, wählen Sie Benutzereinstellungen und dann in der Seitenleiste der Einstellungen API.
Nur Administratoren der Organisation sehen API in der Seitenleiste der Einstellungen. Jeder Administrator kann alle Schlüssel Ihrer Organisation erstellen, einsehen und widerrufen.

Voraussetzungen

Damit Sie einen Schlüssel erstellen können, müssen diese Voraussetzungen erfüllt sein:
  • Ihre Organisation hat einen aktiven kostenpflichtigen Tarif: Pro, Power oder Enterprise. Der kostenlose Tarif enthält keinen API-Zugriff. Eine Testphase oder ein Tarif mit überfälliger Zahlung zählt nicht.
  • Die API-Abrechnung ist aktiviert. Öffnen Sie die Registerkarte Abrechnung und klicken Sie auf API-Abrechnung aktivieren. Siehe Abrechnung.
  • Es gibt keine API-Rechnung mit fehlgeschlagener Zahlung.
  • Es läuft keine Nutzungsprüfung. Während DeepMask die letzte Nutzung prüft, können Sie keine Schlüssel erstellen. Siehe Wann Anfragen pausiert werden.
Fehlt eine dieser Voraussetzungen, ist Schlüssel erstellen nicht verfügbar. Ein Hinweis oben auf der Seite zeigt Ihnen, was Sie beheben müssen.

Einen Schlüssel erstellen

1

Registerkarte „Schlüssel“ öffnen

Gehen Sie zu Benutzereinstellungen > API. Bleiben Sie auf der Registerkarte Schlüssel und klicken Sie auf Schlüssel erstellen.
2

Schlüssel benennen

Geben Sie unter Schlüsselname einen Namen ein, der die App oder Umgebung beschreibt, zum Beispiel „Produktionsdienst“. Ein Name darf 1–80 Zeichen lang sein und keine Steuerzeichen wie Tabulatoren oder Zeilenumbrüche enthalten.
3

Ausgabenlimit des Schlüssels festlegen (optional)

Geben Sie unter Ausgabenlimit des Schlüssels (optional) einen Betrag in Euro ein, um die monatlichen Ausgaben dieses Schlüssels zu begrenzen. Lassen Sie das Feld leer, wenn nur das organisationsweite Limit gelten soll.
4

Modelle für den Schlüssel auswählen

Behalten Sie unter Modellzugriff die Option Modelle auswählen bei und markieren Sie die Modelle, die dieser Schlüssel nutzen darf. Alternativ wählen Sie Alle aktuellen Modelle, um alle Modelle freizugeben, die sich derzeit im Katalog befinden.
5

Schlüssel erstellen

Klicken Sie unten im Dialog auf Schlüssel erstellen. DeepMask zeigt den neuen Schlüssel nur einmal an. Kopieren und speichern Sie ihn deshalb sofort.
Dialog „API-Schlüssel erstellen“ mit dem Schlüsselnamen „Support-Assistent“, einem Ausgabenlimit des Schlüssels von 100 € und der Option „Modelle auswählen“ unter „Modellzugriff“. Unter dem Suchfeld „Modelle suchen“ stehen die Anbietergruppen, in der Fußzeile steht „4 von 26 ausgewählt.“

Benennen Sie den Schlüssel, legen Sie optional ein Limit fest und wählen Sie die Modelle aus, die er nutzen darf.

Modelle auswählen

Modellzugriff bietet zwei Optionen: Bei Modelle auswählen sind die Modelle nach Anbieter gruppiert:
  • Geben Sie in das Feld Modelle suchen einen Modellnamen, eine ID oder einen Anbieter ein, um die Liste zu filtern.
  • Anbietergruppen sind anfangs eingeklappt. Klicken Sie auf einen Anbieter, um seine Modelle ein- oder auszublenden. Bei einer Suche klappen alle passenden Gruppen auf.
  • Die Zahl neben einem Anbieter, etwa 2/12, zeigt, wie viele seiner Modelle Sie ausgewählt haben.
  • Klicken Sie auf Alle auswählen oder Auswahl aufheben, um alle Modelle eines Anbieters auf einmal aus- oder abzuwählen. Während Sie suchen, heißen diese Schaltflächen Treffer auswählen und Treffer abwählen.
  • Klicken Sie neben einem Modell auf die ⓘ-Schaltfläche, um seine Details zu sehen, darunter Kontextfenster, Unterstützung für Bildeingabe und Tool-Aufrufe sowie Preise. Siehe Modelldetails beim Erstellen eines Schlüssels.
Die Fußzeile des Dialogs zeigt, wie viele Modelle Sie ausgewählt haben, zum Beispiel „4 von 26 ausgewählt.“ Jeder Schlüssel braucht mindestens ein Modell und kann bis zu 100 haben.
Die Angabe Bildeingabe in den Details eines Modells bezieht sich auf die API. Bei einem Modell kann Nicht unterstützt stehen, auch wenn es in DeepMask Chat Bilder verarbeitet. Wenn Ihre App Bilder sendet, geben Sie mindestens ein Modell frei, bei dem Unterstützt steht. Sie können einem Schlüssel später keine Modelle hinzufügen. Welche Modelle Bilder akzeptieren, erfahren Sie unter Bildeingabe. Die Limits finden Sie unter Bildlimits.
Unter Modelle können Sie Modelle vergleichen und ihre IDs nachschlagen, bevor Sie Ihre Auswahl treffen.

Ausgabenlimit des Schlüssels festlegen

Das Ausgabenlimit des Schlüssels begrenzt die monatlichen Modellkosten genau dieses Schlüssels. Es darf das Gateway-Ausgabenlimit nicht übersteigen. Das ist das organisationsweite Limit, das für alle Schlüssel gemeinsam gilt. Die Regeln und das Zusammenspiel beider Limits finden Sie unter Ausgabenlimits für Schlüssel.

Schlüssel speichern

Nachdem Sie auf Schlüssel erstellen geklickt haben, wechselt der Dialog zu API-Schlüssel speichern. Er zeigt den Namen des Schlüssels, die Anzahl seiner Modelle und unter API-Schlüssel den vollständigen Schlüssel. Schlüssel beginnen mit sk-, gefolgt von 64 Hexadezimalzeichen.
1

Schlüssel kopieren

Klicken Sie auf Schlüssel kopieren. Die Schaltfläche wechselt zu Schlüssel kopiert. Wenn das Kopieren fehlschlägt, wird der Schlüssel markiert, damit Sie ihn selbst kopieren können.
2

Schlüssel sicher aufbewahren

Speichern Sie den Schlüssel in Ihrem Secret-Manager oder als Umgebungsvariable, zum Beispiel DEEPMASK_API_KEY.
3

Dialog schließen

Klicken Sie auf Ich habe ihn gespeichert. Nur so schließen Sie den Dialog, solange der Schlüssel angezeigt wird.
DeepMask zeigt den vollständigen Schlüssel nur einmal an. Nachdem Sie den Dialog geschlossen haben, sind nur noch die letzten vier Zeichen sichtbar. Wenn Sie die Seite neu laden oder die Organisation wechseln, bevor Sie den Schlüssel kopiert haben, können Sie ihn nicht mehr einsehen. Der Schlüssel bleibt aber in Ihrer Liste und funktioniert weiter. Wenn Sie einen Schlüssel verlieren, widerrufen Sie ihn und erstellen Sie einen neuen.

Schlüssel testen

Bevor Sie auf Ich habe ihn gespeichert klicken, können Sie den Schlüssel im selben Dialog testen.
1

Umgebungsvariable setzen

Setzen Sie DEEPMASK_API_KEY in Ihrem Terminal, zum Beispiel mit export DEEPMASK_API_KEY="sk-...".
2

Testbefehl kopieren

Klappen Sie Schlüssel testen auf und klicken Sie auf Befehl kopieren.
3

Befehl ausführen

Führen Sie den Befehl im selben Terminal aus, in dem Sie die Variable gesetzt haben. Er sendet „Hello“ an eines der Modelle des Schlüssels. Kommt eine JSON-Antwort mit dem Text des Modells zurück, funktioniert der Schlüssel.
Der Befehl funktioniert in macOS- und Linux-Shells wie bash oder zsh. Unter Windows verwenden Sie WSL oder Git Bash. Der Dialog bietet nur einen cURL-Befehl. Wie Sie den Schlüssel im Code mit dem OpenAI-SDK für Python oder Node.js testen, lesen Sie unter Ihre erste Anfrage senden.

Ihre Schlüssel im Überblick

Die Registerkarte Schlüssel listet die Schlüssel Ihrer Organisation auf, die neuesten zuerst. Die Zahl auf der Registerkarte gibt an, wie viele Schlüssel nicht widerrufen sind.
Registerkarte „Schlüssel“ der API-Einstellungen mit der Basis-URL und drei Schlüsseln: „Production service“ mit 26 Modellen sowie „Staging“ und „Data pipeline“ mit je 3 Modellen und dem Verbrauch ihres Schlüssellimits. Außerdem zu sehen sind die Schaltfläche „Schlüssel erstellen“ und der eingeklappte Bereich „Widerrufene Schlüssel (1)“.

Die Registerkarte „Schlüssel“ zeigt jeden Schlüssel mit seinen Modellen, seinem Status und dem Verbrauch seines Limits.

Für jeden Schlüssel sehen Sie: Die Zeile zum Schlüssellimit ändert sich, während der Schlüssel Kosten verursacht, zum Beispiel wenn das Limit erreicht ist. Alle Varianten finden Sie unter So zeigt die Schlüsselliste den Verbrauch. Datumsangaben erscheinen in Ihrer lokalen Zeitzone. Die Rücksetzung um 00:00 UTC am 1. eines Monats kann daher als letzter Tag des Vormonats angezeigt werden.

Modelle eines Schlüssels anzeigen

Klicken Sie bei einem Schlüssel auf die Modellanzahl, etwa 3 Modelle, um die Liste Modellzugriff des Schlüssels aufzuklappen. Jedes Modell zeigt seinen Namen und, falls abweichend, seine API-Modell-ID. Klicken Sie auf ein Modell, um seine ID für das Feld model Ihrer Anfragen zu kopieren. Ihre App kann mit dem Schlüssel auch GET /v1/models aufrufen. Die Antwort enthält nur die Modelle, die dieser Schlüssel nutzen darf. Siehe Modelle.

Schlüsselstatus

Warum ein Schlüssel inaktiv ist

Ein Schlüssel zeigt den Status Inaktiv, wenn etwas am Konto Ihrer Organisation API-Anfragen blockiert. Der Hinweis oben auf der Seite API nennt die Ursache und erklärt, wie Sie sie beheben. Unter Kontohinweise finden Sie alle Hinweise und die jeweils passenden Schritte. Schlüssel zeigen außerdem den Status Inaktiv, solange der API-Zugriff für Ihre Organisation eingerichtet wird. Der Hinweis lautet dann „Der API-Zugriff wird eingerichtet. Neue Schlüssel bleiben bis dahin inaktiv.“ Ein Schlüssel kann auch kurz den Status Inaktiv zeigen, während eine Änderung an Ihrem Konto übernommen wird. Bleibt ein Schlüssel Inaktiv und erklärt kein Hinweis den Grund, öffnen Sie die Registerkarte Abrechnung und prüfen Sie den Status unter API-Abrechnung. Solange ein Schlüssel Inaktiv ist, werden die Anfragen Ihrer App mit diesem Schlüssel abgelehnt. Je nach Ursache erhält Ihre App einen dieser Fehler:
  • 403 API_SUBSCRIPTION_INACTIVE: Ihr kostenpflichtiger Tarif oder Ihre API-Abrechnung ist nicht aktiv.
  • 403 API_SUBSCRIPTION_INACTIVE oder 402 API_PAYMENT_FAILED: Die Zahlung einer API-Rechnung ist fehlgeschlagen. Bei den meisten fehlgeschlagenen Zahlungen wird das API-Abonnement überfällig. Die API gibt dann 403 zurück. Siehe Wenn eine Zahlung fehlschlägt.
  • 503 API_ADMISSION_UNAVAILABLE: Der API-Zugriff für Ihre Organisation wird noch eingerichtet, eine Änderung an Ihrem Konto wird noch übernommen, oder Anfragen sind pausiert, während DeepMask die letzte Nutzung prüft. Unklare Ergebnisse, etwa Anbieterfehler oder abgebrochene Streams, pausieren Anfragen nur, wenn Ihre Organisation innerhalb von 24 Stunden mehr als 20 davon hat. Auch Nutzung, die DeepMask noch nicht verifizieren kann, pausiert möglicherweise Anfragen. Siehe Wann Anfragen pausiert werden.
  • 503 API_ACCOUNTING_REVIEW: Anfragen sind pausiert, während DeepMask die letzte Nutzung prüft, und die Anfrage war bereits in Bearbeitung, als die Pause begann.
  • 401 API_CREDENTIAL_INVALID: Das API-Konto Ihrer Organisation ist geschlossen.
Wie Sie mit diesen Fehlern umgehen, erfahren Sie unter Fehler und Wiederholungen. DeepMask widerruft Ihre Schlüssel nicht, solange sie inaktiv sind. Sie können sie aber weiterhin selbst widerrufen. Solange eine der Bedingungen unter Voraussetzungen nicht erfüllt ist, können Sie keine neuen Schlüssel erstellen. Während der API-Zugriff eingerichtet wird, können Sie trotzdem Schlüssel erstellen. Diese bleiben aber Inaktiv, bis die Einrichtung abgeschlossen ist.

Ausgabenlimit eines Schlüssels bearbeiten

Um das Limit eines Schlüssels hinzuzufügen, zu ändern oder zu entfernen, klicken Sie neben dem Schlüssel auf ⋮ und wählen Sie Ausgabenlimit bearbeiten. Die Schritte finden Sie unter Schlüssellimit hinzufügen, ändern oder entfernen.

Modelle eines Schlüssels ändern

Sie können nicht ändern, welche Modelle ein bestehender Schlüssel nutzen darf. Das bedeutet auch: Alle aktuellen Modelle übernimmt nie Modelle, die später zum Katalog hinzukommen. Um einer App andere Modelle zur Verfügung zu stellen, ersetzen Sie ihren Schlüssel:
1

Neuen Schlüssel erstellen

Klicken Sie auf Schlüssel erstellen und wählen Sie die Modelle aus, die die App benötigt.
2

App aktualisieren

Ersetzen Sie den alten Schlüssel im Secret-Manager oder in der Umgebung Ihrer App und stellen Sie die Änderung bereit.
3

Alten Schlüssel widerrufen

Sobald Ihre App mit dem neuen Schlüssel funktioniert, widerrufen Sie den alten.

Einen Schlüssel widerrufen

Widerrufen Sie einen Schlüssel, wenn eine App ihn nicht mehr benötigt, oder sofort, wenn der Schlüssel möglicherweise offengelegt wurde.
1

Aktionen des Schlüssels öffnen

Klicken Sie neben dem Schlüssel auf ⋮ und wählen Sie Widerrufen.
2

Widerruf bestätigen

Klicken Sie im Dialog Diesen Schlüssel widerrufen? auf Widerrufen. Anwendungen, die den Schlüssel verwenden, verlieren sofort den Zugriff. Dies kann nicht rückgängig gemacht werden.
DeepMask bestätigt den Widerruf mit „Schlüssel widerrufen“. Möglicherweise sehen Sie stattdessen „Der Schlüssel wird widerrufen. Aktualisieren Sie, um den Stand zu sehen.“ Dann hat der Schlüssel den Status Wird widerrufen, bis DeepMask den Vorgang abschließt. Klicken Sie auf Aktualisieren, um den Status neu zu laden. Sie können jeden Schlüssel jederzeit widerrufen, auch Schlüssel mit dem Status Inaktiv. Die Schlüsselliste bleibt verfügbar, selbst wenn Modelle, Protokolle oder Rechnungen nicht geladen werden können. So können Sie einen Schlüssel auch im Notfall widerrufen.

Widerrufene Schlüssel

Ein widerrufener Schlüssel wird in den Bereich Widerrufene Schlüssel unterhalb Ihrer Schlüsselliste verschoben. Der Bereich ist anfangs eingeklappt und zeigt, wie viele widerrufene Schlüssel Sie haben, etwa Widerrufene Schlüssel (1). Klicken Sie darauf, um ihn aufzuklappen. Sie sehen dann für jeden Schlüssel Namen, letzte Zeichen, Widerrufsdatum und Modellanzahl. Der Bereich listet bis zu 150 widerrufene Schlüssel auf, die zuletzt erstellten zuerst. Im Anfrageprotokoll erscheinen Anfragen, die mit einem widerrufenen Schlüssel gestellt wurden, weiterhin unter dem Namen dieses Schlüssels. Siehe Nutzung und Protokolle.

Bewährte Sicherheitspraktiken

  • Verwenden Sie einen Schlüssel pro App und Umgebung. Erstellen Sie zum Beispiel getrennte Schlüssel für „Produktionsdienst“ und „Staging“. Dann können Sie einen davon widerrufen, ohne die anderen zu beeinträchtigen. Das Anfrageprotokoll zeigt außerdem, welcher Schlüssel welche Anfrage gestellt hat. Die Limits Anfragen pro Minute, Tokens pro Minute und Gleichzeitige Anfragen Ihrer Organisation gelten für alle Schlüssel gemeinsam. Zusätzliche Schlüssel erhöhen sie daher nicht. Siehe Faire Nutzung.
  • Vergeben Sie aussagekräftige Namen. Schlüsselnamen müssen nicht eindeutig sein. Wählen Sie daher Namen, an denen Sie Ihre Schlüssel unterscheiden können.
  • Geben Sie nur die Modelle frei, die eine App benötigt. Verwenden Sie Modelle auswählen statt Alle aktuellen Modelle, wenn eine App nur wenige Modelle braucht.
  • Legen Sie ein Ausgabenlimit für den Schlüssel fest. Ein Limit begrenzt, was ein einzelner Schlüssel bei Missbrauch ausgeben kann.
  • Speichern Sie Schlüssel nicht im Code. Bewahren Sie Schlüssel in einem Secret-Manager oder in einer Umgebungsvariable wie DEEPMASK_API_KEY auf. Committen Sie niemals einen Schlüssel in die Versionsverwaltung.
  • Rufen Sie die API von Ihrem Server aus auf. Betten Sie einen Schlüssel niemals in den Code von Browser-, Mobil- oder Desktop-Apps ein. Dort kann ihn jeder auslesen.
  • Rotieren Sie Schlüssel regelmäßig. Erstellen Sie einen neuen Schlüssel, aktualisieren Sie Ihre App, prüfen Sie, ob sie funktioniert, und widerrufen Sie dann den alten Schlüssel.
  • Widerrufen Sie offengelegte Schlüssel sofort. Wenn ein Schlüssel möglicherweise offengelegt wurde, widerrufen Sie ihn zuerst. Erstellen Sie dann einen Ersatz und prüfen Sie das Anfrageprotokoll auf Anfragen, die Sie nicht zuordnen können.
  • Prüfen Sie, wer Administrator ist. Jeder Administrator der Organisation kann alle API-Schlüssel verwalten. Halten Sie die Liste Ihrer Administratoren aktuell. Siehe Team-Management.

Fehlerbehebung

Ihre Organisation benötigt einen aktiven kostenpflichtigen Tarif und eine aktive API-Abrechnung. Außerdem darf keine API-Rechnung mit fehlgeschlagener Zahlung offen sein, und es darf keine Nutzungsprüfung laufen. Prüfen Sie den Hinweis oben auf der Seite API. Die Schaltfläche Schlüssel erstellen bleibt deaktiviert, bis alle Voraussetzungen erfüllt sind. Zeigt der Dialog die Meldung „Active Chat and API subscriptions are required to create a key“, erfüllt Ihre Organisation die Voraussetzungen für neue Schlüssel derzeit nicht. Schließen Sie den Dialog, klicken Sie auf Aktualisieren und beheben Sie die Ursache, die der Hinweis nennt. Siehe Abrechnung.Schlüssel erstellen ist auch nicht verfügbar, wenn die Modellliste nicht geladen werden konnte. Erscheint oben auf der Seite ein Fehler, klicken Sie auf Erneut versuchen.
Diese Meldung bedeutet, dass Sie zuerst einen bestehenden Schlüssel widerrufen müssen. Ihre Organisation kann bis zu 50 Schlüssel haben, die nicht widerrufen sind. Schlüssel mit dem Status Ausstehend oder Wird widerrufen zählen mit. Widerrufen Sie einen Schlüssel, den Sie nicht mehr benötigen, und versuchen Sie es dann erneut. Siehe Kontolimits.
DeepMask konnte die Einrichtung des Schlüssels nicht abschließen und hat Ihnen den Schlüssel deshalb nicht angezeigt. Der fehlgeschlagene Schlüssel wird automatisch widerrufen. Klicken Sie auf Aktualisieren und erstellen Sie den Schlüssel dann erneut.
Diese Meldung bedeutet, dass in kurzer Zeit zu viele Änderungen vorgenommen wurden. Ihre Organisation kann auf der Seite API bis zu 20 Änderungen pro Minute vornehmen. Dieses Kontingent teilen sich alle Administratoren. Dazu zählen das Erstellen und Widerrufen von Schlüsseln, das Speichern von Limits, das Aktivieren, Beenden oder Behalten der API-Abrechnung sowie Klicks auf Aktualisieren. Das Ansehen der Seite zählt nicht. Warten Sie eine Minute und versuchen Sie es erneut. Siehe Kontolimits.
Der Schlüssel fehlt, ist falsch geschrieben oder wurde widerrufen. Prüfen Sie, ob die Anfrage genau einen Header Authorization: Bearer <key> sendet. Prüfen Sie dann, ob die letzten Zeichen des Schlüssels zu einem Schlüssel in Ihrer Liste passen, der weder den Status Ausstehend noch Wird widerrufen hat und nicht unter Widerrufene Schlüssel steht. Siehe Fehler und Wiederholungen.
Der Schlüssel darf das Modell in der Anfrage nicht nutzen. Klappen Sie auf der Registerkarte Schlüssel die Modelle des Schlüssels auf und kopieren Sie eine freigegebene Modell-ID. Um ein anderes Modell zu nutzen, erstellen Sie einen neuen Schlüssel, der es enthält.
Der Schlüssel hat sein eigenes Ausgabenlimit erreicht. Erhöhen oder entfernen Sie das Limit mit Ausgabenlimit bearbeiten, oder warten Sie auf die Rücksetzung um 00:00 UTC am 1. eines Monats. Ihre anderen Schlüssel funktionieren weiter. Siehe Ausgabenlimits.

Verwandte Seiten

Ausgabenlimits

Legen Sie das organisationsweite Limit und Limits für einzelne Schlüssel fest.

Nutzung und Protokolle

Erfahren Sie, welche Schlüssel Anfragen stellen und was diese Anfragen kosten.

Limits und faire Nutzung

Erfahren Sie, welche Raten-, Token- und Kontolimits für Ihre Schlüssel gelten.

Fehler und Wiederholungen

Behandeln Sie Authentifizierungs- und Zugriffsfehler in Ihrer App.