𝐗𝐀𝐈 𝐗𝐀𝐏𝐈

Admin 控制台

XAI Admin 是面向主账户（Owner）的图形化配置管理控制台，用于管理 Provider 密钥、系统配置、新闻广播和操作日志。

功能概览

XAI Admin 控制台包含以下核心功能模块：

  1. AI API 文档 - 查看支持的 AI 服务提供商和 SDK 示例
  2. 模型服务（Provider 管理） - 管理上游 AI Provider 密钥
  3. 系统配置 - 配置模型映射、Level 映射、资源白名单等
  4. 广播通知 - 发布系统级或定向用户通知
  5. 操作日志 - 查看所有账户操作记录

访问控制

  • 仅主账户可访问：只有主账户（isOwner=true）才能登录 Admin 控制台
  • 本地存储密钥：API Key 仅保存在浏览器本地，不会上传到服务器
  • 会话管理：登录状态保存在浏览器，关闭页面后需要重新登录

常见任务导航

功能-端点-权限 总览

完整的 API 端点和使用方法，请查看 Admin API 参考文档

功能API 文档权限
Provider 管理Admin API: Provider 密钥管理仅主账户
主账户配置（Model/Level/Resources/Limits）Admin API: 系统配置仅主账户
新闻（系统/定向）Admin API: 广播通知系统新闻仅主账户；定向需具备祖先权限
操作日志Manage API: 操作日志仅主账户

术语对齐：Model Mapper、Level Mapper、Resources（白名单）、Model Limits、Sleep、Switch Over（详见《术语表》）。

功能详解

1. AI API 标签页

展示平台支持的 AI 服务提供商和 SDK 使用示例。

功能包括：

  • 模型列表链接 - 动态显示 /v1/models 端点链接
  • 支持的 AI 服务提供商 - 展示 9 大主流 AI 服务商（OpenAI、Anthropic、Perplexity、Mistral、Grok、Gemini、Cohere、DeepSeek、AI21）
  • SDK 示例代码 - 提供 OpenAI SDK 和 Anthropic SDK 的完整示例代码
  • 一键复制 - 示例代码支持一键复制功能

相关 API： 详见 Manage API: 模型清单

2. 模型服务（Provider 管理）

管理上游 AI Provider 密钥池，支持多种 Provider 类型。

功能包括：

  • 统计卡片 - 显示总 Level 数、总 Key 数、活跃 Key 数
  • 新增 Provider - 支持三种配置类型：
    • 标准配置（OpenAI、Anthropic 等）
    • Azure OpenAI 配置
    • Google Vertex AI 配置
  • Provider 列表 - 按 Level 分组展示所有 Provider
  • 编辑/删除 Provider - 支持修改 Provider 配置或删除
  • 状态管理 - 启用/禁用 Provider

新增 Provider 表单字段：

  • Name - Provider 名称（可选，用于标识）
  • Level - 负载池级别（必填，用于路由）
  • Provider - 上游 API URL（必填）
  • SecretKey - API 密钥（必填）
  • 标准配置 - 无需额外字段
  • Azure 配置 - Model Mapping、API Version 映射
  • Vertex 配置 - Base URL、Project ID、Client Email、Private Key

相关 API： 详见 Admin API: Provider 密钥管理

3. 系统配置标签页

管理主账户级别的系统配置参数。

配置项包括：

模型定价（Owner 覆盖）：

  • 在“系统配置”顶部可直接编辑 PRICING（仅填写与系统默认不同的“差量”）。
  • 支持操作：
    • “加载当前定价” 从后端读取 configs.PRICING
    • “保存定价（立即生效）” 通过 PUT /x-config 写入 PRICING
    • “清空定价（恢复默认）” 通过 DELETE /x-config 删除 PRICING
  • 约束：JSON 大小 ≤ 128k、条目总数 ≤ 1024；拒绝未知字段；所有数值须为有限非负数。

基础配置：

邮件配置：

  • EMAIL_SMTP - SMTP 服务器地址
  • EMAIL_PORT - SMTP 端口
  • EMAIL_AUTH - 认证邮箱
  • EMAIL_PASS - 邮箱密码
  • EMAIL_TLS - 启用 TLS（true/false）

映射配置：

  • MODEL_MAPPER - 系统模型映射（格式：原模型=目标模型）
    • 示例：gpt-3.5*=gpt-4o-mini,gpt-4=gpt-4o
    • 用途：将请求的模型自动转换为其他模型
  • LEVEL_MAPPER - Level 映射（格式：模型=Level编号）
    • 示例：gpt*=1,claude*=2,deepseek*=3
    • 用途：指定模型由哪个 Level 的 Provider 池处理
  • SWITCH_OVER - 模型分组主备切换（格式：主Level=备Level）
    • 示例：1=10,2=20
    • 用途：当主 Level 一分钟内超过 5 次异常，自动切换到备 Level

相关 API： 详见 Admin API: 系统配置

4. 广播通知标签页

发布系统级或定向用户通知。

功能包括：

  • 创建新通知 - 填写标题和内容发布通知
  • 通知列表 - 查看历史通知记录
  • 删除通知 - 删除过期或错误的通知

字段说明：

  • title - 通知标题（必填，最多 100 字符）
  • content - 通知内容（必填，最多 1000 字符）

相关 API： 详见 Admin API: 广播通知

5. 操作日志标签页

查看所有账户的操作记录，支持分页查看。

功能包括：

  • 日志表格 - 显示时间、行为、目标账户、详情、IP 地址
  • 自动分页 - 每页默认显示 24 条记录
  • 实时更新 - 进入标签页时自动刷新

相关 API： 详见 Manage API: 操作日志

使用场景

场景 1：添加标准 Provider

  1. 进入"模型服务"标签页
  2. 在"新增 Provider"表单中填写：
    • Name: OpenAI Production
    • Level: 1
    • Provider: https://api.openai.com
    • SecretKey: sk-...
  3. 点击"添加 Provider"
  4. 系统会自动在 LEVEL_MAPPER 中添加 gpt*=1 映射

场景 2：配置 Azure OpenAI

  1. 进入"模型服务"标签页
  2. 选择配置类型："Azure OpenAI 配置"
  3. 填写基本信息和 Azure 特定配置：
    • Provider: https://your-resource.openai.azure.com
    • Model → Deployment 映射：{"gpt-4o": "gpt-4-deployment"}
  4. 点击添加
  5. 系统会自动处理 Azure 特定的请求路由

场景 3：设置模型映射

  1. 进入"系统配置"标签页
  2. 在"系统模型映射"中输入：
    gpt-3.5*=gpt-4o-mini,o*=gpt-4o
  3. 在"Level 映射"中输入：
    gpt*=1,claude*=2,deepseek*=3
  4. 点击"保存配置"
  5. 系统会自动应用新的映射规则

场景 4：发布系统通知

  1. 进入"广播通知"标签页
  2. 填写通知标题和内容：
    • 标题：系统维护通知
    • 内容：系统将于明日凌晨 2:00-4:00 进行维护...
  3. 点击"发送通知"
  4. 所有用户在 Manage 控制台将看到该通知

最佳实践

Provider 管理

  1. 按服务商分组 - 将同一服务商的密钥放入同一 Level
  2. 设置主备切换 - 使用 SWITCH_OVER 配置关键 Level 的备份
  3. 定期检查休眠密钥 - 在 Provider 列表中查看休眠状态
  4. 合理设置 Level - 按成本、速度、可靠性划分不同 Level

配置管理

  1. 模型映射用途 - 用于平滑迁移或成本优化
  2. 谨慎修改 RESOURCES - 错误配置可能导致 API 无法访问
  3. MODEL_LIMITS 限制 - 为昂贵模型设置严格的速率限制
  4. 定期备份配置 - 使用 /x-config 端点导出配置

通知管理

  1. 重要通知优先 - 系统级通知用于关键信息
  2. 内容简洁明了 - 避免过长的通知内容
  3. 及时清理过期通知 - 删除过期或无效的通知

常见问题

Q: 为什么我无法登录 Admin 控制台？

A: 只有主账户（Owner）才能登录 Admin 控制台。子账户请使用 Manage 控制台。

Q: 添加 Provider 后模型仍然无法使用？

A: 检查以下几点：

  1. LEVEL_MAPPER 是否包含该模型的映射
  2. Provider 状态是否为启用
  3. SecretKey 是否有效

Q: 如何查看系统自动添加的 LEVEL_MAPPER？

A: 在"系统配置"标签页的"Level 映射"字段中可以查看和修改。

Q: Azure 配置的 API Version 映射是必填的吗？

A: 不是必填的。如果留空，系统会使用环境变量中配置的默认版本。

Q: 如何备份我的配置？

A: 使用以下命令导出配置：

curl -H "Authorization: Bearer $API_KEY" \
  https://api.xaixapi.com/x-config > config-backup.json

相关文档

← 访问控制 (ACL)
X-TOTP 双因素令牌保险柜 →