Updated on 2025-08-13 GMT+08:00

Querying Knowledge Base Versions

Function

Query knowledge base versions.

URI

GET /v1/{project_id}/applications/{application_id}/uni-search/knowledge-repo/{repo_id}/versions

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

Request Parameters

None

Response Parameters

Status code: 200

Table 2 Response body parameters

Parameter

Type

Description

total

Integer

Definition:

Total number of versions.

Value range:

N/A

versions

Array of KnowledgeVersion objects

Definition:

Version list.

Value range:

N/A

Table 3 KnowledgeVersion

Parameter

Type

Description

id

String

Definition:

Version ID.

Value range:

N/A

repo_id

String

Definition:

Knowledge base ID.

Value range:

N/A

name

String

Definition:

Version name.

Value range:

N/A

detail

String

Definition:

Version description

Value range:

N/A

status

String

Definition:

Version status

Value range:

  • active: in use

  • open: available

  • closed

create_options

String

Definition:

Creation options.

Value range:

N/A

progress

Integer

Definition:

Reindex progress during index-based rebuilding. This field is cleared after the rebuilding is complete.

Value range:

N/A

create_user

String

Definition:

Username for creating a knowledge base.

Value range:

N/A

create_time

String

Definition:

Creation time.

Value range:

N/A

update_time

String

Definition:

Update time.

Value range:

N/A

project_id

String

Definition:

Project ID.

Value range:

N/A

embedding_model

String

Definition:

The embedding model name is selected from the embedding model set used during version rebuilding. If the version is not rebuilt, the embedding model of the knowledge base is used.

Constraints:

This parameter is supported only in clusters 25.7.T1 or later.

Value range:

The embedding model name can contain a maximum of 32 characters.

Default value:

The value is the same as the embedding model name of the knowledge base.

Example Requests

Query knowledge base versions.

/v1/1ed40ceefc8d40f8b884edb6a84e7768/applications/fb9731ab-7085-474f-b6c7-64473586f0f3/uni-search/knowledge-repo/05335b17-21f2-45f8-afeb-40bc1c583eb4/versions

Example Responses

Status code: 200

Response body.

{
  "total" : 1,
  "versions" : [ {
    "id" : "df611892-3ebe-4168-9049-20a1c5f25fc0",
    "name" : "chy",
    "status" : "active",
    "create_user" : "cssmonitoruser",
    "create_time" : "1751685280110",
    "update_time" : "1751685280110",
    "project_id" : "b25446daeb1a41a7953c5deba2b2677a",
    "embedding_model" : "cjh-embedding-8k"
  } ]
}

Status Codes

Status Code

Description

200

Response body.

Error Codes

See Error Codes.