tencent cloud

ListDoc
Last updated: 2025-10-30 21:48:53
ListDoc
Last updated: 2025-10-30 21:48:53

1. API Description

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

This API is used to get document list.

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: ListDoc.
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.
PageNumber Yes Integer Page number.
PageSize Yes Integer Quantity per page.
Query No String Query content.
Status.N No Array of 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.
QueryType No String Query type: filename - document; attribute - label.
CateBizId No String Category ID.
FileTypes.N No Array of String File type classification and filtering.
FilterFlag.N No Array of DocFilterFlag Document list filter flag

3. Output Parameters

Parameter Name Type Description
Total String Quantity of documents.
List Array of ListDocItem List of documents.
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 List

Input Example

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

{
    "BotBizId": "1727231073371148288",
    "PageNumber": 1,
    "PageSize": 10
}

Output Example

{
    "Response": {
        "List": [
            {
                "AttrLabels": [],
                "AttrRange": 1,
                "CosUrl": "/corp/137/doc/jkadslfjalkdfjaklsdfla.docx",
                "DocBizId": "1729099536210460672",
                "DocCharSize": "5",
                "FileName": "jkadslfjalkdfjaklsdfla.docx",
                "NewName": "",
                "FileType": "docx",
                "IsAllowDelete": true,
                "IsAllowEdit": true,
                "IsAllowRefer": true,
                "IsAllowRestart": true,
                "IsCreatedQa": true,
                "IsCreatingQa": false,
                "IsDeleted": false,
                "IsDeletedQa": false,
                "IsRefer": false,
                "QaNum": 2,
                Reason": "Q&A generated successfully",
                "Source": 1,
                SourceDesc": "Web import",
                "Status": 12,
                StatusDesc": "Released",
                "WebUrl": "",
                "ReferUrlType": 0,
                "UpdateTime": "1701425246"
            }
        ],
        "RequestId": "5526c65b-308d-4e84-b6b3-6b21d5c106b2",
        "Total": "1"
    }
}

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

6. Error Code

There is no error code related to the API business logic. For other error codes, please see Common Error Codes.

Was this page helpful?
You can also Contact Sales or Submit a Ticket for help.
Yes
No

Feedback