Wer die API nutzen kann
Um die API-Seite zu öffnen, klicken Sie unten in der Chat-Seitenleiste auf Ihren Namen, wählen Sie Benutzereinstellungen und klicken Sie in der Seitenleiste der Einstellungen auf API. Nur Administratoren der Organisation sehen API.
Schlüssel funktionieren nur, solange Ihre Organisation einen aktiven kostenpflichtigen Chat-Tarif hat und die API-Abrechnung aktiv ist. Schlägt die Zahlung einer API-Rechnung fehl, nimmt die API keine Anfragen mehr an, bis Sie die Rechnung bezahlt haben. Siehe Abrechnung.
Was Sie tun können
- Nachrichten können die Rollen
system,user,assistantundtoolverwenden. Verwenden Siesystemstattdeveloper. - In
system- unduser-Nachrichten kanncontentein String oder ein Array aus Content-Parts sein. Inassistant- undtool-Nachrichten musscontentein String sein. Eine Assistant-Nachricht mit Tool-Aufrufen darfnullalscontenthaben. Datei-, Audio- und Dokument-Parts lehnt die API ab. Die Regeln für jede Rolle finden Sie unter Nachrichten. - Bei sieben Modellen, darunter
gpt-4o, können Sie Bilder inuser-Nachrichten als Base64-Data-URLs senden. Die API lehnt Bildlinks ab und ruft sie nie ab. Die Modelle, Formate und Limits finden Sie unter Bildeingabe. - Die API akzeptiert eine feste Auswahl an Anfragefeldern. Dazu gehören die Sampling-Optionen
temperature,top_p,presence_penalty,frequency_penalty,seed,stopundn(nur mit dem Wert 1). Manche Modelle ignorieren einige dieser Optionen, ohne einen Fehler zurückzugeben. Siehe Optionen, die manche Modelle ignorieren. - Andere Felder wie
response_format,logprobsundreasoning_effortlehnt die API mit einem400-Fehler ab. Denselben Fehler erhalten Sie für einen Wert außerhalb des zulässigen Bereichs eines Felds, etwa fürnüber 1. Die unterstützten Felder und ihre Wertebereiche finden Sie unter Anfragetext. - Die Limits Anfragen pro Minute, Tokens pro Minute und Gleichzeitige Anfragen Ihrer Organisation gelten für alle Schlüssel zusammen. Administratoren sehen die aktuellen Werte unter API-Limits auf der Registerkarte Nutzung. Zusätzlich hat jeder Schlüssel eigene Limits für Anfragen pro Minute und für Anfragen in Bearbeitung. Anfragen, die ein Limit überschreiten, lehnt die API mit
429ab. Unter Limits und faire Nutzung finden Sie alle Limits und erfahren, wie die faire Nutzung funktioniert.
Nur diese beiden Endpunkte sind verfügbar. Embeddings, Bilderzeugung, Legacy-Completions, die Responses API und das Abrufen eines einzelnen Modells mit
client.models.retrieve() funktionieren nicht.Basis-URL und Authentifizierung
Senden Sie jede Anfrage anhttps://api.deepmask.io/v1. Sie können die URL unter Basis-URL oben auf der Einstellungsseite API kopieren.
Senden Sie Ihren Schlüssel im Header Authorization als Bearer <key>. Schlüssel beginnen mit sk-, gefolgt von 64 Hexadezimalzeichen. DeepMask zeigt den vollständigen Schlüssel nur einmal an, wenn Sie ihn erstellen.
Setzen Sie in den OpenAI-SDKs base_url (Python) bzw. baseURL (Node.js) auf https://api.deepmask.io/v1. Übergeben Sie Ihren Schlüssel als api_key bzw. apiKey. Das SDK sendet den Header dann automatisch.
Erste Schritte
Ein Administrator öffnet die Einstellungsseite API, klickt auf der Registerkarte Abrechnung auf API-Abrechnung aktivieren und schließt den Checkout ab. Der Checkout fragt nach einer Zahlungsmethode und einer Rechnungsadresse. Anschließend klickt der Administrator auf der Registerkarte Schlüssel auf Schlüssel erstellen. Schlüssel erstellen ist erst verfügbar, wenn die API-Abrechnung aktiv ist. Der Schnellstart führt Sie durch die Einrichtung und Ihre erste Anfrage mit cURL, Python und Node.js.Modelle und Hosting
Die API bietet Chat-Modelle von Anthropic, OpenAI, Mistral AI und weiteren Anbietern. Alle API-Modelle werden in der EU gehostet. Die Registerkarte Modelle zeigt den aktuellen Katalog. Jeder Schlüssel kann nur die Modelle nutzen, die ein Administrator für ihn freigegeben hat. Verwenden Sie als Wert fürmodel die API-Modell-ID, die auf der Registerkarte Modelle angezeigt wird, zum Beispiel gpt-4o. Fähigkeiten und Preise finden Sie unter Modelle.
Abrechnung im Überblick
- Getrennt vom Chat. Die API-Abrechnung ist ein eigenes Abonnement nach Verbrauch. Wenn Sie sie aktivieren, ändert sich Ihr Chat-Tarif nicht. Siehe Abrechnung.
- Bezahlung pro Token. Sie zahlen für die Tokens, die jede Anfrage verbraucht. Es gelten die auf der Registerkarte Modelle angezeigten Preise pro 1 Mio. Tokens. Diese Preise enthalten die Gebühr von 3 % bereits, aber keine USt. Siehe So funktionieren die Preise.
- Monatliche Rechnung. Ihre monatliche Rechnung enthält die Modellkosten plus 3 % Gebühr, zzgl. USt., falls zutreffend. Siehe Was Sie bezahlen.
- Fehlgeschlagene Anfragen. Anfragen, die DeepMask oder der Modellanbieter ablehnt, werden nicht abgerechnet. Eine Anfrage mit unklarem Ergebnis, etwa nach einem Timeout beim Anbieter, wird nur abgerechnet, wenn später noch Nutzung dafür eintrifft. Siehe Werden fehlgeschlagene Anfragen abgerechnet?.
- Ausgabenlimits. Das Gateway-Ausgabenlimit ist das organisationsweite monatliche Limit für alle Schlüssel zusammen. Zusätzlich kann jeder Schlüssel ein eigenes, optionales Limit haben. Siehe Ausgabenlimits.
API-Dokumentation erkunden
Schnellstart
Aktivieren Sie die Abrechnung, erstellen Sie einen Schlüssel und senden Sie Ihre erste Anfrage.
API-Schlüssel
Erstellen, prüfen und widerrufen Sie Schlüssel und legen Sie ihre Modelle fest.
Ausgabenlimits
Begrenzen Sie die monatlichen Ausgaben Ihrer Organisation und jedes einzelnen Schlüssels.
Nutzung und Protokolle
Verfolgen Sie die monatlichen Kosten, prüfen Sie Anfragen und exportieren Sie eine CSV-Datei.
Abrechnung
Verwalten Sie die API-Abrechnung, Ihre Rechnungen und die Kündigung.
Modelle
Sehen Sie sich API-Modelle und Modell-IDs an und erfahren Sie, wie die Preise funktionieren.
Chat Completions
Anfrageformat, Bildeingabe, Streaming und Tool-Aufrufe.
Limits und faire Nutzung
Raten-, Token- und Budgetlimits sowie die Funktionsweise der fairen Nutzung.
Fehler und Wiederholungen
Fehlercodes, Wiederholungen und ob fehlgeschlagene Anfragen abgerechnet werden.