Domain name for API request: adp.intl.tencentcloudapi.com.
Queries the details of a document.
A maximum of 20 requests can be initiated per second for this API.
The following request parameter list only provides API request parameters and some common parameters. For the complete common parameter list, see Common Request Parameters.
| Parameter Name | Required | Type | Description |
|---|---|---|---|
| Action | Yes | String | Common Params. The value used for this API: DescribeDoc. |
| Version | Yes | String | Common Params. The value used for this API: 2026-05-20. |
| Region | Yes | String | Common Params. For more information, please see the list of regions supported by the product. |
| DocId | Yes | String | Document ID |
| KbId | Yes | String | ID of the knowledge base it belongs to |
| ReadMask | No | FieldMask | Field mask: Currently supported Path: DocLink.CosUrl. Other unlisted fields are returned by default. |
| Parameter Name | Type | Description |
|---|---|---|
| DocLink | DocLink | Documentation link (external URL + COS link) |
| ParseConfig | DocParseConfig | Parsing configuration (split rule, content filtering, etc.) |
| Summary | DocSummary | Basic document information |
| Switch | DocSwitch | Switch configuration |
| UpdatePeriod | DocUpdatePeriod | Update cycle configuration |
| UserAccessConfig | UserAccessConfig | User access configuration |
| RequestId | String | The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem. |
Query document details
POST / HTTP/1.1
Host: adp.intl.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeDoc
<Common request parameters>
{
"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": [
Product inquiry
]
},
"DocId": "50001",
"KnowledgeScope": {
"EffectiveDomain": 4,
"LabelRefList": [
{
"LabelId": "30001",
"LabelName": "Consultation intent",
"LabelTermIdList": [
"1"
],
"LabelTermList": [
Price.
]
}
]
},
"Lifecycle": {
"CreateTime": "1735689600",
"ExpirationPolicy": {
"EffectivePeriod": {
"EndTime": "0",
"StartTime": "1735689600"
}
},
"Status": 8,
"StatusDesc": "Import complete",
"StatusMessage": "",
"UpdateTime": "1736294400"
},
"Metadata": {
"DocCharCount": "15320",
"FileName": "Billing description.pdf",
"FileSize": "204800",
"FileType": "pdf",
"RefFieldNameList": [
Product consultation/Billing consultation
],
"SourceDesc": "Local upload"
"SourceType": 1
},
"OperatorInfo": {
"Modifier": {
"UserId": "u_10001",
"UserName": "Zhang San"
},
"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"
}
}TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.
There is no error code related to the API business logic. For other error codes, please see Common Error Codes.
フィードバック