# Alibaba Cloud Viapi Imgsearch API

> Alibaba Cloud Viapi Imgsearch API on Apizie: 8 endpoints (This topic describes the syntax and examples of the AddImage operation, This topic describes the syntax and examples of the CreateImageDb operation for creating a database, Deletes an image from a specified database, This topic describes the syntax and examples of the DeleteImageDb operation, …) returned as clean JSON through one API key. Send your own provider key in the x-upstream-key header. Call it over REST at https://zieapi.vercel.app/v1/cloud:aliyun-imgsearch/{endpoint} or from Claude, ChatGPT and Cursor through the Apizie MCP server. Free plan: 1,000 requests a month.

- Project key: `cloud:aliyun-imgsearch`
- Category: Cloud
- Status: byok
- Source: https://api.alibabacloud.com/product/imgsearch
- Page: https://zieapi.vercel.app/api/cloud/aliyun-imgsearch
- OpenAPI: https://zieapi.vercel.app/api/cloud/aliyun-imgsearch/openapi.json

Alibaba Cloud OpenAPI for Viapi Imgsearch (imgsearch, version 2020-03-20). Calls are signed with ACS3-HMAC-SHA256 using your AccessKey ID and secret.

## Endpoints

### This topic describes the syntax and examples of the AddImage operation
`POST https://zieapi.vercel.app/v1/cloud:aliyun-imgsearch/add-image` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://imgsearch.cn-shanghai.aliyuncs.com |
| DbName | string | yes | The name of the database. The name can contain lowercase letters, digits, and underscores (_), and must be 2 to 64 characters in length |
| ImageUrl | string | yes | The URL of the image. We recommend that you use an Object Storage Service (OSS) URL in the Shanghai region. If the file is stored locally… |
| ExtraData | string | no | The custom data. The value can contain letters, digits, punctuation marks, and Chinese characters, and must be 0 to 512 characters in length |
| EntityId | string | yes | The entity ID, which can be used as a data group ID. The ID can contain lowercase letters, digits, and underscores (_), and must be 1 to… |

### This topic describes the syntax and examples of the CreateImageDb operation for creating a database
`POST https://zieapi.vercel.app/v1/cloud:aliyun-imgsearch/create-image-db` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://imgsearch.cn-shanghai.aliyuncs.com |
| Name | string | yes | The database name. The name can contain lowercase letters, digits, and underscores (_) and must be 2 to 64 characters in length. Each… |

### Deletes an image from a specified database
`POST https://zieapi.vercel.app/v1/cloud:aliyun-imgsearch/delete-image` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://imgsearch.cn-shanghai.aliyuncs.com |
| DbName | string | yes | The name of the database |
| EntityId | string | yes | The entity ID of the data to be deleted |

### This topic describes the syntax and examples of the DeleteImageDb operation
`POST https://zieapi.vercel.app/v1/cloud:aliyun-imgsearch/delete-image-db` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://imgsearch.cn-shanghai.aliyuncs.com |
| Name | string | yes | The name of the database |

### This topic describes the syntax and examples of the ListImageDbs operation for querying the list of databases
`POST https://zieapi.vercel.app/v1/cloud:aliyun-imgsearch/list-image-dbs` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://imgsearch.cn-shanghai.aliyuncs.com |

### This topic describes the syntax and examples of the ListImages operation for viewing the image data list
`POST https://zieapi.vercel.app/v1/cloud:aliyun-imgsearch/list-images` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://imgsearch.cn-shanghai.aliyuncs.com |
| DbName | string | yes | The name of the database |
| Token | string | no | The pagination method that combines Offset and Limit supports only the first 2,000 records. If the number of records exceeds 2,000, use… |
| Offset | integer | no | The start record |
| Limit | integer | no | The maximum number of entries to return per page |
| Order | string | no | The sort order. Valid values: asc: ascending order. desc: descending order |
| EntityIdPrefix | string | no | The prefix of the sample ID |

### This topic describes the syntax and examples of the SearchImage operation
`POST https://zieapi.vercel.app/v1/cloud:aliyun-imgsearch/search-image` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://imgsearch.cn-shanghai.aliyuncs.com |
| DbName | string | yes | The name of the database |
| ImageUrl | string | yes | The URL of the image. We recommend that you use an Object Storage Service (OSS) URL in the Shanghai region. If the file is stored locally… |
| Limit | integer | yes | The maximum number of results to return. Valid values: 1 to 200 |

### version
`POST https://zieapi.vercel.app/v1/cloud:aliyun-imgsearch/version` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://imgsearch.cn-shanghai.aliyuncs.com |

## Example
```
curl "https://zieapi.vercel.app/v1/cloud:aliyun-imgsearch/add-image" \
  -H "x-api-key: $APIZIE_KEY" \
  -H "x-upstream-key: $PROVIDER_KEY"
```

## FAQ

### How do I call the Alibaba Cloud Viapi Imgsearch API?
Create a free Apizie key, then send POST https://zieapi.vercel.app/v1/cloud:aliyun-imgsearch/add-image with the header x-api-key. Every endpoint returns { project, data, timestamp }.

### Is the Alibaba Cloud Viapi Imgsearch API free on Apizie?
Yes. The Free plan includes 1,000 requests a month at 100 requests a minute, no credit card. Alibaba Cloud Viapi Imgsearch itself also needs your own key from aliyuncs.com.

### Can AI agents use the Alibaba Cloud Viapi Imgsearch API?
Yes. Add the Apizie MCP server (https://zieapi.vercel.app/mcp) to Claude, ChatGPT, Cursor or VS Code, then ask in plain language. The agent calls run_scraper with project key cloud:aliyun-imgsearch.

### What is the status of the Alibaba Cloud Viapi Imgsearch API?
Needs your own provider key (bring your own key)