Domain name for API request: lkeap.intl.tencentcloudapi.com.
This API is used to initiate requests for this asynchronous API, for initiating document parsing tasks.
Document parsing supports converting images or PDF files into Markdown format files, and can parse content elements including tables, formulas, images, headings, paragraphs, headers, and footers, and intelligently convert the content into reading order. Please refer to the input parameter list below for specific supported file types.
During the trial period, the QPS limit for a single account is only 1. If you need to access officially, please contact our R&D team.
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: CreateReconstructDocumentFlow. |
| Version | Yes | String | Common Params. The value used for this API: 2024-05-22. |
| Region | Yes | String | Common Params. For more information, please see the list of regions supported by the product. This API only supports: ap-jakarta. |
| FileType | Yes | String | File type. Supported file types: PDF, DOC, DOCX, XLS, XLSX, PPT, PPTX, MD, TXT, PNG, JPG, JPEG, CSV, HTML, EPUB, BMP, GIF, WEBP, HEIC, EPS, ICNS, IM, PCX, PPM, TIFF, XBM, HEIF, JP2. Supported file sizes: - Max 100 MB for PDF. - Max 200 MB for DOC, DOCX, PPT, and PPTX . - Max 10 MB for MD, and TXT. - Max 20 MB for others. |
| FileUrl | No | String | File URL. It is recommended to store the file in Tencent Cloud as the URL where the file is stored in Tencent Cloud can ensure higher download speed and stability. External URL may affect the speed and stability. Refer to: Tencent Cloud COS Documentation |
| FileBase64 | No | String | The base64 value of the file. Supported file types: PNG, JPG, JPEG, PDF, BMP, TIFF. File size limit: the downloaded file does not exceed 8MB after base64 encoding. File download time does not exceed 3 seconds. Supported image pixels: the length of a single side is between 20-10000px. Either FileUrl or FileBase64 of the file must be provided. If both are provided, only the FileUrl is used. |
| FileStartPageNumber | No | Integer | The starting page number of the file. When type of the uploaded file is pdf, doc, ppt, or pptx, it specifies the starting page number for recognition, including the current value. |
| FileEndPageNumber | No | Integer | The end page number of the file. When type of the uploaded file is pdf, doc, ppt, or pptx, it specifies the end page number for recognition, including the current value. |
| Config | No | CreateReconstructDocumentFlowConfig | Creates task configuration information for document parsing. |
| Parameter Name | Type | Description |
|---|---|---|
| TaskId | String | Unique task ID. The processing result corresponding to TaskId can be queried through the API [GetReconstructDocumentResult] within 30 days. |
| 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. |
POST / HTTP/1.1
Host: lkeap.intl.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: CreateReconstructDocumentFlow
<Common request parameters>
{
"FileType": "PDF",
"FileUrl": "http://example.com/example.pdf"
}{
"Response": {
"RequestId": "1d569fb4-4c9d-4141-bbd7-e1d8735bd1a9",
"TaskId": "123123123"
}
}
TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.
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. |
| FailedOperation.InternalError | |
| InvalidParameter.FileURLInvalid | |
| InvalidParameter.InvalidFileFormat | |
| InvalidParameter.InvalidFileType | |
| LimitExceeded.ExceededMaxPagesError | Exceeds the maximum file page limit. |
| LimitExceeded.TooLargeFileError | File too large. |
| ResourceUnavailable.ResourcePackageRunOut | The account resource package is exhausted. |
| ResourcesSoldOut.ChargeStatusException | The billing status is abnormal. |
Feedback