API Keys
API Key 是应用通过 OneGateway 调用模型时的身份凭证。在 API Keys 页面创建和管理你自己的密钥,列表中只显示属于你的密钥。
页面顶部的 API 地址 是应用请求要指向的服务地址,点击右侧图标复制。按应用使用的接口格式(OpenAI、Anthropic 等)配置 API 地址和 API Key 即可开始调用,完整的请求示例见快速开始。
创建 API Key
点击右上角 新建 API Key,填写 名称 后点击 确定 即可创建。名称用于区分用途,例如“Chatbox 密钥”。
这样创建的 API Key 不限额度、不过期、使用你的分组定价、可以调用全部可用模型。需要施加限制时,打开 高级设置:
| 字段 | 作用 | 留空时 |
|---|---|---|
| 配额 | 这个 API Key 最多可以消耗的金额 | 不限额度 |
| 过期时间 | 到达该时间后密钥自动失效 | 永不过期 |
| 分组定价 | 决定调用的计费倍率 | 使用你的分组定价 |
| 可用模型 | 限定这个密钥只能调用哪些模型 | 全部可用模型 |
分组定价和可用模型的可选范围由管理员配置,你能调用的模型见可用模型。
使用 og-auto 等虚拟模型时
限定了可用模型的密钥,按智能路由改写后的实际模型校验。只勾选虚拟模型名没有用,要把它可能用到的每个目标模型和候选模型都加进可用模型,否则请求返回 403,且不会切换到候选模型。可能用到哪些模型请向管理员确认。
创建后,密钥在卡片上以脱敏形式展示。点击密钥右侧的复制图标获取完整内容,粘贴到应用中保存。
管理已有的 API Keys
每张卡片对应一个 API Key。
| 卡片内容 | 说明 |
|---|---|
| 名称与分组定价 | 密钥名称,以及它使用的分组定价 |
| 额度 | 未设置配额时显示「无限额度」;设置过配额时显示剩余额度、已用额度和使用比例 |
| 状态开关 | 控制这个密钥能否调用;关闭后确认配置同步,并验证旧密钥的请求已被拒绝 |
| 可用模型 | 未做限制时显示「全部模型」 |
| 过期时间 | 显示到期日期或「永不过期」,已过期的会标记出来 |
| 密钥 | 脱敏显示,点击右侧图标复制完整密钥 |
卡片右上角有三个按钮,分别用于 编辑、查看用量 和 删除。
密钥疑似泄漏时先关闭,不要直接删除
先关闭状态开关,保留这个密钥的历史记录,确认配置同步和拒绝调用的结果。启用语义缓存时,还需分别验证缓存命中与上游转发路径,见停用访问的核验步骤。确认不再需要后再删除;删除无法恢复,会影响正在使用它的应用。
修改限制
点击卡片上的编辑按钮进入详情页,修改后点击右上角 更新。
| 区域 | 可以修改的内容 |
|---|---|
| 基础信息 | 名称和分组定价可以修改;部门、用户、状态、密钥和创建时间由系统维护,不能修改 |
| 配额与有效期 | 勾选 无限额度,或填写具体配额并设置过期时间。旁边的快捷设置提供 永不过期、一小时、一天、一个月 |
| 访问限制 | 调整 可用模型;在 IP 限制 中每行填写一个允许访问的地址,留空表示不限制 |
修改分组定价或可用模型后,用这个密钥发起一次调用,在日志中确认实际使用的模型和费用符合预期。