Appearance
租户服务端 API 总览
租户服务端 API 是知办AI开放给租户外部系统 / 租户自建 Agent 服务的 REST 接口,统一前缀 /api/external/v1/*。调用方是你们自己的系统,接收方是知办AI服务器;这些接口只能读取本租户数据、调用本租户授权能力。
方向上怎么区分
- 服务端 API:你的外部系统或租户自建 Agent 服务主动调用知办AI服务器,例如检索知识库、同步组织、发送通知。
- 自定义 Agent Runtime 接入:知办AI服务器主动调用你的 Agent 服务,把用户消息交给它处理;主线是
/zap/v1/*协议,见 租户自定义 Agent Runtime 接入。 - Agent 间协作 A2A:一个数字员工 Runtime 在处理当前消息时调用另一个数字员工;它走 Runtime access token 和 SDK A2A helper,主入口见 Agent 间协作 A2A,不属于普通服务端 API。
已开放的能力域
| 能力域 | 路径前缀 | 典型场景 | 详细文档 |
|---|---|---|---|
| 鉴权 | /api/external/v1/oauth/token | 用 Agent SDK 凭证换 Session Token | 鉴权与凭证 |
| 知识库 | /api/external/v1/knowledge-bases/* | 同步知识库、上传文档、语义检索(RAG) | 知识库 API 指南 |
| 记忆 | /api/external/v1/memories/* | 召回 / 写入数字员工的长期与会话记忆 | 记忆 API 指南 |
| 组织与人员 | /api/external/v1/org/* | 同步部门、成员、职位;支持增量回查 | 组织与人员 API 指南 |
| 系统通知 | /api/external/v1/notifications/* | 外部系统触发站内消息通知,点击进入指定知办数字员工对话 | 系统通知 API 指南 |
| 主动发送聊天消息 | /api/external/v1/chat/messages | 外部系统或租户自建 Agent 服务按 EMP 标准向数字员工直聊写入结构化消息 | 主动发送聊天消息 API 指南 |
更多能力域(云盘、技能等)将陆续开放,见 API 列表 · 路线图。新能力域上线后会在本页和侧边栏各自增加独立指南。
调用前你需要
- 一个凭证:API Key(
ek_,外部系统长期持有)或 Session Token(st_,租户自建 Agent 服务运行时短期使用),申请和用法见 鉴权与凭证。 - 凭证勾选了对应能力域的权限范围(scope),按最小权限申请。
所有接口统一 Authorization: Bearer <token>,统一响应结构和错误码见 API 列表。