Manage API 参考
本文档基于当前后端代码同步整理,聚焦对外公开的 Manage 侧接口。
基础信息
- Base URL:
https://api.xaicontrol.com - 认证:
Authorization: Bearer sk-Xvs...
export BASE_URL="https://api.xaicontrol.com"
端点总览
| 模块 | 方法 | 端点 | 说明 |
|---|---|---|---|
| 子账户管理 | POST | /x-users | 创建子账户 |
| 子账户管理 | GET | /x-users、/x-users/{identifier} | 查询直属子账户 |
| 子账户管理 | GET | /x-dna、/x-dna/{identifier} | 查询后代账户 |
| 子账户管理 | PUT/POST | /x-users/{identifier} | 更新子账户 |
| 子账户管理 | DELETE | /x-users/{identifier} | 删除子账户 |
| 后代账单 | GET | /x-bill | 后代聚合账单 |
| 账户自助 | POST | /x-self | 轮换当前账户 API Key |
| 仪表盘 | GET | /dashboard/status | 当前账户状态 |
| 仪表盘 | GET | /dashboard/info | 当前账户详情 |
| 仪表盘 | GET | /dashboard/live | 详情 + 日/月实时用量 |
| 仪表盘 | GET | /dashboard/bill | 当前账户账单 |
| 仪表盘 | GET | /dashboard/logs | 操作日志 |
| 仪表盘 | GET | /dashboard/news | 通知信息 |
| 模型列表 | GET | /dashboard/models、/v1/models、/models | 可见模型列表 |
1) 子账户管理(/x-users / /x-dna)
1.1 创建子账户
POST /x-users
最小请求:
{
"Name": "dev-account",
"Email": "[email protected]",
"CreditGranted": 100
}
常用可选字段:
Alias、BillingEmailRatesRPM/RPH/RPD、TPM/TPH/TPDAllowIPs、AllowModels、AllowLevelsResourcesModelLimits
1.2 查询子账户与后代
GET /x-users:直属子账户GET /x-dna:全部后代GET /x-users/{identifier}、GET /x-dna/{identifier}:路径筛选
查询参数:
id、name、email、level、dnapage、sizeorder
路径 identifier 支持:
- 数字 ID
- 用户名
- 邮箱
- DNA(
.前缀) - 前缀过滤:
L{n}、G{n}、R{n}、T{n}、F{n}
1.3 更新子账户
PUT /x-users/{identifier} 或 POST /x-users/{identifier}
常用公开字段:
- 基础信息:
Name、Email、Alias、BillingEmail、QRCode - 状态:
Status、Suspended - 额度:
CreditGranted、Days、Rates - 限额:
DailyLimit、HardLimit、SoftLimit、UserLimit、AutoQuota - 速率:
RPM/RPH/RPD、TPM/TPH/TPD - ACL:
Resources、AllowIPs、AllowModels、AllowLevels - 映射/限速:
ModelMapper、ModelLimits
Owner 扩展字段:Level、Role、Factor、LevelMapper。
1.4 删除子账户
DELETE /x-users/{identifier}
2) 后代账单(/x-bill)
GET /x-bill
查询参数:
- 日期:
date/d - 范围:
start/s、end/e - 天数:
days - 用户筛选:
user/u
3) 自助轮换密钥(/x-self)
POST /x-self
{
"confirm": "YYYY-MM-DD-ROTATE-SELF",
"key": "sk-Xvs..."
}
confirm必须匹配当天日期规则key可选,不传会自动生成
4) 仪表盘接口(/dashboard/*)
GET /dashboard/status:权限与状态GET /dashboard/info:账户详情GET /dashboard/live:实时用量GET /dashboard/bill:当前账户账单GET /dashboard/logs:操作日志GET /dashboard/news:通知GET /dashboard/models:模型列表
说明:仅公开业务治理所需字段。后台内部账务订正字段与维护接口不在本页展示范围内。