如需查看完整的文档索引,请参阅 llms.txt。在文档页面的 URL 末尾加上 .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);