Zum Hauptinhalt springen
Diese Anleitung führt Sie Schritt für Schritt zu Ihrer ersten erfolgreichen Anfrage, auch wenn Sie noch keinen API-Zugriff haben. Sie aktivieren die API-Abrechnung für Ihre Organisation, erstellen einen Schlüssel und rufen ein Modell mit cURL, Python oder Node.js auf. Die DeepMask API ist OpenAI-kompatibel. Sie können daher die offiziellen OpenAI-SDKs verwenden, indem Sie die Basis-URL und Ihren DeepMask-API-Schlüssel festlegen. Die API unterstützt Chat Completions (POST /v1/chat/completions) und das Auflisten von Modellen (GET /v1/models). Andere OpenAI-Endpunkte werden nicht unterstützt. Die Responses API (/v1/responses) gibt zum Beispiel 404 zurück.
Neu bei der DeepMask API? In der API-Übersicht erfahren Sie, was die API bietet und wie sie mit Ihrem Chat-Tarif zusammenhängt.

Voraussetzungen

Sie benötigen:
  • Administratorrechte in Ihrer Organisation. Nur Administratoren der Organisation sehen API in den Benutzereinstellungen. Wenn Sie Mitglied sind, bitten Sie einen Administrator, den Zugriff einzurichten. Informationen zu Rollen finden Sie unter Team-Management.
  • Einen aktiven kostenpflichtigen Tarif. Ihre Organisation benötigt einen aktiven Pro-, Power- oder Enterprise-Tarif. Der kostenlose Tarif, Testphasen und Tarife mit überfälliger Zahlung beinhalten keinen API-Zugriff.
  • Eine Zahlungsmethode für die API-Abrechnung. Die API wird getrennt von Ihrem Chat-Tarif abgerechnet. Im Checkout geben Sie daher eine Zahlungsmethode und eine Rechnungsadresse an.
  • Eine Möglichkeit, Anfragen zu senden. Verwenden Sie curl in einem macOS- oder Linux-Terminal oder das OpenAI-SDK für Python oder Node.js. Unter Windows führen Sie die cURL-Befehle in WSL oder Git Bash aus.
Wenn der Tarif Ihrer Organisation keinen API-Zugriff umfasst, zeigt die API-Seite den Hinweis „Für den API-Zugriff ist ein aktiver kostenpflichtiger Chat-Tarif erforderlich.“ Prüfen Sie Ihren Tarif über den Link Chat-Abrechnung in diesem Hinweis.

Zugriff einrichten und eine Testanfrage senden

1

API-Einstellungen öffnen

Klicken Sie unten in der Chat-Seitenleiste auf Ihren Namen und wählen Sie Benutzereinstellungen. Klicken Sie in der Seitenleiste der Einstellungen auf API.Die Seite zeigt die Basis-URL für alle Anfragen, https://api.deepmask.io/v1, mit einer Schaltfläche zum Kopieren. Darunter befinden sich die Registerkarten Schlüssel, Modelle, Nutzung und Abrechnung.
2

API-Abrechnung aktivieren

Solange die API-Abrechnung nicht aktiv ist, ist Schlüssel erstellen nicht verfügbar, und die Seite zeigt den Hinweis „Aktivieren Sie die API-Abrechnung, um Ihre Schlüssel zu nutzen.“Klicken Sie in diesem Hinweis auf API-Abrechnung aktivieren. Alternativ öffnen Sie die Registerkarte Abrechnung, auf der die Karte API-Abrechnung den Status Nicht aktiviert zeigt, und klicken dort auf API-Abrechnung aktivieren.DeepMask leitet Sie zu Stripe Checkout weiter. Fügen Sie eine Zahlungsmethode hinzu, prüfen Sie Ihre Rechnungsadresse und schließen Sie den Checkout ab. Sind für Ihre Organisation bereits ein Name und eine Rechnungsadresse hinterlegt, trägt der Checkout diese Angaben automatisch ein. Sie können außerdem eine Umsatzsteuer-Identifikationsnummer (USt-IdNr.) angeben. Diese Angabe ist optional. Die API-Abrechnung ist ein Abonnement nach Verbrauch: Ihre monatliche Rechnung enthält die Modellkosten plus 3 % Gebühr, zzgl. USt., falls zutreffend. Details finden Sie unter Abrechnung.
API-Einstellungsseite mit dem Hinweis „Aktivieren Sie die API-Abrechnung, um Ihre Schlüssel zu nutzen.“ und der Schaltfläche „API-Abrechnung aktivieren“, darunter die Basis-URL und eine leere Registerkarte „Schlüssel“.

Solange die API-Abrechnung nicht aktiviert ist, fordert Sie die API-Seite auf, sie zu aktivieren, bevor Sie Schlüssel erstellen können.

3

Prüfen, ob die Abrechnung aktiv ist

Nach dem Checkout kehren Sie zur API-Seite zurück, die sich automatisch aktualisiert. Öffnen Sie die Registerkarte Abrechnung und prüfen Sie, ob die Karte API-Abrechnung den Status Aktiv zeigt.Die Aktivierung kann einen Moment dauern. Hat sich der Status noch nicht geändert, warten Sie kurz und klicken Sie oben auf der Seite auf Aktualisieren.Wenn Sie den Checkout verlassen, ohne ihn abzuschließen, bleibt die API-Abrechnung im Status Nicht aktiviert. Klicken Sie auf API-Abrechnung aktivieren, um es erneut zu versuchen.
4

Ausgabenlimit prüfen (optional)

Auf der Registerkarte Abrechnung finden Sie das Gateway-Ausgabenlimit. Das ist das organisationsweite Limit, das für alle Ihre Schlüssel gemeinsam gilt. Es beträgt anfangs 100 € Modellkosten pro Monat, vor der Gebühr von 3 % und vor Steuern. Es wird um 00:00 UTC am 1. eines Monats zurückgesetzt.Um das Limit zu ändern, geben Sie einen Betrag bis zum Höchstwert ein, der unter dem Feld angezeigt wird, und klicken Sie auf Limit speichern. Sie können außerdem für jeden Schlüssel ein eigenes Limit festlegen. Mehr dazu unter Ausgabenlimits.
5

Schlüssel erstellen

Öffnen Sie die Registerkarte Schlüssel und klicken Sie auf Schlüssel erstellen. Gehen Sie im Dialog API-Schlüssel erstellen so vor:
  1. Geben Sie unter Schlüsselname einen Namen ein, der die App oder Umgebung beschreibt, zum Beispiel „Produktionsdienst“.
  2. Geben Sie optional unter Ausgabenlimit des Schlüssels (optional) einen monatlichen Betrag ein. Er darf das Gateway-Ausgabenlimit nicht übersteigen. Lassen Sie das Feld leer, wenn nur das Gateway-Ausgabenlimit gelten soll.
  3. Behalten Sie unter Modellzugriff die Option Modelle auswählen bei und wählen Sie die Modelle aus, die dieser Schlüssel verwenden darf. Die Modelle sind nach Anbieter gruppiert, und jede Gruppe ist zunächst eingeklappt. Für die Beispiele auf dieser Seite suchen Sie nach gpt-4o oder klappen OpenAI auf und wählen GPT-4o aus. Alternativ wählen Sie Alle aktuellen Modelle, um alle heute verfügbaren Modelle freizugeben. Später hinzugefügte Modelle sind nicht enthalten.
  4. Klicken Sie auf Schlüssel erstellen.
Die Modelle eines Schlüssels können Sie nach dem Erstellen nicht mehr ändern. Um andere Modelle freizugeben, erstellen Sie einen neuen Schlüssel. Mehr dazu unter API-Schlüssel.
6

Schlüssel speichern

Der Dialog API-Schlüssel speichern zeigt Ihren neuen Schlüssel. Klicken Sie auf Schlüssel kopieren und speichern Sie ihn an einem sicheren Ort, etwa in Ihrem Secret-Manager oder in einer Umgebungsvariablen.
DeepMask zeigt den vollständigen Schlüssel nur ein einziges Mal. Wenn Sie den Dialog schließen, die Seite neu laden oder die Organisation wechseln, bevor Sie den Schlüssel kopiert haben, können Sie ihn nicht mehr abrufen. Haben Sie ihn verloren, widerrufen Sie den Schlüssel und erstellen Sie einen neuen.
7

Schlüssel testen

Klappen Sie den Bereich Schlüssel testen auf, bevor Sie den Dialog schließen. Setzen Sie die Umgebungsvariable DEEPMASK_API_KEY auf Ihren Schlüssel:
Damit der Schlüssel nicht in Ihrem Shell-Verlauf landet, führen Sie stattdessen read -rs DEEPMASK_API_KEY && export DEEPMASK_API_KEY aus. Fügen Sie dann den Schlüssel ein und drücken Sie die Eingabetaste.Klicken Sie auf Befehl kopieren, fügen Sie den Befehl in dasselbe Terminal ein und führen Sie ihn aus. Der Befehl sendet „Hello“ an eines der Modelle des Schlüssels. Gibt der Befehl eine JSON-Antwort mit einer Nachricht des Modells zurück, funktioniert Ihr Schlüssel. Testanfragen werden wie jede andere Anfrage abgerechnet.Wenn Sie fertig sind, klicken Sie auf Ich habe ihn gespeichert, um den Dialog zu schließen.
Dialog „API-Schlüssel speichern“ mit dem Schlüssel in einem schreibgeschützten Feld, der Schaltfläche „Schlüssel kopieren“, der Warnung „Einmalig sichtbar“, dem aufgeklappten Bereich „Schlüssel testen“ mit einem cURL-Befehl und der Schaltfläche „Befehl kopieren“ sowie der Schaltfläche „Ich habe ihn gespeichert“.

Kopieren Sie Ihren Schlüssel, bevor Sie den Dialog schließen, und testen Sie ihn dann mit dem vorbereiteten Befehl.

Verwenden Sie Ihren Schlüssel nur auf Ihrem Server. Lesen Sie ihn aus einer Umgebungsvariablen oder einem Secret-Manager und legen Sie ihn nie in Browsercode, mobilen Apps oder der Versionsverwaltung ab.

Ihre erste Anfrage senden

Senden Sie eine Chat-Completion-Anfrage an POST /v1/chat/completions. Jedes Beispiel liest Ihren Schlüssel aus DEEPMASK_API_KEY und verwendet gpt-4o. Für ein anderes Modell kopieren Sie dessen API-Modell-ID auf der Registerkarte Modelle und stellen sicher, dass Ihr Schlüssel das Modell verwenden darf. Installieren Sie für die SDK-Beispiele das offizielle Paket openai:
  • Python: Führen Sie pip install openai aus. Speichern Sie das Beispiel als quickstart.py und führen Sie python quickstart.py aus.
  • Node.js: Führen Sie npm install openai aus. Speichern Sie das Beispiel im selben Ordner als quickstart.mjs und führen Sie node quickstart.mjs aus. Dank der Endung .mjs kann die Datei import und Top-Level-await verwenden.
Führen Sie die Beispiele in demselben Terminal aus, in dem Sie DEEPMASK_API_KEY gesetzt haben. In Windows PowerShell setzen Sie die Variable stattdessen mit $env:DEEPMASK_API_KEY = "sk-...".
Die API akzeptiert eine feste Auswahl an Anfragefeldern. max_tokens aus den Beispielen oben gehört dazu. Sampling-Optionen wie temperature, top_p, stop und seed werden innerhalb ihrer Wertebereiche akzeptiert. Manche Modelle ignorieren einige dieser Optionen ohne Fehlermeldung. Manche Modelle lehnen bestimmte Werte ab, zum Beispiel eine temperature über 1. Andere Parameter wie response_format und logprobs werden mit dem Fehler 400 und dem Code API_REQUEST_UNBOUNDED abgelehnt. Das gilt auch für einen Wert von n ungleich 1. Prüfen Sie Sampling-Optionen und Nicht unterstützte Parameter, bevor Sie Optionen hinzufügen.

Die Antwort auswerten

Eine erfolgreiche Anfrage gibt HTTP 200 mit einem Standard-Chat-Completion-Objekt zurück. Das folgende Beispiel ist gekürzt. Ihre Werte sehen anders aus:
  • choices[0].message.content enthält die Antwort des Modells.
  • usage zeigt die Eingabe- und Ausgabe-Tokens der Anfrage. Anfragen werden nach Tokens abgerechnet. Wie die Preise funktionieren, erfahren Sie unter Modelle.
Ihre Anfrage erscheint außerdem im Anfrageprotokoll auf der Registerkarte Nutzung. Wenn Sie sie noch nicht sehen, klicken Sie oben auf der Seite auf Aktualisieren. Mehr dazu unter Nutzung und Protokolle. Um die Antwort schon in Teilen zu erhalten, während das Modell sie schreibt, setzen Sie stream auf true. Streaming, Tools und alle unterstützten Felder sind unter Chat Completions beschrieben.

Wenn Ihre erste Anfrage fehlschlägt

Bei jedem Fehler gibt die API einen JSON-Body zurück, dessen Feld error.code das Problem benennt, zum Beispiel API_MODEL_NOT_ALLOWED. Der Text in error.message ist immer derselbe. Prüfen Sie daher den HTTP-Status und error.code. Den vollständigen Body finden Sie unter Format der Fehlerantwort. Welche Modelle Ihr Schlüssel verwenden darf, erfahren Sie mit GET /v1/models. Der Aufruf gibt nur die Modelle zurück, die für diesen Schlüssel freigegeben sind:
Alle weiteren Codes, auch Ablehnungen wegen eines Ausgabenlimits, finden Sie unter Fehler und Wiederholungen. Alle Limits finden Sie unter Limits und faire Nutzung.

Nächste Schritte

API-Schlüssel verwalten

Erstellen Sie Schlüssel pro App oder Umgebung, prüfen Sie ihren Status und widerrufen Sie Schlüssel, die Sie nicht mehr benötigen.

Ausgabenlimits festlegen

Steuern Sie die monatlichen Modellkosten mit dem organisationsweiten Limit und optionalen Limits pro Schlüssel.

Referenz zu Chat Completions

Lernen Sie die unterstützten Anfragefelder, Streaming, Tool-Aufrufe und das Antwortformat kennen.

Modelle und Preise

Durchsuchen Sie die API-Modelle, finden Sie ihre Modell-IDs und erfahren Sie, wie die Preise pro Token funktionieren.

Limits und faire Nutzung

Prüfen Sie die Raten-, Token- und Budgetlimits, die für Ihre Anfragen gelten.

Fehler und Wiederholungen

Erfahren Sie, was Fehlercodes bedeuten, welche Fehler Sie wiederholen sollten und wie Sie mit abgelehnten Anfragen umgehen.

Nutzung und Protokolle

Verfolgen Sie die monatlichen Kosten, prüfen Sie Ihre API-Limits und sehen Sie sich Ihre Anfragen an.

Abrechnung

Erfahren Sie, wie sich Ihre monatliche API-Rechnung zusammensetzt, rufen Sie Rechnungen ab und beenden Sie bei Bedarf die API-Abrechnung.