Updated on 2023-12-13 GMT+08:00

API Overview

Image Search provides Huawei-developed APIs. By using the Huawei-developed APIs of Image Search, you can experience all services in the following table.

The API chapter uses token-based request headers as examples. You can use either token-based or AK/SK-based request headers as required in actual use.

  • The token value in the sample request is the one obtained during service application.
  • The values of endpoint and projectId are the ones obtained in the region where the service is located.

API

Description

Creating an Instance

You can use the API to create an instance. An image library is created in the instance to store image features.

Adding an Image

You can use the API to import an image to the image library. The image can be stored in an OBS bucket in the same region or in the request body. Only the images in the image library can be searched for.

Searching for Images

You can use the API to search for similar images from the image library.

Querying an Image

You can use the API to check whether an image exists in the image library with the image path.

Deleting an Image

You can use the API to delete an image from the image library with the image path.

Modifying Image Information

You can use the API to modify the information about an existing image in the image library.

Deleting an Instance

You can use the API to delete an instance.

Querying the Details About an Instance

You can use the API to query detailed information about a specified instance.