文档首页/ 华为云DocZip智能文档服务/ API参考/ API/ Page文档管理/ 读取page文档 - ListPage
更新时间：2026-10-22 GMT+08:00
查看PDF
分享

读取page文档 - ListPage

功能介绍

读取page文档。

URI

POST /v1/app/aipage/{document_id}/fetch

表1 路径参数

参数

是否必选

参数类型

描述

document_id

是

String

参数解释：

文档ID。

约束限制：

不涉及。

取值范围：

[1-64]个字符。

默认取值：

不涉及。

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

Authorization

是

String

参数解释：

认证凭证。

约束限制：

格式：Bearer {access_token}。

取值范围：

[1-1024]个字符。

默认取值：

不涉及。

X-Cloud-Doc-AppId

是

String

参数解释：

集成方应用ID。

约束限制：

不涉及。

取值范围：

[1-128]个字符。

默认取值：

不涉及。
表3 请求Body参数

参数

是否必选

参数类型

描述

format

否

Integer

参数解释：

文档内容。

约束限制：

不涉及。

取值范围：

0：云文档Page标准格式json。

1：markdown。

默认取值：

1。

read_option

否

read_option object

参数解释：

局部读取参数。

约束限制：

全文时不传。

取值范围：

不涉及。

默认取值：

不涉及。
表4 read_option

参数

是否必选

参数类型

描述

start_block_id

否

String

参数解释：

range起点。

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及。

end_block_id

否

String

参数解释：

range终点。

约束限制：

不传表示到文末。

取值范围：

不涉及。

默认取值：

不涉及。

响应参数

状态码：200

表5 响应Body参数

参数

参数类型

描述

document_id

String

参数解释：

文档ID。

取值范围：

[1-64]个字符。

content

String

参数解释：

获取的文档内容。

取值范围：

不涉及。

状态码：400

表6 响应Body参数

参数

参数类型

描述

error_code

String

错误码。

error_msg

String

错误描述。

请求示例

获取文档id为d37XXXXX1-0fb8-4926-8f3X-67XXXX11的文档块数据。

POST https://{Endpoint}/v1/app/aipage/d37XXXXX1-0fb8-4926-8f3X-67XXXX11/fetch

{
  "format" : 1,
  "read_option" : {
    "start_block_id" : "string",
    "end_block_id" : "string"
  }
}

响应示例

状态码：200

请求成功。

{
  "document_id" : "doc_1a2b3c4d",
  "content" : "文档块json内容..."
}

状态码：400

错误响应。

{
  "error_code" : "KPGE.00001000",
  "error_msg" : "Parameter error."
}

状态码

状态码

描述

200

请求成功。

400

错误响应。

错误码

请参见错误码。

父主题： Page文档管理

相关文档