认证与 API Key

创建 Key

在 API 中心 创建 sk_ API Key。完整密钥只在创建或轮换成功时显示一次。

每个应用、环境和自动化任务使用独立 Key，便于单独设置预算、停用、轮换和审计。

发送凭据

推荐使用：

X-API-Key: sk_your_key

也支持标准 Bearer 形式：

Authorization: Bearer sk_your_key

一次请求只发送一种形式。

curl https://omnidoc.top/api/v1/jobs \
  -H "X-API-Key: $OMNIDOC_API_KEY"

Key 代表什么

Key 代表创建它的账号，可调用该账号有权使用的服务，只能访问该账号自己的资源。Key 不能修改登录邮箱、密码、手机号和个人资料，也不能创建、轮换或撤销 API Key。

可选限制：

• allowed_engines：只允许指定的翻译配置（也限制 /v1 兼容接口可用的模型）；空数组表示不增加 Key 级限制。
• expires_at：到期时间。
• quota_limit：Key 的生命周期预算，单位为整数毫积分；0 表示不设置 Key 级预算，账号积分仍照常结算。

轮换与撤销

在 API 中心 创建、修改限制、轮换或撤销 Key。Key 被撤销、停用、过期，或所属账号停用后，新的请求立即失败。

轮换会生成新密钥并立即停用旧密钥；新 Key 沿用原有限制和已用预算。已过期的 Key 不能轮换，请新建。需要平滑切换时，先新建一个 Key 并部署，确认调用成功后再撤销旧 Key。

安全要求

• 只在服务端或受控运行环境保存 Key。
• 使用环境变量或密钥管理服务，不写入源码、日志、浏览器包或公开仓库。
• 不把 Key 发送到 API 响应返回的上传或下载地址。
• 记录 Key ID、请求 ID 和业务操作 ID；不要记录完整 Key。
• 泄露后立即轮换，并核对该 Key 的任务和结算操作。