跳转到内容

入门

API 密钥

API 密钥是什么、怎么创建、每个选项的含义,以及查看、禁用、删除和保管密钥的方法。

API 密钥(API Key)是一串以 sk- 开头的字符。程序或工具调用 NoviaHub 时,要在请求里带上它,NoviaHub 才知道「是谁在调用、费用记在谁的账上」。

  • 同一个账户可以创建多把密钥,建议一个应用或一个工具用一把,出问题时只需要停用那一把。
  • 每把密钥都可以单独设置有效期、额度上限、可用模型和允许访问的 IP。
  • 调用产生的费用从你的账户余额里扣除,与用哪一把密钥无关。

登录 noviahub.com 后,进入控制台,在左侧菜单「常规」下点击「API 密钥」。也可以直接打开 noviahub.com/keys。

「API 密钥」页面:上方有「API 地址」和「创建 API 密钥」按钮,下方表格列出已有的密钥及其状态「API 密钥」页面:上方有「API 地址」和「创建 API 密钥」按钮,下方表格列出已有的密钥及其状态
  1. 点击页面右上角的「创建 API 密钥」,右侧会弹出一个面板。

  2. 按需要填写下面这些项目(大多数情况下只填「名称」即可,其余保持默认):

    「创建 API 密钥」面板,包括基本信息、额度设置和展开后的高级设置「创建 API 密钥」面板,包括基本信息、额度设置和展开后的高级设置

    基本信息

    项目 说明
    名称 必填,最多 50 个字符。只是给自己看的标记,建议写用途,例如 claude-code、my-app。
    分组 决定这把密钥走哪一组线路和价格。不选时跟随账户自己的分组(表格里显示为「用户分组」「继承」)。NoviaHub 目前只有「默认分组」一个分组,保持默认即可。
    过期时间 默认「永不过期」。可以点「永不」「1 个月」「1 天」「1 小时」快速设置,也可以自己选日期和时间。过期后这把密钥不能再用。
    数量 默认 1。填大于 1 的数字会一次创建多把,名称后面会自动加随机后缀。

    额度设置

    项目 说明
    无限配额 默认开启,表示这把密钥本身不设上限。注意:它不代表免费,调用照样从账户余额扣费,余额用完也就不能再调用了。
    额度 关闭「无限配额」后出现。填这把密钥最多能花多少钱(单位与界面上显示的货币一致,通常是美元 $)。花完后密钥状态变为「已耗尽」。适合给测试环境或分享给别人的密钥设一个上限。

    高级设置(点「高级设置」展开)

    项目 说明
    模型限制 选中的模型才能用这把密钥调用;留空表示所有模型都能用。用了不在列表里的模型,会返回 403 错误。
    IP 白名单(支持 CIDR 表达式) 只允许这些 IP 地址使用这把密钥;留空表示不限制。每行写一个 IP 或网段(如 203.0.113.8、203.0.113.0/24),不要用逗号把多个 IP 写在同一行。页面提示「请勿过度信任此功能,IP 可能被伪造」,它只能作为辅助手段。
  3. 点击右下角「保存更改」。新密钥会出现在列表里。

列表里的密钥默认只显示前后几位(例如 sk-UD7q**********YDFZ)。需要完整密钥时,任选一种方式:

  • 点击这串被遮住的密钥,会弹出「完整 API 密钥」小窗,里面的文字已自动选中,直接复制即可。
  • 点击密钥右边的复制图标。
  • 点击这一行最右边的「⋯」,选择「复制密钥」。

以上三种方式得到的都是以 sk- 开头的完整密钥。

点击被遮住的密钥后,弹出「完整 API 密钥」小窗点击被遮住的密钥后,弹出「完整 API 密钥」小窗
列 含义
名称 创建时填写的名称。
状态 见下方状态说明。
API 密钥 遮住中间部分的密钥,点击可查看完整内容。
额度 ($) 开启无限配额的显示「无限制」;否则显示剩余额度,点击可看到「剩余」「已用」「当前总额度」「剩余比例」。「当前总额度」= 已用 + 剩余。
分组 这把密钥使用的分组。
模型 设置了模型限制时显示「N 个模型」,否则显示「无限制」。
IP 限制 设置了 IP 白名单时显示「N 个 IP」,否则显示「无限制」。
时间 创建时间和最后使用时间。
过期 过期时间,永不过期显示「永不」。
操作 启用/禁用、编辑,以及「⋯」菜单。

表格较宽时,右侧几列需要左右滚动才能看到。

状态 什么时候会变成这样 还能不能用
已启用 正常状态。 能。
已禁用 你手动点了「禁用」。 不能。点「启用」即可恢复。
已过期 到了设置的过期时间。 不能。编辑密钥,把过期时间改到以后,或改成「永不过期」。
已耗尽 设置了额度上限,而且已经花完。 不能。编辑密钥,调高额度或开启「无限配额」。

用一把不是「已启用」状态的密钥调用接口,NoviaHub 统一返回 HTTP 401,提示 Invalid token(中文环境下为「无效的令牌」),不会告诉你具体是哪种原因。遇到 401 时,先回到这个页面看看密钥的状态。

每一行最右边有三个按钮:

  • 禁用 / 启用:临时停用一把密钥,或把它恢复。停用期间用它调用会返回 401。
  • 编辑:修改名称、分组、过期时间、额度、模型限制和 IP 白名单。修改后点「保存更改」生效。
  • ⋯(打开菜单):里面有「复制密钥」「复制连接信息」「CC Switch」「聊天」和「删除」。
点击「⋯」后弹出的菜单:复制密钥、复制连接信息、CC Switch、聊天、删除点击「⋯」后弹出的菜单:复制密钥、复制连接信息、CC Switch、聊天、删除

菜单里各项的作用:

菜单项 作用
复制密钥 复制完整密钥。
复制连接信息 复制一段包含密钥和 NoviaHub 地址的 JSON 文本,格式为 {"_type": ..., "key": "sk-...", "url": "https://noviahub.com"}。它用于在其他同类网关里添加渠道时自动识别,一般用不到。
CC Switch 把这把密钥一键导入 CC Switch,详见CC Switch 集成。
聊天 把这把密钥一键填入第三方聊天客户端(如 Cherry Studio),需要电脑上已经安装对应的软件。
删除 永久删除这把密钥,会先弹出确认框,删除后无法恢复。已经用这把密钥配置好的程序会立刻无法调用。

勾选左侧的复选框可以一次选中多把密钥,然后批量「复制选定的密钥」或「删除选定的 API 密钥」。

「创建 API 密钥」左边的「API 地址」按钮会列出调用地址(「默认 API 地址」,即 https://noviahub.com),可以一键复制。不同协议的地址写法不同,详见快速开始 · 接口地址。

  • 一个用途一把密钥:比如 Claude Code 一把、自己的应用一把。某一把泄露或用量异常时,只停用它,不影响别的。
  • 给不完全信任的场景设上限:借给别人试用、放在测试环境的密钥,关闭「无限配额」并设置一个额度,必要时再加上过期时间。
  • 只开放需要的模型:专门给某个工具用的密钥,可以用「模型限制」只放行它要用的模型,防止误用昂贵模型。
  • 定期检查:在使用日志里按「令牌名称」筛选,可以看到每把密钥的调用和花费。