tencent cloud

GetDocPreview
Last updated: 2025-10-30 21:48:54
GetDocPreview
Last updated: 2025-10-30 21:48:54

1. API Description

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

This API is used to get document preview information.

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: GetDocPreview.
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.
DocBizId Yes String Document BizID.
BotBizId Yes String Application ID.
TypeKey No String Storage type: offline - offline file; realtime - real-time file. If empty, it defaults to offline.

3. Output Parameters

Parameter Name Type Description
FileName String Filename. The release end always uses this name.
FileType String File type.
CosUrl String COS path.
Url String COS temporary url.
Bucket String COS bucket.
NewName String It is the new name in the case of document renaming. It shall be used preferentially on the evaluation end.
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

Input Example

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

{
    "DocBizId": "1681597542412103680",
    "BotBizId": "1735129619995951104"
}

Output Example

{
    "Response": {
        FileName": "26 Methods for Prevention and Control of Diseases and Pests.docx
        "FileType": "docx",
        "CosUrl": "/corp/1681586131361275904/1681597542412103680/doc/E0dQM9X41QmyAWiTQMkC-7807575532.docx",
        "Url": "https://qi***an-q**t-12***16161.cos.ap-guangzhou.myqcloud.com/%2Fcorp/1737374492379124992/17986106392328008704/doc/pXaeDgJsQEEDjryWEKwU-1806238910230430080.md",
        "Bucket": "",
        "RequestId": "7814bdbe-da7e-401e-95c4-3e861d5298ee",
        "NewName": ""
    }
}

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

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
No

Feedback