大模型应用开发 / 知识点

OpenAI API 开发速查手册

手册条目

CODE
GET /v1/models
Authorization: Bearer <OPENAI_API_KEY>
OpenAI-Project: <PROJECT_ID>

创建项目 API 密钥并确认密钥所属项目与可用权限。

创建项目 API 密钥

用于为指定 OpenAI API 项目创建独立凭据,并在投入开发前确认项目归属、密钥权限和认证是否正常。密钥只会完整显示一次,创建后应立即保存到受控的密码库或密钥管理服务。

创建前确认

先在 API Platform 左上角确认组织,再选择目标项目。开发、测试和生产应使用不同项目与不同密钥,避免用量、权限和故障相互影响。

创建者需要拥有目标项目的密钥管理权限。供个人调试时可创建用户密钥;供服务器、CI/CD 或多人维护的生产应用使用时,优先由项目所有者创建服务账户密钥,避免凭据绑定某个员工账号。

创建步骤

  1. 进入目标项目的设置页,打开 API Keys。
  2. 选择 Create new secret key,填写能识别环境和用途的名称,例如 payhub-dev-local。
  3. 用户密钥按实际调用范围选择权限:All 为全部权限,Restricted 可按资源设置读写范围,Read Only 只允许读取。生产环境优先选择 Restricted。
  4. 创建后立即复制完整密钥并保存。关闭弹窗后无法再次查看原值,遗失时只能创建新密钥并替换旧密钥。

OpenAI 项目 API 密钥创建位置

验证密钥与项目

下面命令在当前 Bash 会话中安全读取密钥,并显式指定项目。<PROJECT_ID> 替换为项目设置中的真实 ID;终端输入密钥时不会回显。

bash
read -rsp "OpenAI API key: " OPENAI_API_KEY
echo
export OPENAI_API_KEY
export OPENAI_PROJECT_ID="<PROJECT_ID>"

curl -i -sS https://api.openai.com/v1/models \
  -H "Authorization: Bearer $OPENAI_API_KEY" \
  -H "OpenAI-Project: $OPENAI_PROJECT_ID"

unset OPENAI_API_KEY

预期输出

text
HTTP/2 200
content-type: application/json
...
{"object":"list","data":[...]}

模型列表和响应头会随账号权限变化。返回 200 表示密钥有效且能够访问指定项目;401 通常表示密钥错误、已撤销或请求未携带密钥;403 通常表示当前密钥或项目权限不足。

风险与边界

密钥写入源码、聊天记录、工单、浏览器前端或移动 App 时,任何能读取这些内容的人都可能冒用配额,造成异常扣费或数据风险。安全替代方案是让客户端请求自己的后端,由后端从环境变量或密钥管理服务读取密钥。

误选项目会让用量记入错误项目,并可能因模型、工具或接口权限不同而出现 403。创建前确认项目,调用时在多组织或旧用户密钥场景显式传递 OpenAI-Organization 和 OpenAI-Project 请求头。

密钥疑似泄露时不要只修改代码,应立即在控制台撤销旧密钥、创建新密钥、更新部署配置,并检查项目用量。生产环境不要多人共用同一用户密钥,应使用独立服务账户或每人独立密钥,便于审计和轮换。

目录与阅读设置

记录一个想法

OpenAI API 开发速查手册

0 / 10000 · 笔记保存到账号。未提交的修改会在关闭、离开或刷新后丢失。

登录哪都通