概述 - 飞书 API

飞书知识库是一个面向组织的知识管理系统。通过结构化沉淀高价值信息，形成完整的知识体系。此外，明确的内容分类，层级式的页面树，还能够轻松提升知识的流转和传播效率，更好地成就组织和个人。

资源	资源定义
知识空间	用于管理文件和其它文件夹的容器。
节点	知识空间中的节点，支持文档、表格等多种文件类型。

你可以通过知识库 API，来自动化管理你的知识库。

在调用知识库 API 之前，请确保你的应用已经按需申请了以下权限并发布：

wiki:wiki: 可以对知识库进行增删改查

wiki:wiki.readonly: 可以读取知识库内容，无法编辑或修改知识库

资源：知识空间 Workspace

知识空间是知识库的基本组成单位，是企业根据需要搭建的不同类别的知识体系，由多个具有层级和所属关系的文档页面构成。每个知识空间，都有唯一的一个 space_id 作为标识。

可以通过以下任一方法获取知识库的 space_id：

调用获取知识空间列表，从返回值中获取；

如果你是知识库管理员，可以进入知识库设置页面，复制地址栏的数字部分（见下图）：

字段说明

名称	类型	描述
space_id	string	一个知识空间的唯一标识。示例值："7034502641455497244"字段权限要求（任选其一）：查看、编辑和管理知识库查看知识库
name	string	知识空间的名称。
description	string	知识空间的描述内容。

方法列表

“商店”代表应用商店应用；“自建”代表企业自建应用

	方法 (API)	权限要求（满足任一）		访问凭证（选择其一）
创建知识空间`POST` /open-apis/wiki/v2/spaces	查看、编辑和管理知识库	user_access_token	✓	✓
获取知识空间列表`GET` /open-apis/wiki/v2/spaces	查看、编辑和管理知识库	tenant_access_tokenuser_access_token	✓	✓
获取知识空间信息`GET` open-apis/wiki/v2/spaces/:space_id	查看、编辑和管理知识库	tenant_access_tokenuser_access_token	✓	✓

资源：知识空间成员 Member

知识空间具有权限管控，仅知识空间成员能访问该知识空间。

字段说明

名称	类型	描述
member_id	string	一个知识空间成员的唯一标识。可以使用open_id, email等多种方法表示示例值："ou_51427140ab9f450411135757bcbf932f"字段权限要求（任选其一）：查看、编辑和管理知识库查看知识库

方法列表

“商店”代表应用商店应用；“自建”代表企业自建应用

	方法 (API)	权限要求（满足任一）		访问凭证（选择其一）	商店	自建
删除知识空间成员`DELETE` /open-apis/wiki/v2/spaces/:space_id/members/:member_id	查看、编辑和管理知识库	tenant_access_tokenuser_access_token	✓	✓
添加知识空间成员`POST` /open-apis/wiki/v2/spaces/:space_id/members	查看、编辑和管理知识库	tenant_access_tokenuser_access_token	✓	✓

资源：知识空间设置 Setting

方法列表

“商店”代表应用商店应用；“自建”代表企业自建应用

	方法 (API)	权限要求（满足任一）		访问凭证（选择其一）	商店	自建
更新知识空间设置`PUT` /open-apis/wiki/v2/spaces/:space_id/setting	查看、编辑和管理知识库	tenant_access_tokenuser_access_token	✓	✓

资源：节点 Node

文件是各种类型的文件的统称，泛指云空间内所有的文件。每个文件都有唯一 token 作为标识。

字段说明

名称	类型	描述
node_token	string	一个节点的唯一标识。示例值："wikcnpJLIzbAptN4cMQrQoewaLc" 字段权限要求（任选其一）：查看、编辑和管理知识库
obj_token	string	节点的真实文档的 token，如果要获取或编辑节点内容，需要使用此 token 调用对应的接口。
obj_type	string	节点的类型，可能是 doc、sheet、bitable、file、folder 中的一种。

方法列表

“商店”代表应用商店应用；“自建”代表企业自建应用

	方法 (API)	权限要求（满足任一）		访问凭证（选择其一）
创建节点`POST` /open-apis/wiki/v2/spaces/:space_id/nodes	查看、编辑和管理知识库	tenant_access_tokenuser_access_token	✓	✓
获取子节点列表`GET` /open-apis/wiki/v2/spaces/:space_id/nodes	查看、编辑和管理知识库查看知识库	tenant_access_tokenuser_access_token	✓	✓
获取节点信息`GET` /open-apis/wiki/v2/spaces/get_node	查看、编辑和管理知识库查看知识库	tenant_access_tokenuser_access_token	✓	✓
添加已有云文档至知识库`POST` /open-apis/wiki/v2/spaces/:space_id/nodes/move_docs_to_wiki	查看、编辑和管理知识库	tenant_access_tokenuser_access_token	✓	✓
知识空间内移动节点`POST` /open-apis/wiki/v2/spaces/:space_id/nodes/:node_token/move	查看、编辑和管理知识库	tenant_access_tokenuser_access_token	✓	✓

资源：任务 Task

对于耗时比较长的操作，例如添加已有云文档至知识库，会以异步任务来表示。

字段说明

名称	类型	描述
task_id	string	一个知识空间的唯一标识。示例值："7078885194417045524-8316a3d38e2ef0e7c69149d3db4590ec031d9cbc"字段权限要求（任选其一）：查看、编辑和管理知识库查看知识库

方法列表

“商店”代表应用商店应用；“自建”代表企业自建应用

	方法 (API)	权限要求（满足任一）		访问凭证（选择其一）	商店	自建
获取任务结果`GET` /open-apis/wiki/v2/tasks/:task_id	查看、编辑和管理知识库查看知识库	tenant_access_tokenuser_access_token	✓	✓

权限说明

知识空间具有灵活的权限管控，以下描述通常涉及的权限点位。接口具体权限要求请查看接口文档知识库权限要求。

节点阅读权限

允许查看节点/文档。

拥有编辑权限时自动拥有阅读权限。

容器编辑权限

允许编辑文档。允许添加/删除子节点。

知识空间管理员拥有所有节点的容器编辑权限，且不可移除。

单页面编辑权限

允许编辑文档。但不允许添加/删除子节点。

知识空间成员默认权限

知识空间成员默认权限为阅读权限，可以在知识空间设置页修改。

应用/机器人如何获得权限

有两种途径：添加为知识空间成员/管理员或添加为文档协作者。

添加为知识空间成员/管理员。

添加为文档协作者。

概述

资源：知识空间 Workspace#

字段说明#

方法列表#

资源：知识空间成员 Member#

字段说明#

方法列表#

资源：知识空间设置 Setting#

方法列表#

资源：节点 Node#

字段说明#

方法列表#

资源：任务 Task#

字段说明#

方法列表#

权限说明#

节点阅读权限#

容器编辑权限#

单页面编辑权限#

知识空间成员默认权限#

应用/机器人如何获得权限#

资源：知识空间 Workspace

字段说明

方法列表

资源：知识空间成员 Member

字段说明

方法列表

资源：知识空间设置 Setting

方法列表

资源：节点 Node

字段说明

方法列表

资源：任务 Task

字段说明

方法列表

权限说明

节点阅读权限

容器编辑权限

单页面编辑权限

知识空间成员默认权限

应用/机器人如何获得权限