更新时间:2026-10-22 GMT+08:00
分享

创建page文档 - CreatePage

功能介绍

该接口用于创建带内容的page文档。

URI

POST /v1/app/aipage

请求参数

表1 请求Header参数

参数

是否必选

参数类型

描述

Authorization

是

String

参数解释:

认证凭证。

约束限制:

格式:Bearer {access_token}。

取值范围:

[1-1024]个字符。

默认取值:

不涉及。

X-Cloud-Doc-AppId

是

String

参数解释:

集成方应用ID。

约束限制:

不涉及。

取值范围:

[1-128]个字符。

默认取值:

不涉及。

表2 请求Body参数

参数

是否必选

参数类型

描述

parent_document_id

否

String

参数解释:

父级文档ID。

约束限制:

不涉及。

取值范围:

[1-64]个字符。

默认取值:

不涉及。

title

否

String

参数解释:

文档标题。

约束限制:

不涉及。

取值范围:

[1-255]个字符。

默认取值:

不涉及。

format

否

Integer

参数解释:

不涉及。

约束限制:

不涉及。

取值范围:

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

1:markdown。

默认取值:

1。

content

否

String

参数解释:

文档内容,可以是markdown或者文档json,由format决定。

约束限制:

不涉及。

取值范围:

不涉及。

默认取值:

不涉及。

响应参数

状态码:200

表3 响应Body参数

参数

参数类型

描述

document_id

String

参数解释:

文档ID。

取值范围:

[1-64]个字符。

title

String

参数解释:

标题。

取值范围:

[1-255]个字符。

create_time

String

参数解释:

创建时间。

取值范围:

不涉及。

状态码:400

表4 响应Body参数

参数

参数类型

描述

error_code

String

错误码。

error_msg

String

错误描述。

请求示例

创建一篇page文档,父文档id为doc_parent_001。

 POST https://{Endpoint}/v1/app/aipage

{
  "parent_document_id" : "doc_parent_001",
  "title" : "产品技术方案",
  "content" : "# 方案描述"
}

响应示例

状态码:200

请求成功。

{
  "document_id" : "doc_1a2b3c4d",
  "title" : "接口设计规范",
  "create_time" : "2026-09-18 10:00:00"
}

状态码:400

错误响应。

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

状态码

状态码

描述

200

请求成功。

400

错误响应。

错误码

请参见错误码。

相关文档