DescribeDoc

Last updated: 2025-10-30 21:48:56

DescribeDoc

Last updated: 2025-10-30 21:48:56

1. API Description

Domain name for API request: lke.intl.tencentcloudapi.com.

This API is used to query document details.

A maximum of 100 requests can be initiated per second for this API.

We recommend you to use API Explorer

Try it

API Explorer provides a range of capabilities, including online call, signature authentication, SDK code generation, and API quick search. It enables you to view the request, response, and auto-generated examples.

2. Input Parameters

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: 2023-11-30.
Region	Yes	String	Common Params. For more information, please see the list of regions supported by the product. This API only supports: ap-jakarta.
BotBizId	Yes	String	Application ID
DocBizId	Yes	String	Document ID.

3. Output Parameters

Parameter Name	Type	Description
DocBizId	String	Document ID.
FileName	String	File name.
FileType	String	File type.
CosUrl	String	COS path.
UpdateTime	String	Update time.
Status	Integer	Document status : 1: not generated; 2: generating; 3: generation successful; 4: generation failed; 5: deleting; 6: deleted successfully; 7: under review; 8: review failed; 9: review successful; 10: pending release; 11: releasing; 12: released; 13: learning; 14: learning failed; 15: updating; 16: update failed; 17: parsing; 18: parsing failed; 19: import failed; 20: expired; 21: excessive invalid; 22: excessive invalid recovered.
StatusDesc	String	Document status description.
Reason	String	Reason for generation failure.
IsRefer	Boolean	Whether to refer in the answer.
QaNum	Integer	Number of Q&A pairs.
IsDeleted	Boolean	Whether to delete.
Source	Integer	Document source.
SourceDesc	String	Document source description.
IsAllowRestart	Boolean	Whether regeneration is allowed.
IsDeletedQa	Boolean	Whether Q&A has been deleted.
IsCreatingQa	Boolean	Whether Q&A is being generated.
IsAllowDelete	Boolean	Whether deletion is allowed.
IsAllowRefer	Boolean	Whether to allow operation reference switch.
IsCreatedQa	Boolean	Whether Q&A has been generated.
DocCharSize	String	Document character count.
IsAllowEdit	Boolean	Whether editing is allowed.
AttrRange	Integer	Applicable scope of labels 1: all, 2: by condition range.
AttrLabels	Array of AttrLabel	Label.
CateBizId	String	Category ID.
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.

4. Example

Example1 Document Details

Input Example

POST / HTTP/1.1
Host: lke.intl.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeDoc
<Common request parameters>

{
    "BotBizId": "1727231073371148288",
    "DocBizId": "1729099536210460672"
}

Output Example

{
    "Response": {
        "RequestId": "17467eb0-3f01-4bc8-af86-3f3b6b01a40c",
        "IsAllowDelete": true,
        "IsCreatedQa": false,
        "IsDeleted": false,
        "SourceDesc": "Web import"
        "UpdateTime": "1701427403",
        "DocBizId": "1729099536210460672",
        "DocCharSize": "5",
        "FileName": "jkadslfjalkdfjaklsdfla.docx",
        "IsAllowEdit": false,
        "IsDeletedQa": false,
        "AttrLabels": [],
        "AttrRange": 1,
        "CosUrl": "/corp/137/doc/jkadslfjalkdfjaklsdfla.docx",
        "IsAllowRefer": false,
        "IsCreatingQa": false,
        "Source": 1,
        "QaNum": 0,
        "Reason": "",
        "Status": 14,
        "StatusDesc": "Learning failed"
        "FileType": "docx",
        "IsAllowRestart": true,
        "IsRefer": false
    }
}

5. Developer Resources

SDK

TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.

Command Line Interface

Tencent Cloud CLI 3.0

6. Error Code

The following only lists the error codes related to the API business logic. For other error codes, see Common Error Codes.

Error Code	Description
FailedOperation	Operation failed.

Was this page helpful?

You can also Contact Sales or Submit a Ticket for help.

Yes

Feedback

tencent cloud