CreateSplitDocumentFlow

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

CreateSplitDocumentFlow

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

1. API Description

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

This API is used to create document segmentation tasks, support various file types, possess mllm capacity, and can analyze and deeply understand the information in charts.

A maximum of 20 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: CreateSplitDocumentFlow.
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. Supported file sizes: - Max 500 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	Yes	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.
FileName	No	String	Filename. optional. The file type suffix shall be included. This field is required to be specified when the file name cannot be obtained from the passed-in "FileUrl".
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	CreateSplitDocumentFlowConfig	Configuration message for document splitting task.

3. Output Parameters

Parameter Name	Type	Description
TaskId	String	The unique ID of the splitting task. The splitting results corresponding to the TaskId can be queried through the [GetSplitDocumentResult] API 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.

4. Example

Example1 PDF Splitting Task Creation

Split the external online document.

Input Example

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

{
    "FileType": "PDF",
    "FileName": "example.pdf",
    "FileUrl": "https://qidian-qbot-1251316161.cos.ap-guangzhou.myqcloud.com/public/example/example.pdf",
    "FileStartPageNumber": 1,
    "FileEndPageNumber": 2,
    "Config": {
        "EnableMllm": true
    }
}

Output Example

{
    "Response": {
        "RequestId": "5e148c27-9c21-43cd-992c-799117bb4216",
        "TaskId": "236e51fd-827b-41cb-b303-56003a817ce5"
    }
}

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.
InternalError	Internal error.
InvalidParameter.FileURLInvalid
InvalidParameter.InvalidFileFormat
InvalidParameter.InvalidFileType
LimitExceeded.ExceededMaxPagesError	Exceeds the maximum file page limit.
LimitExceeded.TooLargeFileError	File too large.
RequestLimitExceeded	Too many and frequent requests.
ResourceUnavailable.ResourcePackageRunOut	The account resource package is exhausted.

Was this page helpful?

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

Yes

Feedback

tencent cloud