API 参考
API 参考
欢迎阅读 XAI XAPI 文档。我们的平台提供了一套全面的 API,用于管理 AI 服务、子账户和资源。
API 概述
XAI 提供以下 API 类别:
核心 API
- 认证 API - API 认证和密钥管理
- AI 服务代理 API - OpenAI/Anthropic 兼容端点
控制台 API
Admin API - Admin Console 专用 API
- Provider 密钥管理
- 系统配置(模型映射、Level 路由、定价覆盖)
- 广播通知
Manage API - Manage Console 专用 API
- 子账户管理(创建、查询、更新、删除)
- 仪表盘查询(状态、用量、账单、日志)
控制台使用指南
- Admin Console 使用指南 - Admin UI 操作说明
- Manage Console 使用指南 - Manage UI 操作说明
快速开始
身份认证
所有 API 请求都需要使用 Bearer 令牌进行身份认证:
Authorization: Bearer sk-Xvs...
基础 URL
https://api.xaixapi.com
Admin API 快速示例
# 添加 Provider 密钥
curl -X POST https://api.xaixapi.com/x-keys \
-H "Authorization: Bearer $API_KEY" \
-H "Content-Type: application/json" \
-d '{
"SecretKey": "sk-...",
"Name": "OpenAI 生产",
"Level": 1,
"Provider": "https://api.openai.com"
}'
# 配置模型映射
curl -X PUT https://api.xaixapi.com/x-config \
-H "Authorization: Bearer $API_KEY" \
-H "Content-Type: application/json" \
-d '{"MODEL_MAPPER": "gpt-3.5*=gpt-4o-mini"}'
Manage API 快速示例
# 创建子账户
curl -X POST https://api.xaixapi.com/x-users \
-H "Authorization: Bearer $API_KEY" \
-H "Content-Type: application/json" \
-d '{
"Name": "prod-account",
"Email": "[email protected]",
"CreditGranted": 500
}'
# 查询用量
curl -H "Authorization: Bearer $API_KEY" \
https://api.xaixapi.com/dashboard/bill
文档导航
按角色分类
主账户(Owner):
- Admin API - 系统配置和 Provider 管理
- Admin Console 指南 - UI 操作说明
所有用户:
- Manage API - 子账户和用量管理
- Manage Console 指南 - UI 操作说明
- AI 服务代理 - 调用 AI 模型
按功能分类
账户管理:
- 创建子账户 → Manage API: 创建子账户
- 查询子账户 → Manage API: 查询子账户
- 更新子账户 → Manage API: 更新子账户
系统配置:
- Provider 管理 → Admin API: Provider 密钥管理
- 模型映射 → Admin API: 系统配置
- 定价覆盖 → Admin API: 定价覆盖
用量监控:
- 账户状态 → Manage API: 用户状态
- 用量账单 → Manage API: 用量账单
- 操作日志 → Manage API: 操作日志