如需完整的文件索引,請參閱 llms.txt。在文件頁面的網址末尾加上 .md ,即可取得該頁面的 Markdown 版本。
主要導覽
主題

管理 API

透過程式管理組織資源與行政作業流程。

透過管理 API,你可以自動執行組織管理工作,包括邀請使用者、檢閱稽核記錄、管理專案與 API 金鑰、設定支出上限與警示,以及管理資料保留與速率限制。這些 API 適合用於後台作業自動化、安全性工作流程,以及需要在儀表板以外執行的維運工具。

若想瞭解管理憑證、使用者擁有的專案金鑰,以及工作負載使用的服務帳戶有何不同,請參閱 API 金鑰與服務帳戶。

如需各端點的詳細資訊,請參閱管理 API 參考文件,其中涵蓋管理 API 金鑰、邀請、使用者、專案、支出上限與稽核記錄。

在 SDK 中使用管理 API 金鑰

如要存取這些端點,請先建立管理 API 金鑰。管理 API 金鑰僅能用於管理端點。

各 SDK 從下列版本開始支援管理 API。如果你使用較舊的版本,可能需要更新 SDK。

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

先設定 OPENAI_ADMIN_KEY,再初始化所用程式語言的 SDK。

使用管理 API 金鑰設定 SDK
import OpenAI from "openai";

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

限制專案可存取的模型

透過專案的模型權限設定,你可以指定允許清單或封鎖清單。將 mode 設為 allow_list,專案就只能使用清單中的模型。將 mode 設為 deny_list,則會封鎖清單中的模型,其他可用模型仍可使用。清單中的模型 ID 必須對組織可見,也可以是組織可見的微調模型快照 ID。

設定專案的模型允許清單或封鎖清單
const modelPermissions =
  await client.admin.organization.projects.modelPermissions.update("proj_abc", {
    mode: "allow_list",
    model_ids: ["gpt-4.1", "o3"],
  });

console.log(modelPermissions.mode);

設定組織支出上限

使用支出上限端點建立或取代組織每月的強制支出上限。設定 threshold_amount 時,金額以美分為單位。下列範例將每月上限設為 100 美元:

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"
  }'

當系統追蹤的支出達到強制上限時,受影響的 API 請求會傳回 429 錯誤。詳情請參閱支出上限指南。

管理支出上限警示

你可以設定專案支出警示,在專案支出達到門檻時通知團隊。門檻金額以美分為單位。

建立專案支出上限警示
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);

管理資料保留設定

透過專案的資料保留設定,你可以為個別專案覆寫或沿用組織的保留政策。如要沿用組織設定,請將 retention_type 設為 organization_default。

設定專案的資料保留政策
const dataRetention =
  await client.admin.organization.projects.dataRetention.update("proj_abc", {
    retention_type: "organization_default",
  });

console.log(dataRetention.type);

透過電子郵件邀請使用者

使用邀請端點,將加入組織的邀請寄到使用者的電子郵件地址。

透過電子郵件邀請使用者
const invite = await client.admin.organization.invites.create({
  email: "user@example.com",
  role: "reader",
});

console.log(invite.id);

擷取稽核記錄

使用稽核記錄端點,列出組織近期的使用者操作與設定變更。

擷取稽核記錄
const auditLogs = await client.admin.organization.auditLogs.list({
  limit: 10,
});

console.log(auditLogs.data);