1. 接口描述
接口请求域名： adp.tencentcloudapi.com 。
查询文档详情
默认接口请求频率限制：20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见 公共请求参数。
| 参数名称 | 必选 | 类型 | 描述 |
|---|---|---|---|
| Action | 是 | String | 公共参数，本接口取值：DescribeDoc。 |
| Version | 是 | String | 公共参数，本接口取值：2026-05-20。 |
| Region | 是 | String | 公共参数，详见产品支持的 地域列表。 |
| DocId | 是 | String | 文档 ID 示例值：2067622575842400832 |
| KbId | 是 | String | 所属知识库 ID 示例值：2067622575842400832 |
| ReadMask | 否 | FieldMask | 字段掩码：当前支持的 Path：DocLink.CosUrl，其他未列举的字段默认都返回 |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| DocLink | DocLink | 文档链接（外部链接 + COS 链接） 注意：此字段可能返回 null，表示取不到有效值。 |
| ParseConfig | DocParseConfig | 解析配置（分割规则、内容过滤等） 注意：此字段可能返回 null，表示取不到有效值。 |
| Summary | DocSummary | 文档基础信息 注意：此字段可能返回 null，表示取不到有效值。 |
| Switch | DocSwitch | 开关配置 注意：此字段可能返回 null，表示取不到有效值。 |
| UpdatePeriod | DocUpdatePeriod | 更新周期配置 注意：此字段可能返回 null，表示取不到有效值。 |
| UserAccessConfig | UserAccessConfig | 用户访问配置 注意：此字段可能返回 null，表示取不到有效值。 |
| RequestId | String | 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 查询文档详情
查询文档详情
输入示例
POST / HTTP/1.1
Host: adp.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeDoc
<公共请求参数>
{
"DocId": "2067622575842400832",
"KbId": "2067622575842400832"
}输出示例
{
"Response": {
"DocLink": {
"CosUrl": "https://cos.example.com/kb/50001/billing.pdf?sign=xxx",
"ExternalLink": {
"ExternalUrl": "https://example.com/docs/billing.html",
"ReplaceOriginEnabled": false
}
},
"ParseConfig": {
"ContentFilter": {
"ImageMinHeight": 64,
"ImageMinWidth": 64,
"ImageNamePatterns": "icon;logo;banner.*"
},
"SplitRule": "chapter"
},
"Summary": {
"CategoryPath": {
"CategoryId": "1002",
"CategoryIdPath": [
"1001"
],
"CategoryNamePath": [
"产品咨询"
]
},
"DocId": "50001",
"KnowledgeScope": {
"EffectiveDomain": 4,
"LabelRefList": [
{
"LabelId": "30001",
"LabelName": "咨询意图",
"LabelTermIdList": [
"1"
],
"LabelTermList": [
"价格"
]
}
]
},
"Lifecycle": {
"CreateTime": "1735689600",
"ExpirationPolicy": {
"EffectivePeriod": {
"EndTime": "0",
"StartTime": "1735689600"
}
},
"Status": 8,
"StatusDesc": "导入完成",
"StatusMessage": "",
"UpdateTime": "1736294400"
},
"Metadata": {
"DocCharCount": "15320",
"FileName": "计费说明.pdf",
"FileSize": "204800",
"FileType": "pdf",
"RefFieldNameList": [
"产品咨询/计费咨询"
],
"SourceDesc": "本地上传",
"SourceType": 1
},
"OperatorInfo": {
"Modifier": {
"UserId": "u_10001",
"UserName": "张三"
},
"Permission": {
"CanDelete": true,
"CanEdit": true,
"CanRestart": true,
"CanRetry": false
}
},
"TaskStatus": {
"CompletedTaskTypeList": [
1
],
"OngoingTaskTypeList": []
}
},
"Switch": {
"DownloadEnabled": true,
"ReferEnabled": true
},
"UpdatePeriod": {
"Enabled": true,
"PeriodHour": 24
},
"UserAccessConfig": {
"CustomerKnowledgeId": "cust-doc-abc-001",
"IsPublic": true
},
"RequestId": "8d87d655-d6d6-45ca-9034-d37d3b003249"
}
}5. 开发者资源
腾讯云 API 平台
腾讯云 API 平台 是综合 API 文档、错误码、API Explorer 及 SDK 等资源的统一查询平台，方便您从同一入口查询及使用腾讯云提供的所有 API 服务。
API Inspector
用户可通过 API Inspector 查看控制台每一步操作关联的 API 调用情况，并自动生成各语言版本的 API 代码，也可前往 API Explorer 进行在线调试。
SDK
云 API 3.0 提供了配套的开发工具集（SDK），支持多种编程语言，能更方便的调用 API。
- Tencent Cloud SDK 3.0 for Python: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for Java: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for PHP: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for Go: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for Node.js: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for .NET: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for C++: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for Ruby: CNB, GitHub, Gitee
命令行工具
6. 错误码
该接口暂无业务逻辑相关的错误码，其他错误码详见 公共错误码。
