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

Obtaining Image Content

Function

This API is used to obtain image content by ID.

URI

GET /v1/koosearch/image/{img_id}

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

img_id

Yes

String

Image ID. The format is img-[0-9a-z]{32}.

Request Parameters

Table 2 Request header parameters

Parameter

Mandatory

Type

Description

X-Auth-Token

Yes

String

Parameter description:

Token used for API authentication. For how to obtain the token, see section 3.2 "Authentication."

Constraints:

N/A.

Response Parameters

Status code: 400

Table 3 Response body parameters

Parameter

Type

Description

[items]

Array of ErrorRsp objects

Error object returned when the operation fails. For details, see Error Code Description.

Table 4 ErrorRsp

Parameter

Type

Description

error_code

String

Error Code

error_msg

String

Error description

Status code: 404

Table 5 Response body parameters

Parameter

Type

Description

[items]

Array of ErrorRsp objects

Error object returned when the operation fails. For details, see Error Code Description.

Table 6 ErrorRsp

Parameter

Type

Description

error_code

String

Error Code

error_msg

String

Error description

Status code: 500

Table 7 Response body parameters

Parameter

Type

Description

[items]

Array of ErrorRsp objects

Error object returned when the operation fails. For details, see Error Code Description.

Table 8 ErrorRsp

Parameter

Type

Description

error_code

String

Error Code

error_msg

String

Error description

Example Requests

None

Example Responses

None

Status Codes

Status Code

Description

200

A success message is displayed.

400

Request error

404

Image does not exist.

500

Internal error

Error Codes

See Error Codes.