Help Center/ Cloud Search Service_KooSearch/ API Reference/ API/ APIs/ Task Management/ Viewing Retry Details
Updated on 2025-08-13 GMT+08:00
View PDF
Share

Viewing Retry Details

Function

View task details.

URI

GET /v1/{project_id}/applications/{application_id}/uni-search/{repo_id}/task-detail/{task_id}

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

Definition:

Project ID. For details about how to obtain the project ID, see Obtaining a Project ID.

Constraints:

N/A

Value range:

The value can contain 1 to 64 characters. Only digits, letters, hyphens (-), and underscores (_) are allowed. The value must start with a letter.

Default value:

N/A

application_id

Yes

String

Definition:

Application ID. For details about how to obtain the application ID, see Obtaining an Application ID.

Constraints:

Character string

Value range:

The value can contain 1 to 64 characters. Only digits, letters, hyphens (-), and underscores (_) are allowed. The value must start with a letter.

Default value:

N/A

repo_id

Yes

String

Definition:

Knowledge base ID.

How to obtain:

Log in to the KooSearch experience platform. In the navigation tree on the left, choose Knowledge Bases to view knowledge base IDs. Each knowledge base has a unique ID stored in the vector database.

Constraints:

N/A

Value range:

Length: 1 to 64 characters. The value can contain only digits, letters, hyphens (-), and underscores (_).

Default value:

N/A

task_id

Yes

String

Definition:

Job ID.

Constraints:

N/A

Value range:

The value can contain 1 to 64 characters. It can only contain letters, digits, underscores (_), periods (.), and hyphens (-).

Default value:

N/A

Request Parameters

None

Response Parameters

Status code: 200

Table 2 Response body parameters

Parameter

Type

Description

total

Integer

Definition:

Total number of documents that are retried in batches.

Value range:

N/A

task_detail

Array of TaskDetail objects

Definition:

Document details list.

Value range:

N/A

is_inherit_parser

Boolean

Definition:

Whether to inherit the original parsing mode.

Value range:

N/A
Table 3 TaskDetail

Parameter

Type

Description

id

String

Definition:

Document ID.

Value range:

N/A

name

String

Definition:

Document name.

Value range:

N/A

Status code: 404

Table 4 Response body parameters

Parameter

Type

Description

error_code

String

Definition:

Error Code.

Value range:

N/A

error_msg

String

Definition:

Error message.

Value range:

N/A

Example Requests

task_detail displays details about documents that are retried in batches. The document name and document ID are included.

/v1/1ed40ceefc8d40f8b884edb6a84e7768/applications/fb9731ab-7085-474f-b6c7-64473586f0f3/uni-search/d282959b-d12f-4ac8-a403-d693e9ca6800/task-detail/66677743-2565-4a76-9aa9-03aa679b61ca

Example Responses

Status code: 200

Task response, including details about multiple documents.

{
  "total" : 3,
  "task_detail" : [ {
    "id" : "8c73458292c10c71eb6bbafb6b94e6f1",
    "name" : "Test Case 1.docx"
  }, {
    "id" : "99a8bcd5cd66995b10d2cbcd52f535c0",
    "name" : "Test Case 2.docx"
  }, {
    "id" : "a2e72cdcdc448e27c7757b21b7e1af37",
    "name" : "Test Case 3.docx"
  } ]
}

Status code: 404

The requested resource does not exist.

{
  "error_code" : "kos.00060004",
  "error_message" : "resource not exist: [task_id: cc1e3b0e-4724-4b1f-a3e1-4ad1931bd96]"
}

Status Codes

Status Code

Description

200

Task response, including details about multiple documents.

404

The requested resource does not exist.

Error Codes

See Error Codes.

Parent topic: Task Management