Files
taiji-AI-PAD/Docs/项目文档/全平台API接口清单.md
T

30 KiB

taiji-AI-PAD 全平台API接口清单

最后更新时间:2026-01-12

本文档整理自 services/mcp-server/app/routes/ 目录下的所有路由文件

目录


1. 认证模块 (Auth)

前缀: /api/auth

方法 路径 功能描述 权限要求
POST /login 用户/渠道/管理员/供应商登录 无
POST /logout 用户登出(Token加入黑名单) 需认证
POST /refresh 刷新访问令牌 需认证
PUT /password 修改密码 需认证
GET /keys/info 获取服务终结点和API密钥信息 需认证
POST /keys/regenerate 重新生成API密钥 需认证
POST /register/send-code 发送邮箱验证码 无
POST /register 用户注册(自动分配默认资源) 无

2. 用户模块 (User)

前缀: /api/user

2.1 仪表盘与统计

方法 路径 功能描述 权限要求
GET /dashboard/stats 获取用户仪表盘统计数据 需认证
GET /dashboard/billing-overview 获取计费概览 需认证

2.2 工具管理

方法 路径 功能描述 权限要求
GET /tools/stats 获取工具统计 需认证
GET /tools 获取用户工具列表 需认证
POST /tools/create 创建工具 需认证
PUT /tools/{tool_id} 更新工具 需认证
DELETE /tools/{tool_id} 删除工具 需认证

2.3 Agent管理

方法 路径 功能描述 权限要求
GET /agents/activity 获取Agent活动数据 需认证
GET /agents/platform 获取平台Agent列表 需认证
POST /agents/deploy 部署Agent 需认证

2.4 网关管理

方法 路径 功能描述 权限要求
POST /gateway/select 选择网关类型 需认证
POST /gateway/api/create 创建网关API 需认证
GET /gateway/apis 获取网关API列表 需认证
GET /gateway/monitoring 获取网关监控数据 需认证

2.5 配额管理

方法 路径 功能描述 权限要求
GET /custom-agent-quota 获取自定义Agent配额 需认证

2.6 工作流管理

方法 路径 功能描述 权限要求
POST /workflows/create 创建工作流 需认证
GET /workflows 获取工作流列表 需认证
POST /workflows/{workflow_id}/run 运行工作流 需认证
DELETE /workflows/{workflow_id} 删除工作流 需认证

2.7 模型管理

方法 路径 功能描述 权限要求
GET /models 获取用户模型列表 需认证
GET /models/available 获取可用模型列表 需认证
GET /models/usage/stats 获取模型使用统计 需认证

2.8 计费管理

方法 路径 功能描述 权限要求
GET /billing/balance 获取余额 需认证
POST /billing/recharge 充值 需认证
GET /billing/history 获取计费历史 需认证

2.9 平台Agent

方法 路径 功能描述 权限要求
GET /platform-agents/available 获取可用平台Agent 需认证
POST /platform-agents/deploy 部署平台Agent 需认证
POST /platform-agents/use 使用平台Agent 需认证
DELETE /platform-agents/{instance_name} 停止平台Agent 需认证
GET /platform-agents/instances 获取用户平台Agent实例 需认证

2.10 自定义Agent

方法 路径 功能描述 权限要求
GET /custom-agents/templates 获取自定义Agent模板 需认证
POST /custom-agents 创建自定义Agent 需认证
DELETE /custom-agents/{name} 删除自定义Agent 需认证
PUT /custom-agents/{name}/scale 扩缩容自定义Agent 需认证
GET /custom-agents 获取自定义Agent列表 需认证
GET /custom-agents/{name}/logs 获取Agent日志 需认证
POST /custom-agents/{name}/restart 重启Agent 需认证

2.11 Agent计费

方法 路径 功能描述 权限要求
GET /agent-billing/stats 获取Agent计费统计 需认证
GET /agent-billing/history 获取Agent计费历史 需认证

2.12 用户资料

方法 路径 功能描述 权限要求
GET /profile 获取用户资料 需认证
PUT /profile 更新用户资料 需认证

3. 渠道模块 (Channel)

前缀: /api/channel

3.1 租户管理

方法 路径 功能描述 权限要求
GET /tenants 获取租户列表 渠道管理员
POST /tenants/create 创建租户 渠道管理员
PUT /tenants/{tenant_id}/resources 分配租户资源 渠道管理员
PUT /tenants/{tenant_id}/billing 更新租户计费设置 渠道管理员
POST /tenants/{tenant_id}/recharge 为租户充值 渠道管理员
PUT /tenants/{tenant_id}/credit 设置租户信用额度 渠道管理员
DELETE /tenants/{tenant_id} 删除租户 渠道管理员
PUT /tenants/{tenant_id}/status 更新租户状态 渠道管理员
PUT /tenants/{tenant_id}/permissions 更新租户权限 渠道管理员
PUT /tenants/{tenant_id}/password 修改租户密码 渠道管理员
GET /tenants/{tenant_id}/custom-agent-quota 获取租户自定义Agent配额 渠道管理员

3.2 租户模型管理

方法 路径 功能描述 权限要求
PUT /tenants/{tenant_id}/models 为租户分配模型 渠道管理员
DELETE /tenants/{tenant_id}/models/{model_name} 撤销租户模型 渠道管理员
PUT /tenants/{tenant_id}/models/{model_name}/quota 更新租户模型配额 渠道管理员
GET /tenants/{tenant_id}/models 获取租户模型列表 渠道管理员

3.3 渠道管理员

方法 路径 功能描述 权限要求
POST /admins/create 创建渠道管理员 渠道管理员
GET /admins 获取渠道管理员列表 渠道管理员

3.4 资源申请

方法 路径 功能描述 权限要求
POST /resources/apply 申请资源 渠道管理员

3.5 计费统计

方法 路径 功能描述 权限要求
GET /billing/stats 获取渠道计费统计 渠道管理员
GET /agent-billing/stats 获取渠道Agent计费统计 渠道管理员
GET /agent-billing/history 获取渠道Agent计费历史 渠道管理员
GET /agent-billing/tenant-summary 获取租户计费汇总 渠道管理员

3.6 供应商管理

方法 路径 功能描述 权限要求
GET /providers 获取可用供应商列表 渠道管理员
POST /providers/apply 申请供应商权限 渠道管理员
GET /providers/applications 获取供应商申请列表 渠道管理员
GET /providers/access 获取供应商访问权限 渠道管理员

3.7 平台Agent管理

方法 路径 功能描述 权限要求
GET /available-platform-agents 获取可用平台Agent 渠道管理员
POST /applications/platform-agents 申请平台Agent 渠道管理员
GET /applications/platform-agents 获取平台Agent申请列表 渠道管理员
GET /platform-agents 获取渠道平台Agent配额 渠道管理员
POST /tenants/{tenant_id}/platform-agents 分配平台Agent给租户 渠道管理员
GET /tenants/{tenant_id}/platform-agents/usage 获取租户平台Agent使用情况 渠道管理员

4. 管理员模块 (Admin)

前缀: /api/admin

4.1 管理员管理

方法 路径 功能描述 权限要求
GET /admins 获取管理员列表 super_admin
POST /admins/create 创建管理员 super_admin
DELETE /admins/{admin_id} 删除管理员 super_admin
GET /roles 获取角色列表 管理员

4.2 仪表盘

方法 路径 功能描述 权限要求
GET /dashboard/recent-logins 获取最近登录记录 管理员
GET /dashboard/stats 获取管理员仪表盘统计 管理员

4.3 租户管理

方法 路径 功能描述 权限要求
GET /tenants 获取所有租户 管理员

4.4 渠道管理

方法 路径 功能描述 权限要求
GET /channels 获取渠道列表 管理员
POST /channels/create 创建渠道 super_admin
PUT /channels/{channel_id} 更新渠道 super_admin
DELETE /channels/{channel_id} 删除渠道 super_admin
GET /channels/{channel_id}/resources 获取渠道资源 管理员
PUT /channels/{channel_id}/resources 分配渠道资源 super_admin
GET /channels/{channel_id}/allocated-resources 获取渠道资源分配详情 管理员
GET /channels/{channel_id}/tenants/resources 查看渠道租户资源分配 管理员
PUT /channels/{channel_id}/commission 更新渠道佣金 super_admin
GET /channels/{channel_id}/admins 获取渠道管理员 管理员
GET /channels/applications 获取渠道申请列表 管理员
PUT /channels/applications/{application_id}/review 审批渠道申请 super_admin

4.5 资源管理

方法 路径 功能描述 权限要求
GET /resources/allocation-stats 获取资源分配统计 管理员
GET /resources/litellm-models 获取LiteLLM模型列表 管理员
GET /resources/models 获取模型供应商列表 管理员
GET /resources/agents 获取所有Agent 管理员
DELETE /resources/agents/{agent_id} 删除Agent资源 super_admin
PUT /resources/agents/{agent_id}/config 更新Agent配置 管理员

4.6 监控

方法 路径 功能描述 权限要求
GET /monitoring/agents 监控所有Agent 管理员

4.7 计费管理

方法 路径 功能描述 权限要求
GET /billing/overview 获取计费概览 管理员

4.8 供应商申请管理

方法 路径 功能描述 权限要求
GET /providers/applications 获取供应商申请列表 管理员
PUT /providers/applications/{application_id}/review 审批供应商申请 super_admin
GET /providers/access 获取所有供应商访问记录 管理员
PUT /providers/access/{access_id} 更新供应商访问状态 管理员
DELETE /providers/access/{access_id} 撤销供应商访问 super_admin

4.9 平台Agent管理

方法 路径 功能描述 权限要求
GET /platform-agents/templates 获取平台Agent模板 管理员
PUT /platform-agents/templates/{template_name}/config 配置平台Agent模板 管理员
GET /platform-agents/templates/{template_name}/config 获取平台Agent模板配置 管理员
GET /applications/platform-agents 获取平台Agent申请列表 管理员
PUT /applications/platform-agents/{application_id}/review 审批平台Agent申请 super_admin
GET /platform-agents/allocations 获取平台Agent分配列表 管理员
POST /platform-agents/allocate 分配平台Agent给渠道 super_admin
DELETE /platform-agents/allocate 撤销渠道平台Agent super_admin
GET /platform-agents/status 获取平台Agent状态 管理员

5. 供应商管理模块 (Providers)

前缀: /api/providers

方法 路径 功能描述 权限要求
GET /models 获取所有模型供应商 需认证
POST /models/create 创建模型供应商 super_admin/provider_admin
GET /models/{provider_id} 获取供应商详情 super_admin/provider_admin
PUT /models/{provider_id} 更新供应商配置 super_admin/provider_admin
DELETE /models/{provider_id} 删除供应商 super_admin/provider_admin
POST /models/{provider_id}/test 测试供应商连接 super_admin/provider_admin

6. Agent 模块 (Agents)

前缀: /agents

6.1 模板管理

方法 路径 功能描述 权限要求
GET /templates 获取所有Agent模板 无
GET /templates/platform 获取平台Agent模板 无
GET /templates/custom 获取自定义Agent模板 无
GET /templates/{template_name} 获取模板详情 无

6.2 Agent CRUD

方法 路径 功能描述 权限要求
POST `` 创建Agent 需认证
GET `` 获取Agent列表 无
GET /{agent_id} 获取Agent详情 无
DELETE /{agent_id} 删除Agent 需认证(所有者)

6.3 Agent状态与监控

方法 路径 功能描述 权限要求
GET /{agent_id}/status 获取Agent状态 无
GET /{agent_id}/metrics 获取Agent资源使用 无

6.4 Agent执行

方法 路径 功能描述 权限要求
POST /{agent_id}/execute 执行Agent任务 需认证(所有者)

7. 会话管理模块 (Sessions)

前缀: /sessions

方法 路径 功能描述 权限要求
POST `` 创建会话 需认证
GET `` 获取会话列表 需认证
GET /{session_id} 获取会话详情 需认证
PUT /{session_id}/complete 完成会话 需认证
DELETE /{session_id} 删除会话 需认证
POST /cleanup 清理过期会话 需认证

8. 工具模块 (Tools)

前缀: /tools

方法 路径 功能描述 权限要求
GET `` 获取工具列表 需认证
GET /{tool_id} 获取工具详情 需认证
POST `` 创建工具 需认证
PUT /{tool_id} 更新工具 需认证
DELETE /{tool_id} 删除工具 需认证
GET /categories/list 获取工具分类列表 需认证

9. 系统健康检查 (Health)

前缀: 无

方法 路径 功能描述 权限要求
GET /health 系统健康检查 无

10. 指标模块 (Metrics)

前缀: 无

方法 路径 功能描述 权限要求
GET /metrics 获取Prometheus指标 无

11. 监控模块 (Monitoring)

前缀: /monitoring

方法 路径 功能描述 权限要求
GET /metrics 获取系统资源指标 无
GET /stats 获取服务统计 无
GET /trends 获取性能趋势 无
GET /alerts 获取系统告警 无
GET /dashboard 获取监控仪表盘 需认证

12. WebSocket 模块

类型 路径 功能描述 权限要求
WebSocket /ws/{agent_name_or_id} Agent WebSocket连接 无

消息类型:

  • ping/pong: 心跳消息
  • mcp_request: MCP请求
  • mcp_response: MCP响应
  • error: 错误消息
  • heartbeat: 服务端心跳
  • welcome: 连接欢迎消息

13. 计费管理模块 (Billing Admin)

前缀: /api/v1/billing

13.1 配额管理

方法 路径 功能描述 权限要求
GET /quota/user/{user_id} 获取用户配额 管理员
GET /quota/channel/{channel_id} 获取渠道配额 管理员
GET /quota/alerts 获取配额告警列表 管理员
PUT /quota/alerts/{alert_id}/acknowledge 确认配额告警 管理员
PUT /quota/alerts/{alert_id}/resolve 解决配额告警 管理员

13.2 资源管理

方法 路径 功能描述 权限要求
GET /resources/overview 获取资源概览 管理员
GET /resources/user/{user_id} 获取用户资源 管理员
GET /resources/trends 获取资源使用趋势 管理员
GET /resources/agent/{agent_id} 获取Agent资源 管理员

13.3 事件管理

方法 路径 功能描述 权限要求
GET /events/pending 获取待处理事件 管理员
POST /events/retry-failed 重试失败事件 管理员
GET /events/stats 获取事件统计 管理员

13.4 追踪管理

方法 路径 功能描述 权限要求
GET /traces/execution/{execution_id} 获取执行追踪 管理员
GET /traces 获取追踪列表 管理员
GET /traces/stats 获取追踪统计 管理员

13.5 审计日志

方法 路径 功能描述 权限要求
GET /audit/logs 获取审计日志 管理员
GET /audit/summary 获取审计摘要 管理员
GET /audit/user/{user_id}/activity 获取用户审计活动 管理员

13.6 供应商健康

方法 路径 功能描述 权限要求
GET /providers/health 获取供应商健康状态 管理员
GET /providers/{provider_id}/health 获取单个供应商健康 管理员
POST /providers/health-check 运行供应商健康检查 管理员

13.7 定价管理

方法 路径 功能描述 权限要求
GET /pricing/models 获取模型定价列表 管理员
POST /pricing/models 创建/更新模型定价 管理员
POST /pricing/calculate 计算价格 管理员

14. 计费Webhook模块 (Billing Webhook)

前缀: /api/v1/billing

方法 路径 功能描述 权限要求
POST /litellm-callback LiteLLM Token计费回调 无(系统回调)
GET /litellm-callback/health LiteLLM回调健康检查 无
POST /agent-callback Agent Manager计费回调 无(系统回调)
GET /agent-callback/health Agent回调健康检查 无

15. 配额管理模块 (Quota Management)

前缀: /api/quotas

方法 路径 功能描述 权限要求
GET /user/{user_id} 获取用户配额 管理员
GET /channel/{channel_id} 获取渠道配额 管理员
GET /alerts 获取配额告警 管理员
PUT /alerts/{alert_id}/acknowledge 确认告警 管理员
PUT /alerts/{alert_id}/resolve 解决告警 管理员

16. 定价管理模块 (Pricing Management)

前缀: /api/pricing

方法 路径 功能描述 权限要求
GET /models 获取模型定价列表 管理员
POST /models 创建/更新定价 管理员
POST /calculate 计算模型成本 管理员

17. 资源监控模块 (Resource Monitoring)

前缀: /api/resources

方法 路径 功能描述 权限要求
GET /overview 获取平台资源概览 super_admin/billing_admin/operations_admin
GET /user/{user_id} 获取用户资源摘要 super_admin/billing_admin/operations_admin
GET /trends 获取资源趋势 super_admin/billing_admin/operations_admin
GET /agent/{agent_id} 获取Agent资源统计 super_admin/billing_admin/operations_admin

18. 事件管理模块 (Event Management)

前缀: /api/events

方法 路径 功能描述 权限要求
GET /pending 获取待处理事件 super_admin/billing_admin/operations_admin
POST /retry-failed 重试失败事件 super_admin/billing_admin/operations_admin
GET /stats 获取事件统计 super_admin/billing_admin/operations_admin

19. 追踪管理模块 (Trace Management)

前缀: /api/traces

方法 路径 功能描述 权限要求
GET /execution/{execution_id} 获取执行追踪详情 super_admin/billing_admin/operations_admin
GET `` 获取追踪列表 super_admin/billing_admin/operations_admin
GET /stats 获取追踪统计 super_admin/billing_admin/operations_admin

20. 审计管理模块 (Audit Management)

前缀: /api/audit

方法 路径 功能描述 权限要求
GET /logs 获取审计日志列表 super_admin/billing_admin/operations_admin
GET /summary 获取审计摘要 super_admin/billing_admin/operations_admin
GET /user/{user_id}/activity 获取用户活动记录 super_admin/billing_admin/operations_admin

21. 供应商健康检查模块 (Provider Health)

前缀: /api/provider-health

方法 路径 功能描述 权限要求
GET /health 获取所有供应商健康状态 super_admin/billing_admin/operations_admin
GET /{provider_id}/health 获取单个供应商健康历史 super_admin/billing_admin/operations_admin
POST /health-check 执行供应商健康检查 super_admin/billing_admin

22. 前端集成模块 (Frontend Integration)

前缀: /api

此模块提供前端直接调用的简化API,用于快速原型开发和前端集成。

22.1 用户相关

方法 路径 功能描述
GET /user/dashboard/stats 用户仪表盘统计
GET /user/agents/activity 用户Agent活动
GET /user/resources/usage 用户资源使用

22.2 网关管理

方法 路径 功能描述
POST /gateway/select 选择网关
POST /gateway/api/create 创建网关API
GET /gateway/apis 获取网关API列表
GET /gateway/monitoring 网关监控

22.3 工具管理

方法 路径 功能描述
POST /tools/generate 生成工具
GET /tools/list 获取工具列表

22.4 Agent管理

方法 路径 功能描述
GET /agents/platform 平台Agent列表
POST /agents/deploy 部署Agent
GET /agents/deployed 已部署Agent列表

22.5 工作流管理

方法 路径 功能描述
POST /workflows/create 创建工作流
GET /workflows/list 工作流列表
PUT /workflows/{workflow_id} 更新工作流
DELETE /workflows/{workflow_id} 删除工作流
POST /workflows/{workflow_id}/run 运行工作流

22.6 计费管理

方法 路径 功能描述
GET /billing/balance 获取余额
GET /billing/history 计费历史
POST /billing/recharge 充值

22.7 渠道管理

方法 路径 功能描述
POST /channel/auth/login 渠道登录
GET /channel/dashboard/stats 渠道仪表盘统计
GET /channel/agents/available 可用Agent列表
GET /channel/tenants 租户列表
POST /channel/tenants/create 创建租户
PUT /channel/tenants/{tenant_id}/resources 更新租户资源
PUT /channel/tenants/{tenant_id}/billing 更新租户计费
DELETE /channel/tenants/{tenant_id} 删除租户
PUT /channel/tenants/{tenant_id}/status 更新租户状态
PUT /channel/tenants/{tenant_id}/permissions 更新租户权限
GET /channel/resources/agents 渠道Agent资源
GET /channel/resources/models 渠道模型资源
POST /channel/resources/apply 申请资源
GET /channel/billing/stats 渠道计费统计
GET /channel/admins 渠道管理员列表
POST /channel/admins/create 创建渠道管理员
PUT /channel/admins/{admin_id}/permissions 更新管理员权限

22.8 管理员

方法 路径 功能描述
POST /admin/auth/login 管理员登录
POST /admin/resources/models/add 添加模型资源
GET /admin/providers/stats 供应商统计

22.9 供应商

方法 路径 功能描述
POST /providers/auth/login 供应商登录
GET /providers/models 供应商模型列表

23. 平台Agent配额管理模块

23.1 渠道路由

前缀: /api/channel

方法 路径 功能描述 权限要求
GET /available-platform-agents 获取可用平台Agent模板 渠道管理员
POST /applications/platform-agents 创建平台Agent申请 渠道管理员
GET /applications/platform-agents 获取渠道申请列表 渠道管理员
GET /platform-agents 获取渠道平台Agent配额 渠道管理员
POST /tenants/{tenant_id}/platform-agents 分配平台Agent给租户 渠道管理员

23.2 管理员路由

前缀: /api/admin

方法 路径 功能描述 权限要求
GET /applications/platform-agents 获取所有平台Agent申请 admin/super_admin
PUT /applications/platform-agents/{application_id}/review 审批平台Agent申请 admin/super_admin
GET /platform-agents/templates 获取平台Agent模板列表 admin/super_admin
PUT /platform-agents/templates/{template_name}/config 配置平台Agent模板 admin/super_admin
GET /platform-agents/templates/{template_name}/config 获取模板配置 admin/super_admin

23.3 用户路由

前缀: /api/user

方法 路径 功能描述 权限要求
GET /platform-agents 获取用户平台Agent配额 需认证
GET /platform-agents/{template}/instances 获取用户Agent实例 需认证
DELETE /platform-agents/{agent_name} 停止平台Agent实例 需认证
GET /platform-agents/quota 获取用户配额使用情况 需认证
GET /platform-agents/{agent_name}/status 获取Agent实例状态 需认证

权限说明

角色类型

角色 说明
super_admin 超级管理员,拥有所有权限
admin 管理员,拥有大部分管理权限
billing_admin 计费管理员,管理计费相关功能
operations_admin 运营管理员,管理运营相关功能
channel_admin 渠道管理员,管理渠道内租户
provider_admin 供应商管理员,管理模型供应商
user 普通用户/租户

认证方式

  1. JWT Token: 通过 /api/auth/login 获取,放入 Authorization: Bearer <token> 头部
  2. API Key: 通过 /api/auth/keys/info 获取,放入 X-API-Key 头部

通用响应格式

成功响应

{
  "success": true,
  "data": { ... },
  "message": "操作成功"
}

错误响应

{
  "detail": "错误描述"
}

或

{
  "success": false,
  "error": "error_code",
  "message": "错误描述",
  "detail": { ... }
}

接口统计

模块 接口数量
认证模块 8
用户模块 41
渠道模块 32
管理员模块 37
供应商管理模块 6
Agent模块 11
会话管理模块 6
工具模块 6
健康检查 1
指标模块 1
监控模块 5
WebSocket 1
计费管理模块 24
计费Webhook 4
配额管理 5
定价管理 3
资源监控 4
事件管理 3
追踪管理 3
审计管理 3
供应商健康 3
前端集成 44
平台Agent配额 10

总计: 约 256 个API接口


更新日志

  • 2026-01-12: 初始版本,整理全部mcp-server API接口