OminiApi 文档

API 密钥

创建、配置、轮换和撤销 API Key

OminiApi Team快速开始约 8 分钟

控制台左侧「API 服务 → API 密钥」管理你的所有密钥,页面标题为「密钥管理」。

密钥管理列表
密钥管理列表
密钥管理列表

创建密钥

点击「创建密钥」,打开「创建 LLM 调用密钥」。常用选项在上方,更多选项折叠在「高级设置」里。

创建 LLM 调用密钥
创建 LLM 调用密钥
创建 LLM 调用密钥

基本设置

字段说明
密钥名称必填,建议按用途命名,例如 prod-app、ci-pipeline
到期时间永不过期(默认)/ 7 天 / 30 天 / 90 天 / 自定义日期(到当天结束时失效)
密钥归属个人密钥 / 组织密钥,创建后不能修改。组织密钥见 组织密钥与限额

供应商分组与路由

决定这个密钥的请求走哪些 分组:

  • 价格区间(默认):设置「可接受倍率区间」(最小倍率 ~ 最大倍率),倍率落在区间内的分组都可以使用。
  • 指定分组:手动选择分组并排序。

智能路由开启时,可以选择策略:

策略适合场景
智能均衡(默认)综合价格、速度和成功率
价格优先尽量走便宜的分组
速度优先尽量走响应快的分组
成功率优先尽量走最稳定的分组

关闭智能路由时,「价格区间」模式按价格从低到高尝试,「指定分组」模式按你排的顺序尝试。

「模型路由预览」可以输入一个模型名,看它会依次走哪些分组。

高级设置

字段说明
扣费偏好自动扣费(默认,优先套餐、再用余额)/ 仅使用余额 / 指定套餐,见 套餐和余额怎么配合
模型白名单默认「全部」;选定后只能调用列表里的模型
IP 白名单填写 IP 或 CIDR(支持 IPv6),留空表示不限
额度规则并发会话数、5 小时额度、单日额度、单周额度、单月额度、总额度(美元),不填即为无限额度
上游请求隐私过滤默认开启,过滤身份相关的请求头与元数据,用会话内稳定的匿名标识替代真实身份

设置了「总额度」的密钥,额度用完后会返回 token exhausted,需要调高额度或新建密钥。单日额度在每天 00:00 重置,5 小时额度按滚动窗口计算。

保存密钥

创建成功后会显示完整密钥,格式为 sk- 开头的 47 位字符串。

完整密钥只能复制这一次

平台只保存密钥的哈希值,完整密钥无法再次查看。刷新或离开页面前,你还可以在详情里再次复制;之后只能看到前 6 位和后 4 位。忘记了就只能「轮换密钥」签发新的。

注册时系统自动创建的密钥名为 Default API key,同样只在注册完成时显示一次。

管理密钥

列表可以按名称或前缀搜索,按状态(当前可用 / 未启用 / 已撤销)筛选,按创建时间或最近使用排序。每行会显示今日请求数和今日扣费。

点击密钥打开详情,有「概览」「用量」「设置」三个标签页。「用量」里可以看到总调用、总消耗、近 30 天调用量,以及各项额度规则的用量进度。

操作效果
停用 / 重新启用停用期间使用该密钥的请求都会失败(token disabled),可随时重新启用
轮换密钥旧密钥立即失效,签发一个新密钥(只显示一次),其他设置不变
撤销密钥密钥永久失效,历史记录保留,不能恢复
查看调用日志查看该密钥的近期调用记录
在 CC Switch 中打开一键导入到 CC Switch,见 CC Switch 配置

数量限制

  • 每个用户最多 100 个未撤销的密钥。
  • 每人在每个组织最多 5 个组织密钥。

密钥状态

状态含义
当前可用正常使用中
已过期超过到期时间
已禁用被你或管理员停用
已耗尽总额度已用完
已撤销已永久失效

请妥善保管密钥

不要把密钥提交到 Git 仓库、贴到聊天群或写进前端代码。怀疑泄露时,立即在详情页「轮换密钥」。

本页目录