身份验证

CheaperGen API 使用私密 API 密钥。向需要身份验证的端点发送请求时，请在每个请求的 Authorization 标头中将密钥作为 Bearer 令牌传入：

Authorization: Bearer cg_live_xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx

创建密钥#

打开 控制面板 → API 密钥 并点击 创建密钥。请根据使用场景命名，例如 production-backend。密钥格式为 cg_live_ 后接 32 个随机字符。

创建密钥时，完整密钥只会显示 一次。我们只保存密钥的 SHA-256 哈希，因此无法再次显示。如果你丢失密钥，请撤销后重新创建。控制面板会显示每个密钥的前缀、创建日期和最近使用时间。

发送经过身份验证的请求#

const resp = await fetch("https://cheapergen.com/api/v1/account", {
  headers: { Authorization: `Bearer ${process.env.CHEAPERGEN_API_KEY}` },
});
console.log(await resp.json());

import os, requests

resp = requests.get(
    "https://cheapergen.com/api/v1/account",
    headers={"Authorization": f"Bearer {os.environ['CHEAPERGEN_API_KEY']}"},
)
print(resp.json())

curl https://cheapergen.com/api/v1/account \
  -H "Authorization: Bearer $CHEAPERGEN_API_KEY"

公开端点#

目录和定价端点（GET /api/v1/models、GET /api/v1/models/{vendor}/{model} 和 POST /api/v1/quote/{endpoint}）无需密钥，因此可从浏览器或构建步骤中调用。其他操作——提交、读取和取消生成任务、上传文件及访问账户信息——均需要密钥。完整列表请参阅 API 参考文档。

妥善保管密钥#

• 仅在服务器端使用。 切勿将密钥打包进移动应用、浏览器代码包或公开代码仓库。任何持有密钥的人都可以使用你的余额。
• 使用环境变量，或使用密钥管理器保存密钥。不要将密钥写入源代码。本文档中的示例从 CHEAPERGEN_API_KEY 读取。
• 每个环境或服务使用单独的密钥，这样撤销一个密钥时不会影响其他密钥。
• 轮换密钥时，先创建并部署新密钥，再撤销旧密钥。撤销会立即生效。

在开发客户端应用？#

请通过你自己的后端转发请求：由服务器保管密钥、验证用户身份并转发生成请求。使用 webhooks，在任务完成后收到通知并将结果推送给用户。

身份验证错误#

密钥缺失、格式错误或已撤销时，接口会返回 401 unauthorized：

{
  "error": {
    "code": "unauthorized",
    "message": "Invalid or revoked API key"
  }
}

通过我们网站（Studio 和模型页面中的 Playground）提交的请求会使用已登录会话进行身份验证，无需 API 密钥；这些请求会显示在控制面板中，并标记来源为 playground。