API 参考
Manager 管理 API 的完整参考文档由 FastAPI 自动生成(Swagger UI),与代码保持同步。
OpenAPI Swagger
如上方空白,可 单独打开 API 参考。
说明
- 认证方式:大部分端点需要
Authorization: Bearer <JWT>头。认证体系按账号类型分离:管理台账号走/api/manager/auth/login获取 JWT(payload 含aud: "admin");终端门户账号走/api/manager/auth/enduser/login(payload 含aud: "enduser"),两类 token 不可跨体系使用 - 工作空间:资源类端点接受
X-Org-ID头指定当前工作空间——值为账号中心组织 ID(GET /api/manager/workspaces返回的account_org_id);all仅平台超管可用(跨空间查看);legacy表示存量平台手工资源;不带该头时按旧行为不做空间收敛。部门空间再带X-Workspace-Group-ID(空间列表部门项的group_id),资源可见范围为该部门及其子部门。新建资源不传group_id时自动归属当前空间(个人/组织空间为根组,部门空间为选中部门);组织空间对普通成员只读 - OpenAI 兼容 API:智能体调用走
/v1/*路径,使用sk-API Key 鉴权(详见 API 调用指导) - 分组:端点按模块分组(auth / users / roles / agent-definitions / agent-instances / observability / conversations 等),可在 Swagger 顶部按 tag 筛选
主要模块
| 模块 | 路径前缀 | 用途 |
|---|---|---|
| 认证 | /api/manager/auth | 登录、刷新 token、当前用户信息;终端侧登录入口为 /api/manager/auth/enduser/* |
| 工作空间 | /api/manager/workspaces | 当前账号可见空间列表(个人 / 组织 / 部门 / 默认空间 / 全部空间)与默认空间;组织分页 org_limit/org_offset,部门可按组织懒加载(include_departments=false + /workspaces/departments);平台超管可按姓名/邮箱搜索他人个人空间(/workspaces/personal-spaces,只读) |
| 用户 | /api/manager/users | 用户查询、角色绑定(生命周期在账号中心管理) |
| 角色 | /api/manager/roles | 角色 CRUD、权限分配 |
| 用户组 | /api/manager/user-groups | 用户组(租户隔离单元)只读查询 |
| 个人额度 | /api/manager/ops/user-quotas、/api/manager/user-quotas/me | 个人空间额度:列表 / 覆盖在运营侧(仅平台员工,分页 + 搜索);/me 为本人额度与用量查询(需空间头) |
| 运营控制台 | /api/manager/ops | 运营侧检索(租户列表 / 详情、终端用户处置)。平台员工跨租户;租户 owner/admin 需带企业空间头,仅限本租户 |
| 终端用户 | /api/manager/end-users | 终端用户新增/查询、组归属、禁用/重置密码 |
| 智能体定义 | /api/manager/agent-definitions | 智能体模版定义 |
| 智能体实例 | /api/manager/agent-instances | 实例化、部署、API Key 管理 |
| 外部应用 | /api/manager/external-apps | 外部应用接入管理;外部用户绑定见 /api/manager/end-users/{id}/external-user-bindings |
| 引擎配置 | /api/manager/engine-configs | 引擎运行参数与配置管理 |
| 模型网关 | /api/manager/litellm | 模型与供应商目录、连接测试、价格、API Key 与用量管理;新建/编辑模型支持 provider_preset + 按供应商声明的 provider_params,旧 api_key/api_base/custom_llm_provider 请求仍兼容 |
| 产品设置 | /api/manager/system-settings | ASR / AI 生成 / 品牌白牌配置管理;公开品牌信息见 /api/manager/branding |
| 监控中心 | /api/manager/observability | 链路追踪 / 用量 / 告警 |
| 对话记录 | /api/manager/conversations | 会话列表 / 聚合统计 / 会话详情 |
| 社区 | /api/manager/community | 技术文章(公开可读) |
| OpenAI 兼容 | /v1/* | 智能体调用(sk- 鉴权) |