MAX APIMAX API
使用指南部署安装API 参考AI 应用帮助支持商务合作合规与使用政策
⚠️合规提示:本项目仅用于合法授权的 API 网关、内部管理和私有化部署场景。请遵守上游服务条款、平台规则、监管要求和内容安全要求。
用户指南

令牌管理

令牌是调用 API 的凭证,每个令牌可独立配置权限范围和配额上限

令牌(API Key)是调用 API 的凭证,每个令牌可独立配置权限范围、配额上限和路由策略。左侧导航点击「API Keys」,或直接访问 /keys

令牌列表页

令牌列表展示所有已创建的令牌,包含名称、状态、已用配额、剩余配额、过期时间等信息。

创建令牌

基本配置

  1. 在令牌列表页点击右上角「创建令牌」按钮,弹出创建弹窗
  2. 填写令牌名称(建议按用途命名,如「生产环境」「测试用」)

创建令牌弹窗

高级配置选项

按需配置以下选项:

配置项说明
过期时间设置有效期,留空或设为 -1 表示永不过期
剩余配额限制该令牌可消耗的最大配额,超出后自动失效
无限配额开启后不受配额限制(仍受账户总配额约束)
模型限制限定该令牌只能调用指定模型,留空表示不限制
IP 白名单限定允许使用该令牌的来源 IP,留空表示不限制
路由策略选择系统定义的自动路线,或按顺序配置手工分组;可独立开启跨分组重试

配置 API Key 路由

创建或编辑 API Key 时,路由编辑器提供 自动路线手工路线 两种模式。路由顺序同时用于普通中继、固定渠道(Affinity)匹配、失败重试和 GET /v1/models 的模型集合计算。

自动路线

自动路线由管理员统一定义,例如 autoauto:fastauto:cheap。选择路线时,卡片会显示该路线当前包含的分组链,请求按管理员配置的顺序尝试这些分组。

自动路线适合希望跟随平台统一调度策略的 API Key。管理员以后调整路线内的分组时,使用该路线的 API Key 会自动采用新顺序,无需逐个编辑。

手工路线

需要为单个 API Key 固定路由顺序时:

  1. 点击「关闭自动路线并选择分组」,切换到手工模式。
  2. 搜索并选择 1 至 8 个当前可用的真实分组;自动路线 key 不能作为手工分组加入。
  3. 按预期尝试顺序排列分组。可以拖动手柄,也可以聚焦手柄后按 ArrowUp / ArrowDown,或使用每行的上移、下移按钮。
  4. 列表最上方的分组最先尝试,后续分组只在路由允许推进时使用。

手工路线下,GET /v1/models 会合并所有有序分组中的可用模型并按模型名去重,不再只展示第一个分组的模型。

跨分组重试

开启「跨分组重试」后,当前分组失败时会按自动路线或手工列表的顺序尝试下一个分组,并排除已经失败的渠道。关闭后不会推进到下一分组;该开关不等同于关闭分组内部的全部重试机制。

已保存但当前不再允许新选择的自动路线或手工分组会标记为「不可用」。只修改名称、配额等其他字段时,原路由会被保留;一旦主动修改路由,必须移除或替换不可用项。运行时会跳过不可用的手工分组,如果没有任何可用分组,请求会明确失败,不会回退到随机默认分组。

管理 API 兼容

新客户端应优先在创建或更新 Token 时发送 routing。自动路线示例:

{
  "routing": {
    "version": 1,
    "mode": "smart",
    "route": "auto:fast",
    "retry_on_failure": true
  }
}

手工路线示例:

{
  "routing": {
    "version": 1,
    "mode": "manual",
    "groups": ["vip", "default"],
    "retry_on_failure": true
  }
}

Token 详情响应会返回 routing,并用 routing_legacy: true 标记由旧字段即时合成的兼容策略;GET /api/group 还会返回当前用户可选择的 auto_routes。旧客户端继续只发送 groupcross_group_retry 仍可工作,更新时省略路由字段会保留现有策略,显式发送 cross_group_retry: false 会关闭跨分组重试。

保存令牌 Key

点击「提交」,弹窗显示完整的令牌 Key,立即复制保存,关闭弹窗后无法再次查看完整 Key

令牌创建成功,显示完整 Key

令牌 Key 仅在创建时完整显示一次,请立即复制保存。令牌 Key 具有完整的 API 调用权限,请勿泄露给他人,不要提交到代码仓库。

编辑令牌

在令牌列表中找到目标令牌,点击右侧「编辑」按钮,可修改令牌的配置选项(不包括令牌 Key 本身)。

删除令牌

在令牌列表中找到目标令牌,点击右侧「删除」按钮,确认后该令牌立即失效,无法恢复。

这篇文档对您有帮助吗?