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

Uploading an Image

Function

This API is used to upload images to the database.

URI

POST /v1/{project_id}/applications/{application_id}/uni-search/img/{img_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

img_id

Yes

String

Definition:

Image ID.

Constraints:

The value must be a string of 32 letters and digits and must start with img-.

Value range:

N/A

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

image

Yes

File

Definition:

Uploaded image file.

Constraints:

The file must be in PNG, JPG, or JPEG format and cannot exceed 20 MB.

Value range:

N/A

Default value:

N/A

Response Parameters

Status code: 200

File uploaded successfully.

Status code: 400

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

Status code: 500

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

Example Requests

None

Example Responses

None

Status Codes

Status Code

Description

200

File uploaded successfully.

400

Request error.

500

Internal error.

Error Codes

See Error Codes.