系统与主账户配置 API
本页描述主账户(Owner)级别的配置管理接口。所有更改仅影响当前主账户及其后代用户。
—
端点汇总
- 获取配置:
GET /x-config
- 更新配置:
PUT /x-config
(亦支持POST
) - 删除配置项(恢复默认):
DELETE /x-config
- 辅助总览:
GET /x-conf
(含休眠密钥、已禁用密钥与关键阈值)
鉴权:需使用主账户密钥(isOwner
)。
—
配置键说明
可更新键(大小写敏感;术语参见《术语表》):
MODEL_MAPPER
自定义模型映射,形如:gpt-3.5*=gpt-4o-mini, o*=gpt-4o
LEVEL_MAPPER
Level 映射:gpt-4*=2, claude*=3
SWITCH_OVER
Level 故障切换顺序:1=2,2=3
RESOURCES
资源白名单(逗号/空白分隔):/v1/chat/completions,/v1/embeddings
MODEL_LIMITS
模型限速(JSON):{ "gpt-4o": {"rpm": 30, "tpm": 90000}, "claude-3-opus": {"rpm": 20, "tpm": 60000} }
邮件相关:
XAI_MAIL
、EMAIL_PORT
、EMAIL_SMTP
、EMAIL_AUTH
、EMAIL_PASS
、EMAIL_TLS
—
获取配置
curl -H "Authorization: Bearer $API_KEY" \
https://api.xaixapi.com/x-config | jq .
响应示例(节选):
{
"success": true,
"oid": 1,
"configs": {
"MODEL_MAPPER": {"gpt-3.5*": "gpt-4o-mini"},
"LEVEL_MAPPER": {"gpt-4*": 2, "claude*": 3},
"SWITCH_OVER": {"1": 2},
"RESOURCES": {"/v1/chat/completions":{},"/v1/embeddings":{}},
"MODEL_LIMITS": {"gpt-4o": {"rpm": 30, "tpm": 90000}},
"EMAIL_SMTP": "smtp.gmail.com",
"EMAIL_TLS": true
}
}
—
更新配置
- 端点:
PUT /x-config
- Content-Type:
application/json
请求体(可批量):
{
"MODEL_MAPPER": "gpt-3.5*=gpt-4o-mini, o*=gpt-4o",
"LEVEL_MAPPER": "gpt-4*=2, claude*=3",
"SWITCH_OVER": "1=2,2=3",
"RESOURCES": "/v1/chat/completions, /v1/embeddings",
"MODEL_LIMITS": "{\n \"gpt-4o\": {\"rpm\": 30, \"tpm\": 90000}\n}",
"EMAIL_SMTP": "smtp.gmail.com",
"EMAIL_TLS": "true"
}
说明:
MODEL_MAPPER
/LEVEL_MAPPER
/SWITCH_OVER
为k=v
逗号分隔格式;两侧会自动trim
。RESOURCES
支持逗号/空白分隔;每项会校验为合法路径。MODEL_LIMITS
可为 JSON 字符串或对象;对象模式下支持增量覆盖与重置(传*
或=
重置为空)。
—
删除配置项
- 端点:
DELETE /x-config
请求体:
{ "keys": ["MODEL_MAPPER", "SWITCH_OVER"] }
效果:删除后恢复为系统默认值;会广播变更并刷新本地缓存。
—
与密钥联动
- 新增密钥后,系统会尝试根据 Provider(含智能相似度匹配)自动补全
LEVEL_MAPPER
,便于该 Provider 的模型进入对应 Level 池。 GET /x-conf
可一次性查看Level/Model
映射、休眠密钥与阈值(UserMinBalance
、UserApiBalance
)。