Querying the Result of To-HTML Document Conversion
Function
Querying a Parsing Task
URI
GET /v1/koosearch/doc-search/tasks
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
task_id |
No |
Array of strings |
List of parsing task IDs |
page_num |
No |
Integer |
Page |
page_size |
No |
Integer |
Page size |
Request Parameters
None
Response Parameters
Status code: 200
Parameter |
Type |
Description |
---|---|---|
total |
Long |
Total number of tasks |
page_num |
Long |
Number of pages |
page_size |
Long |
Page size |
tasks |
Array of AsyncTask objects |
Task list |
Parameter |
Type |
Description |
---|---|---|
id |
String |
Task ID |
project_id |
String |
project_id |
file_name |
String |
Document Name |
mode |
String |
Parsing Mode |
doc_type |
String |
Document Type |
status |
String |
Task Status |
file_size |
String |
File Size |
create_time |
String |
Creation Time |
update_time |
String |
Update Time |
start_time |
String |
Start Time |
end_time |
String |
End Time |
Status code: 400
Parameter |
Type |
Description |
---|---|---|
error_code |
String |
|
error_msg |
String |
Error description |
Status code: 401
Parameter |
Type |
Description |
---|---|---|
error_code |
String |
|
error_msg |
String |
Error description |
Status code: 500
Parameter |
Type |
Description |
---|---|---|
error_code |
String |
|
error_msg |
String |
Error description |
Example Requests
None
Example Responses
Status code: 200
Task query response body
{ "total" : 25, "tasks" : [ { "id" : "47436b8dbd5e4742b992e5e9edca8a5a", "project_id" : "729cbd739854470da5426ed26bd900ca", "file_name" : "long-table-with-text-and-images.pdf", "mode" : 4, "doc_type" : "PDF", "status" : "SUCCESS", "file_size" : 125888, "create_time" : "2025-03-04 11:37:22", "update_time" : "2025-03-04 14:48:47", "start_time" : "2025-03-04 14:48:30", "end_time" : "2025-03-04 14:48:47" }, { "id" : "fdafa3a487234f6b90c0e2f046e5b967", "project_id" : "729cbd739854470da5426ed26bd900ca", "file_name" : "77pages-Image title-Physical-36308-00.pdf", "mode" : 4, "doc_type" : "PDF", "status" : "SUCCESS", "file_size" : 59418, "create_time" : "2025-03-04 10:50:51", "update_time" : "2025-03-04 10:51:08", "start_time" : "2025-03-04 10:50:55", "end_time" : "2025-03-04 10:51:08" }, { "id" : "aba8b51fadcb43c893d90058ea103ff4", "project_id" : "729cbd739854470da5426ed26bd900ca", "file_name" : "1 National Medical Insurance Revenue and Expenditure and Cross-Regional Settlement Database (Annual & Monthly).xlsx", "mode" : 4, "doc_type" : "XLSX", "status" : "SUCCESS", "file_size" : 493011, "create_time" : "2025-03-04 09:51:50", "update_time" : "2025-03-04 09:51:57", "start_time" : "2025-03-04 09:51:55", "end_time" : "2025-03-04 09:51:57" }, { "id" : "ccce5eeb2cac489c8b71b9017637892e", "project_id" : "729cbd739854470da5426ed26bd900ca", "file_name" : "1 National Medical Insurance Revenue and Expenditure and Cross-Regional Settlement Database (Annual & Monthly).xlsx", "mode" : 4, "doc_type" : "XLSX", "status" : "ERROR", "file_size" : 0, "create_time" : "2025-03-04 09:27:47", "update_time" : "2025-03-04 09:27:51", "start_time" : "2025-03-04 09:27:50", "end_time" : "2025-03-04 09:27:51" }, { "id" : "0a1abc0f22ac4e02a950b50674ffdec3", "project_id" : "729cbd739854470da5426ed26bd900ca", "file_name" : "Table header cross-page.docx", "mode" : 4, "doc_type" : "DOCX", "status" : "SUCCESS", "file_size" : 26728, "create_time" : "2025-03-03 17:04:13", "update_time" : "2025-03-03 17:09:46", "start_time" : "2025-03-03 17:09:40", "end_time" : "2025-03-03 17:09:46" }, { "id" : "6857bebef505490dbe70d3710430d8a1", "project_id" : "729cbd739854470da5426ed26bd900ca", "file_name" : "MWC2025_Foreign_Speaker_Commentary_Key Messages_EN_V1.5_part3.docx", "mode" : 4, "doc_type" : "DOCX", "status" : "SUCCESS", "file_size" : 46825512, "create_time" : "2025-03-03 16:53:22", "update_time" : "2025-03-03 16:57:29", "start_time" : "2025-03-03 16:53:25", "end_time" : "2025-03-03 16:57:29" }, { "id" : "6de35d7f97f54ae58a980ca7d8ebc96f", "project_id" : "729cbd739854470da5426ed26bd900ca", "file_name" : "1-10 pages QYB00G03.20-2022 Travel Expense and Conference Expense Management Regulations (Revised in September 2022).pdf", "mode" : 4, "doc_type" : "PDF", "status" : "SUCCESS", "file_size" : 357612, "create_time" : "2025-03-03 14:13:04", "update_time" : "2025-03-03 14:32:04", "start_time" : "2025-03-03 14:31:40", "end_time" : "2025-03-03 14:32:04" }, { "id" : "75b9e8ecc8074d32b9207c60baaa8c7e", "project_id" : "729cbd739854470da5426ed26bd900ca", "file_name" : "2052list(1).pdf", "mode" : 4, "doc_type" : "PDF", "status" : "SUCCESS", "file_size" : 67903, "create_time" : "2025-02-28 14:17:55", "update_time" : "2025-02-28 14:18:02", "start_time" : "2025-02-28 14:18:00", "end_time" : "2025-02-28 14:18:02" }, { "id" : "2b9c21c1d7b34c9b9c31eee6ad4e1870", "project_id" : "729cbd739854470da5426ed26bd900ca", "file_name" : "Contract 2024-09-30.pdf", "mode" : 4, "doc_type" : "PDF", "status" : "SUCCESS", "file_size" : 1872317, "create_time" : "2025-02-28 14:17:42", "update_time" : "2025-02-28 14:17:52", "start_time" : "2025-02-28 14:17:45", "end_time" : "2025-02-28 14:17:52" }, { "id" : "7c8a2c16f7284f5d9911914396959ad1", "project_id" : "729cbd739854470da5426ed26bd900ca", "file_name" : "Guía de cumplimiento en Chile.docx", "mode" : 4, "doc_type" : "DOCX", "status" : "SUCCESS", "file_size" : 26720, "create_time" : "2025-02-27 16:16:11", "update_time" : "2025-02-27 16:16:16", "start_time" : "2025-02-27 16:16:15", "end_time" : "2025-02-27 16:16:16" } ], "page_num" : 1, "page_size" : 10 }
Status Codes
Status Code |
Description |
---|---|
200 |
Task query response body |
400 |
Invalid request parameters |
401 |
Authentication error |
500 |
Service content error |
Error Codes
See Error Codes.
Feedback
Was this page helpful?
Provide feedbackThank you very much for your feedback. We will continue working to improve the documentation.See the reply and handling status in My Cloud VOC.
For any further questions, feel free to contact us through the chatbot.
Chatbot