Help Center/ Cloud Search Service_KooSearch/ API Reference/ API/ APIs/ Knowledge Base Directory Management/ Creating a Document Directory
Updated on 2025-08-13 GMT+08:00
View PDF
Share

Creating a Document Directory

Function

Create a knowledge base document directory.

URI

POST /v1/{project_id}/applications/{application_id}/uni-search/{repo_id}/directory

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

Table 2 Request header parameters

Parameter

Mandatory

Type

Description

X-Auth-Token

Yes

String

Definition:

Token used for API authentication. For details about how to obtain the token, see Obtaining an IAM User Token.

Constraints:

N/A

Value range:

N/A

Default value:

N/A
Table 3 Request body parameters

Parameter

Mandatory

Type

Description

name

Yes

String

Definition:

Directory name. The value can contain a maximum of 64 characters.

Value range:

N/A

parent_id

Yes

String

Definition:

Parent node directory ID. If the directory is at the top layer, the value of parent_id is null.

Value range:

N/A

Response Parameters

Status code: 200

Table 4 Response body parameters

Parameter

Type

Description

directory_id

String

Definition:

Directory ID.

Value range:

N/A

Status code: 400

Table 5 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

Status code: 500

Table 6 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

  • Create a document subdirectory in the knowledge base.

    /v1/{project_id}/applications/{application_id}/uni-search/{repo_id}/directory

{
  "name" : "Level-2 directory 1",
  "parent_id" : "directory_1"
}

  • Create a root document directory in the knowledge base.

    /v1/{project_id}/applications/{application_id}/uni-search/{repo_id}/directory

{
  "name" : "Level-1 directory 1",
  "parent_id" : "None"
}

Example Responses

Status code: 200

Document directory in the knowledge base created successfully.

{
  "directory_id" : "directory_1"
}

Status Codes

Status Code

Description

200

Document directory in the knowledge base created successfully.

400

Incorrect request body parameter.

500

Internal error.

Error Codes

See Error Codes.