接入指南
形态
块列表
| 类型 | 描述 |
|---|---|
| page | 文档 Block，是整个文档树的根节点 |
| text | 文本 Block |
| headingN | 标题 Block，headingN，N 取值范围1~9 |
| bullet | 无序列表 Block |
| ordered | 有序列表 Block |
| code | 代码块 Block |
| quote | 引用 Block |
| todo | 任务 Block |
| bitable | 多维表格 Block |
| callout | 高亮块 Block |
| chat_card | 会话卡片 Block |
| diagram | UML 图 Block |
| divider | 分割线 Block |
| file | 文件 Block |
| grid | 分栏 Block |
| grid_column | 分栏列 Block |
| iframe | 内嵌 Block |
| image | 图片 Block |
| isv | 三方 Block |
| mindnote | 思维笔记 Block |
| sheet | 电子表格 Block |
| table | 表格 Block |
| table_cell | 单元格 Block |
| view | 视图 Block |
| quote_container | 引用容器 Block |
| task | 任务 Block |
| okr | OKR Block |
| okr_objective | OKR Objective Block |
| okr_key_result | OKR Key Result Block |
| okr_progress | OKR 进展 Block |
| undefined | 未支持 Block |
限制
QPS 限制
接口错误
能力边界
| Block | 创建 | 读取内容 | 编辑内容 |
|---|---|---|---|
| Callout | 支持 | 支持 | 支持 |
| Table | 支持 | 支持 | 支持 |
| Text | 支持 | 支持 | 支持 |
| Divider | 支持 | - | - |
| Grid | 支持 | 支持 | 支持 |
| Iframe | 支持 | 支持 | 不支持 |
| ChatCard | 支持 | - | - |
| Image | 支持 | - | - |
| File | 支持 | - | - |
| TableCell | - | 支持 | 支持 |
| GridColumn | - | 支 持 | 支持 |
| View | - | 支持 | 不支持 |
| ISV | 支持 | - | - |
| Bitable | 支持 | - | - |
| Sheet | 支持 | - | - |
| Mindnote | 不支持 | - | - |
| Diagram | 不支持 | 不支持 | 不支持 |
| QuoteContainer | 支持 | 支持 | 支持 |
| Task | 不支持 | - | - |
| OKR | 支持 | 支持 | - |
| OKR Objective | - | 支持 | - |
| OKR Key Result | - | 支持 | - |
| OKR Progress | - | 支持 | - |
| Undefined | - | - | - |
- 表示不在支持范围内，比如： 1.不支持直接创建 TableCell，因为在对Table添加行或列时，会自动创建TableCell；2.不支持直接读取 Bitable，可根据返回的BitableToken 调用对应的Bitable开放接口。
查询文档基本信息
查询文档纯文本内容
获取文档所有块
创建文档
folder_token 参数指定云空间目录。获取块
此接口不会返回子块信息, 如需获取请结合使用 「获取所有子块」。
创建块
如不指定版本，默认使用最新版本。
更新块
如不指定版本，默认 使用最新版本
批量更新块
如不指定版本，默认使用最新版本
删除块
我们可以将新版文档看成一颗 Block 树，删除块可看成是删除其父亲块的孩子，即先明确要删除的块是其父亲块的第几个孩子，然后再调用本接口进行删除。
获取所有子块
此接口仅返回子块的富文本内容。
扫码加入交流群修改于 2023-01-13 08:33:16