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

Uploading Structured Data

Function

This API is used to upload structured data files to OBS for batch processing.

URI

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

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 FormData parameters

Parameter

Mandatory

Type

Description

file

Yes

File

Definition:

Structured data file.

Constraints:

JSONL files encoded using UTF-8 without BOM are supported. A single file cannot exceed 50 MB. The length of a user-defined data item is from 4 to 1024 characters. Furthermore, the file can only be used for one type of operation.

Value range:

N/A

Default value:

N/A

Response Parameters

Status code: 200

Table 4 Response body parameters

Parameter

Type

Description

file_id

String

Definition:

Document 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

Upload structured data files to OBS for batch processing.

/v1/1ed40ceefc8d40f8b884edb6a84e7768/applications/fb9731ab-7085-474f-b6c7-64473586f0f3/uni-search/36b6d979-7f98-4fda-b8b5-d7d0cc95d296/structured-data

Example Responses

Status code: 200

Response body of the API for uploading documents.

{
  "file_id" : "60fa0fbf-a809-4e4e-8d26-ec389a497bf4"
}

Status Codes

Status Code

Description

200

Response body of the API for uploading documents.

400

Invalid parameter.

500

Internal error.

Error Codes

See Error Codes.