跳到主要内容

API Keys

API Keys 是用于调用 AI Gateway 的鉴权凭证,支持在个人设置和组织管理中分别创建和管理。与 Git Access Token 不同,API Keys 专为 AI Gateway 接口调用设计,支持多密钥并行,可独立命名、设置用量额度和过期时间。

信息

API Keys 与 Git Access Token 的区别

API KeysGit Access Token
用途调用 AI Gateway 推理接口Git 操作(clone/push/pull)及 CSGHub API
数量支持多个同时存在任意时刻仅一个有效
管理创建、命名、设额度、设过期时间、删除仅需刷新(重置)

在哪里管理 API Keys​

API Keys 支持两种维度的管理入口:

  • 个人 API Keys:用于以个人身份调用 AI Gateway。进入账号设置 → API Keys 页面管理。
  • 组织 API Keys:用于以组织身份调用 AI Gateway,适合团队共用或按项目隔离额度。进入组织设置 → API Keys 页面管理。

apikeys_list

创建 API Key​

  1. 进入相应的 API Keys 管理页面(个人或组织)。

  2. 点击新建 API Key 按钮,弹出创建对话框。

  3. 填写以下信息:

    • 名称(必填):为 Key 设置一个便于识别的名称,例如 production、testing。
    • 使用额度(可选):设置该 Key 的消费上限,可选择:
      • 无限制:不设消费上限。
      • 每月额度:每自然月重置一次,达到限额后该 Key 的请求将被拒绝。
      • 总额度:整个生命周期内的累计消费上限。
    • 过期时间(可选):设置 Key 的有效期,可选永不过期或指定具体日期。
  4. 点击创建,系统将生成一个以 gw-sk- 为前缀的 API Key。

apikeys_create

注意

重要:请立即保存你的 API Key

API Key 仅在创建成功后完整展示一次。关闭弹窗后,Key 将自动脱敏显示(如 gw-sk-****abcde),无法再次查看完整内容。请务必在关闭弹窗前将其复制并妥善保存。

查看 API Keys 列表​

API Keys 列表展示以下信息:

字段说明
名称创建时设置的 Key 名称
API Key脱敏显示的 Key(如 gw-sk-****7f2a)
消费额度已消费金额 / 设定的限额(例如 ¥45.50 / 无限制)
过期时间Key 的有效期
创建时间Key 的创建日期
操作编辑额度或删除 Key

删除 API Key​

  1. 在 API Keys 列表中,找到需要删除的 Key。
  2. 点击操作列中的删除图标。
  3. 确认删除操作。
警告

API Key 删除后立即失效,所有携带该 Key 的请求将被 AI Gateway 拒绝。请确认相关应用已更换为新 Key 后再执行删除操作。

如何使用 API Key​

获取 API Key 后,将其作为 Bearer Token 置于 HTTP 请求头中,即可调用 AI Gateway 提供的各类模型接口:

curl https://<your-gateway-host>/v1/chat/completions \
-H "Authorization: Bearer gw-sk-xxxxxxxxxxxxxxxx" \
-H "Content-Type: application/json" \
-d '{
"model": "Qwen2.5-72B-Instruct",
"messages": [{"role": "user", "content": "Hello!"}]
}'

AI Gateway 兼容 OpenAI API 标准,你可以直接使用 OpenAI SDK 或 LangChain 等工具,只需替换 base_url 和 API Key:

from openai import OpenAI

client = OpenAI(
api_key="gw-sk-xxxxxxxxxxxxxxxx",
base_url="https://<your-gateway-host>/v1"
)

response = client.chat.completions.create(
model="Qwen2.5-72B-Instruct",
messages=[{"role": "user", "content": "Hello!"}]
)
print(response.choices[0].message.content)

常见问题​

Q:API Key 泄漏了怎么办?
A:立即进入 API Keys 管理页面,删除已泄漏的 Key。删除后,AI Gateway 会立刻阻断所有携带该 Key 的请求。建议同时创建一个新的 Key 替换原来的配置。

Q:API Key 和 Git Access Token 可以通用吗?
A:不可以。API Keys 仅用于 AI Gateway 的接口调用;Git Access Token 用于 Git 操作和 CSGHub 平台 API 访问,两者相互独立,不可替代。

Q:组织 API Key 和个人 API Key 有什么区别?
A:两者在使用方式上完全一致,区别在于关联的账单和额度归属不同:个人 Key 的消费计入个人账单,组织 Key 的消费计入组织账单,适合按团队或项目分开核算。