文档/ 参考
管理 API
管理台本身就是调用这套接口的。需要脚本化管理分组和密钥时可以直接用。
认证§
/api 下的受保护接口都使用 Bearer 认证:
请求头
Authorization: Bearer 你的 AUTH_KEY 或访问密钥AUTH_KEY——管理权限,可读写配置,也能执行 Reveal 等敏感操作- 访问密钥——只允许读取自身范围内的首页、模型、用量和脱敏请求日志, 不能修改配置,也不能查看上游凭据
需要写入或调用路由检查时必须使用 AUTH_KEY。
响应约定§
统一的返回结构,成功与失败靠 code 区分:
成功
{
"code": 0,
"message": "success",
"data": { ... }
}失败
{
"code": "错误标识",
"message": "人类可读的说明"
}成功时 code 是数字 0,失败时是字符串标识—— 判断时注意类型。
主要资源§
| 路径 | 用途 |
|---|---|
| /api/groups | 分组的增删改查 |
| /api/groups/{id}/credentials | 凭据管理,含批量导入、查看真实值、下载 |
| /api/access-keys | 访问密钥,含限额与查看真实值 |
| /api/models | 模型信息 |
| /api/model-prices | 模型价格,含同步与重置 |
| /api/logs | 请求日志查询 |
| /api/usage | 用量与成本统计 |
| /api/health | 健康状态 |
| /api/settings | 运行时设置 |
| /api/route/inspect | 路由检查 |
以管理台的实际请求为准
每个端点的具体参数没有在这里逐一列出—— 接口仍在演进,写死在文档里容易过时。最可靠的做法是打开浏览器开发者工具, 在管理台做一次对应操作,直接看它发了什么请求。 这样拿到的参数一定是当前版本准确的。
几个例子§
列出所有分组
curl http://127.0.0.1:3001/api/groups \
-H "Authorization: Bearer $AUTH_KEY"查看健康状态
curl http://127.0.0.1:3001/api/health \
-H "Authorization: Bearer $AUTH_KEY"路由检查:这个请求会走哪
curl -X POST http://127.0.0.1:3001/api/route/inspect \ -H "Authorization: Bearer $AUTH_KEY" \ -H "Content-Type: application/json" \ -d '{"protocol":"openai-completions","external_model":"gpt-4o","access_key_id":1}'
access_key_id 是管理台中访问密钥的数字 ID。 路由检查只计算当前配置下的候选结果,不会向上游发送真实请求。
注意事项§
不要暴露到公网
管理接口能读取所有渠道凭据的真实值(/reveal 一类的端点就是干这个的)。AUTH_KEY 泄漏等于全部上游密钥泄漏。
必须限制来源,配置方式见 安全与上生产。
- 脚本里别硬编码 AUTH_KEY——用环境变量或密钥管理工具
- 接口会随版本调整——自动化脚本升级后要回归验证
- 批量操作注意幂等—— 比如重复导入同一批凭据,重复的会被自动跳过,但仍建议先查后写