快速开始

知办AI 对外 API · 5 分钟跑通第一个调用。

这是什么

知办AI 把租户的知识库、组织与人员等业务数据通过 HTTP 接口对外开放。你可以：

拉数据到自家系统（CRM / BI / 数据中台）
让接入方 Agent 服务实时取数（对话时检索知识库）
在线试一下（不写代码）→ API 在线调试

5 分钟跑通

只看一段，跟着做：

① 拿一把 API Key（1 分钟）

去知办AI 后台：

左侧菜单 → 凭证与接入 → API Key 管理 → + 新建 Key

填名称 + 勾「知识库读取」即可，点创建 → 立刻复制弹出的明文密钥（关闭后再也看不到）。

详细操作见 API Key 管理（操作手册）。

② 拿一个知识库的编号（30 秒）

左侧菜单 → 知识库 → 知识库管理 → 找任意一行 → 复制「编号」列

形如 kb-a1b2c3d4...。

③ 发第一个请求（30 秒）

把上面两个值填进去：

curlPythonGo

bash

curl -H "Authorization: Bearer ek_a1b2c3d4_QwErTy..." \
  https://zhiban.creditease.corp/api/external/v1/knowledge-bases/kb-a1b2c3d4.../documents

python

import httpx
r = httpx.get(
    "https://zhiban.creditease.corp/api/external/v1/knowledge-bases/kb-a1b2c3d4.../documents",
    headers={"Authorization": "Bearer ek_a1b2c3d4_QwErTy..."},
)
print(r.json())

req, _ := http.NewRequest("GET",
    "https://zhiban.creditease.corp/api/external/v1/knowledge-bases/kb-a1b2c3d4.../documents", nil)
req.Header.Set("Authorization", "Bearer ek_a1b2c3d4_QwErTy...")
resp, _ := http.DefaultClient.Do(req)

返回示例：

json

{
  "data": [
    {
      "uuid": "doc-...",
      "title": "产品白皮书 v3.pdf",
      "mime_type": "application/pdf",
      "chunk_count": 87,
      "status": "ready"
    }
  ],
  "meta": { "request_id": "req_...", "page": { "total": 23 } }
}

不想写代码？

直接打开 API 在线调试，顶部填 Bearer <你的 Key>，左侧选接口 → Try it out → 看返回。

下一步：按场景深入

我要做什么	看哪里
把企业 H5 应用挂到知办AI，并完成用户单点登录	单点登录接入
让外部业务系统长期读知办AI 数据	鉴权与凭证 → API Key
让接入方 Agent 服务运行时取数	鉴权与凭证 → Session Token
对接 HR / IAM / OA，同步成员、部门、职位	组织与人员 API 指南
把接入方 Agent Runtime 接入知办AI 数字员工	自定义 Agent Runtime 接入
想先看接好之后的完整效果	示例场景
想看平台开放了哪些能力域	服务端 API 总览
想看 Bus 和接入方 Runtime 的消息流	ZAP 消息协议
想看聊天里支持哪些图表、表单、审批、文件组件	EMP 组件清单
想看完整接口列表	API 列表
已经接入，需同步字段、SDK、ZAP/A2A 或应用 SSO	2026-07-15 已接入方迁移指南
想直接试一试，不写代码	API 在线调试

接入路径对比

                       ┌────────────────────┐
                       │  你的接入需求        │
                       └──────────┬─────────┘
                                  │
              ┌───────────────────┼───────────────────┐
              ▼                   ▼                   ▼
       ┌──────────────┐    ┌──────────────┐    ┌──────────────┐
       │ 业务系统取数 │    │ 接入方服务取数│    │ Runtime 接入  │
       │ (CRM/BI/ETL) │    │ (对话时检索) │    │ (成为数字员工)│
       └──────┬───────┘    └──────┬───────┘    └──────┬───────┘
              ▼                   ▼                   ▼
        API Key (ek_)      Session Token (st_)   双向接入
        长期持有            60min, 自动续         Step 1-4
              │                   │                   │
              ▼                   ▼                   ▼
        《鉴权与凭证》       《鉴权与凭证》         《自定义 Agent Runtime
         API Key 段          Session Token 段       接入》全篇

关键约束

域名：测试用 *-test.creditease.corp，生产用 zhiban.creditease.corp（具体向对接同事确认）
凭证只显示一次：API Key 和 client_secret 创建时弹出后无法再查看，立即复制保管
限流：单 Key 默认 100 QPS，超限返 429 rate_limited
协议：所有接口 HTTPS（HTTP 仅本地测试）
错误码统一：401 invalid_api_key / 403 scope_denied / 404 not_found 等，详见 API 列表 · 错误码

常见疑问

接入要走审批吗？ 不需要。租户管理员有权自己签发 API Key 和 Agent SDK 凭证。

测试 / 生产环境凭证通用吗？ 不通用。每个环境单独申请。

SDK 有吗？ Python / Go 两种官方 SDK。Python SDK 当前包含外部 API Client 与 ZAP Runtime SDK，见自定义 Agent Runtime 接入；其它语言用 HTTP 直调即可。

接口能写数据吗（上传文档 / 创建 KB / 同步组织数据）？ 可以。知识库支持创建 KB、上传文档；组织与人员支持部门、成员、职位的增删改查。未开放的接口见 API 列表 · 路线图。

快速开始 ​

5 分钟跑通 ​

① 拿一把 API Key（1 分钟） ​

② 拿一个知识库的编号（30 秒） ​

③ 发第一个请求（30 秒） ​

下一步：按场景深入 ​

接入路径对比 ​

关键约束 ​

常见疑问 ​