← 返回 Block API 列表

获取文档信息

在 GitHub 上查看源码

POST /api/block/getDocInfo

描述

获取指定 ID 所属的文档块的基本信息，包括文档本身的 ID、所属笔记本 ID、名称和路径等。

请求参数

请求体需要是 JSON 格式。

参数名 类型 描述 必需
id string 文档内任意块的 ID。系统会根据此 ID 向上查找，定位到所属的文档块。 是

响应结果

响应体是 JSON 格式。code 为 0 表示成功。data 包含文档块的信息。


{
  "code": 0,
  "msg": "",
  "data": {
    "id": "20230101120000-docid", // 文档块 ID
    "box": "notebook-id",       // 笔记本 ID
    "name": "文档标题",          // 文档名
    "path": "/path/to/document" // 文档路径
  }
}

注意：这是一个社区维护的文档，可能与官方最新版本存在差异。

如果您觉得本文档有帮助，可以考虑赞助支持：爱发电

在线测试