Den vollständigen Index der Dokumentation findest du in llms.txt. Die Markdown-Version einer Dokumentationsseite erhältst du, indem du .md an die URL der Seite anhängst.
Hauptnavigation
Design

Admin-APIs

Verwalte die Ressourcen und Verwaltungsabläufe deiner Organisation per API.

Mit den Admin-APIs kannst du Verwaltungsaufgaben in deiner Organisation automatisieren. Du kannst Personen einladen, Auditprotokolle prüfen, Projekte und API-Schlüssel verwalten, Ausgabenlimits und Benachrichtigungen festlegen sowie die Datenaufbewahrung und Ratenlimits steuern. Nutze die APIs für automatisierte Backoffice-Prozesse, Sicherheitsabläufe und Betriebstools, die außerhalb des Dashboards laufen sollen.

Im Leitfaden API-Schlüssel und Dienstkonten erfährst du, wie sich Zugangsdaten für Verwaltungsaufgaben, der persönliche Projektschlüssel einer Person und das Dienstkonto eines Workloads voneinander unterscheiden.

Einzelheiten zu den Endpunkten findest du in der Referenz zur Verwaltungs-API. Sie umfasst unter anderem Admin-API-Schlüssel, Einladungen, Nutzende, Projekte, Ausgabenlimits und Auditprotokolle.

Einen Admin-API-Schlüssel mit dem SDK verwenden

Um auf diese Endpunkte zuzugreifen, erstelle einen Admin-API-Schlüssel. Admin-API-Schlüssel funktionieren ausschließlich mit Verwaltungsendpunkten.

Die SDKs unterstützen Admin-APIs ab den folgenden Versionen. Möglicherweise musst du dein SDK aktualisieren.

  • Node: 6.36.0
  • Python: 2.34.0
  • Go: 3.34.0
  • Ruby: 0.61.0
  • Java: 4.34.0

Setze OPENAI_ADMIN_KEY und initialisiere anschließend das SDK für deine Programmiersprache.

Das SDK mit einem Admin-API-Schlüssel einrichten
import OpenAI from "openai";

const client = new OpenAI({
  adminAPIKey: process.env.OPENAI_ADMIN_KEY,
});

Modellzugriff für Projekte einschränken

Über die Modellberechtigungen eines Projekts kannst du eine Liste zulässiger oder gesperrter Modelle festlegen. Setze mode auf allow_list, um nur die aufgeführten Modelle zuzulassen. Setze mode auf deny_list, um die aufgeführten Modelle zu sperren und alle anderen verfügbaren Modelle zuzulassen. Die Modell-IDs müssen für die Organisation sichtbar sein. Das gilt auch für Snapshots feinabgestimmter Modelle.

Zulässige oder gesperrte Modelle für ein Projekt festlegen
const modelPermissions =
  await client.admin.organization.projects.modelPermissions.update("proj_abc", {
    mode: "allow_list",
    model_ids: ["gpt-4.1", "o3"],
  });

console.log(modelPermissions.mode);

Ein Ausgabenlimit für die Organisation festlegen

Über den Endpunkt für Ausgabenlimits kannst du eine feste monatliche Ausgabenobergrenze für deine Organisation festlegen oder die bestehende ersetzen. Gib threshold_amount in Cent an. Das folgende Beispiel legt ein monatliches Limit von 100 USD fest.

curl -X POST https://api.openai.com/v1/organization/spend_limit \
  -H "Authorization: Bearer $OPENAI_ADMIN_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "threshold_amount": 10000,
    "currency": "USD",
    "interval": "month"
  }'

Sobald die erfassten Ausgaben die feste Obergrenze erreichen, gibt die API bei betroffenen Anfragen den Fehlercode 429 zurück. Weitere Informationen findest du im Leitfaden zu Ausgabenlimits.

Benachrichtigungen zu Ausgabenlimits verwalten

Richte für ein Projekt Benachrichtigungen ein, damit dein Team erfährt, wenn die Projektausgaben einen Schwellenwert erreichen. Gib die Schwellenwerte in Cent an.

Eine Benachrichtigung zum Ausgabenlimit eines Projekts erstellen
const spendAlert = await client.admin.organization.projects.spendAlerts.create(
  "proj_abc",
  {
    currency: "USD",
    interval: "month",
    notification_channel: {
      recipients: ["billing@example.com"],
      type: "email",
      subject_prefix: "OpenAI spend",
    },
    threshold_amount: 50000,
  }
);

console.log(spendAlert.id);

Datenaufbewahrung verwalten

In den Einstellungen zur Datenaufbewahrung kannst du die Aufbewahrungsrichtlinie der Organisation für ein Projekt überschreiben oder übernehmen. Setze retention_type auf organization_default, um die Einstellung der Organisation zu übernehmen.

Datenaufbewahrung für ein Projekt festlegen
const dataRetention =
  await client.admin.organization.projects.dataRetention.update("proj_abc", {
    retention_type: "organization_default",
  });

console.log(dataRetention.type);

Eine Person per E-Mail einladen

Über den Endpunkt für Einladungen kannst du eine Einladung zum Beitritt zu deiner Organisation an eine E-Mail-Adresse senden.

Eine Person per E-Mail einladen
const invite = await client.admin.organization.invites.create({
  email: "user@example.com",
  role: "reader",
});

console.log(invite.id);

Auditprotokolle abrufen

Über den Endpunkt für Auditprotokolle kannst du auflisten, welche Aktionen Nutzende zuletzt in der Organisation ausgeführt haben und welche Konfigurationsänderungen es dort gab.

Auditprotokolle abrufen
const auditLogs = await client.admin.organization.auditLogs.list({
  limit: 10,
});

console.log(auditLogs.data);