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
}

常用可选字段:

  • AliasBillingEmail
  • Rates
  • RPM/RPH/RPDTPM/TPH/TPD
  • AllowIPsAllowModelsAllowLevels
  • Resources
  • ModelLimits

1.2 查询子账户与后代

  • GET /x-users:直属子账户
  • GET /x-dna:全部后代
  • GET /x-users/{identifier}GET /x-dna/{identifier}:路径筛选

查询参数:

  • idnameemailleveldna
  • pagesize
  • order

路径 identifier 支持:

  • 数字 ID
  • 用户名
  • 邮箱
  • DNA(. 前缀)
  • 前缀过滤:L{n}G{n}R{n}T{n}F{n}

1.3 更新子账户

PUT /x-users/{identifier}POST /x-users/{identifier}

常用公开字段:

  • 基础信息:NameEmailAliasBillingEmailQRCode
  • 状态:StatusSuspended
  • 额度:CreditGrantedDaysRates
  • 限额:DailyLimitHardLimitSoftLimitUserLimitAutoQuota
  • 速率:RPM/RPH/RPDTPM/TPH/TPD
  • ACL:ResourcesAllowIPsAllowModelsAllowLevels
  • 映射/限速:ModelMapperModelLimits

Owner 扩展字段:LevelRoleFactorLevelMapper

1.4 删除子账户

DELETE /x-users/{identifier}


2) 后代账单(/x-bill

GET /x-bill

查询参数:

  • 日期:date/d
  • 范围:start/send/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:模型列表

说明:仅公开业务治理所需字段。后台内部账务订正字段与维护接口不在本页展示范围内。