GetReconstructDocumentResult

Last updated:2025-10-30 21:49:04

GetReconstructDocumentResult

Last updated: 2025-10-30 21:49:04

1. API Description

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

This is an asynchronous APIs, used to get document parsing task results.

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: GetReconstructDocumentResult.
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-guangzhou.
TaskId	Yes	String	Unique ID of the task. It is the TaskId returned by CreateReconstructDocumentFlow.

3. Output Parameters

Parameter Name	Type	Description
Status	String	Task status: success - execution completed; processing - executing; failed - execution failed; waitexecute - waiting to execute.
DocumentRecognizeResultUrl	String	The result file of this document parsing task, stored in the download url of Tencent Cloud cos. The valid period of the download url is 10 minutes.
FailedPages	Array of ReconstructDocumentFailedPage	Page number information where document parsing failed this time.
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 Successful API Call Example

Input Example

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

{
    "TaskId": "123123123"
}

Output Example

{
    "Response": {
        "DocumentRecognizeResultUrl": "https://document-restruction-1258344699.cos.ap-guangzhou.myqcloud.com/doc_parse/output_files/a9c6a9482c72412fa84445a44ss125531.zip?q-sign-algorithm=sha1&q-ak=*******l&q-sign-time=1715503711%3B1718804311&q-key-time=1718855711%3B1718804311&q-header-list=host&q-url-param-list=&q-signature=71b568b8632d7e45gertdc3d235ef68d41fdfe7f8",
        "FailedPages": [],
        "RequestId": "a37b0d0b-c3af-44bd-iuiu-632442644a80",
        "Status": "Success"
    }
}

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.UnKnowError	Unknown error.
FailedOperation.UnOpenError	The service is not activated.
InvalidParameterValue.InvalidParameterValueLimit	Parameter value error.
ResourceUnavailable.InArrears	The account is in arrears.
ResourceUnavailable.ResourcePackageRunOut	The account resource package is exhausted.
ResourcesSoldOut.ChargeStatusException	The billing status is abnormal.

Was this page helpful?

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

Yes

Feedback

tencent cloud