{"openapi":"3.1.0","info":{"title":"Apizie","version":"2.0.0","description":"One API key, one envelope, many public data sources."},"servers":[{"url":"https://zieapi.vercel.app"}],"security":[{"ApiKeyAuth":[]}],"paths":{"/v1/cloud:aliyun-imgsearch/add-image":{"post":{"operationId":"cloud_aliyun_imgsearch_add_image","summary":"This topic describes the syntax and examples of the AddImage operation","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["DbName","ImageUrl","EntityId"],"properties":{"endpoint":{"type":"string","enum":["https://imgsearch.cn-shanghai.aliyuncs.com"],"default":"https://imgsearch.cn-shanghai.aliyuncs.com","description":"Regional endpoint, for example https://imgsearch.cn-shanghai.aliyuncs.com"},"DbName":{"type":"string","description":"The name of the database. The name can contain lowercase letters, digits, and underscores (_), and must be 2 to 64 characters in length"},"ImageUrl":{"type":"string","description":"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":{"type":"string","description":"The custom data. The value can contain letters, digits, punctuation marks, and Chinese characters, and must be 0 to 512 characters in length"},"EntityId":{"type":"string","description":"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…"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-imgsearch/create-image-db":{"post":{"operationId":"cloud_aliyun_imgsearch_create_image_db","summary":"This topic describes the syntax and examples of the CreateImageDb operation for creating a database","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["Name"],"properties":{"endpoint":{"type":"string","enum":["https://imgsearch.cn-shanghai.aliyuncs.com"],"default":"https://imgsearch.cn-shanghai.aliyuncs.com","description":"Regional endpoint, for example https://imgsearch.cn-shanghai.aliyuncs.com"},"Name":{"type":"string","description":"The database name. The name can contain lowercase letters, digits, and underscores (_) and must be 2 to 64 characters in length. Each…"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-imgsearch/delete-image":{"post":{"operationId":"cloud_aliyun_imgsearch_delete_image","summary":"Deletes an image from a specified database","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["DbName","EntityId"],"properties":{"endpoint":{"type":"string","enum":["https://imgsearch.cn-shanghai.aliyuncs.com"],"default":"https://imgsearch.cn-shanghai.aliyuncs.com","description":"Regional endpoint, for example https://imgsearch.cn-shanghai.aliyuncs.com"},"DbName":{"type":"string","description":"The name of the database"},"EntityId":{"type":"string","description":"The entity ID of the data to be deleted"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-imgsearch/delete-image-db":{"post":{"operationId":"cloud_aliyun_imgsearch_delete_image_db","summary":"This topic describes the syntax and examples of the DeleteImageDb operation","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["Name"],"properties":{"endpoint":{"type":"string","enum":["https://imgsearch.cn-shanghai.aliyuncs.com"],"default":"https://imgsearch.cn-shanghai.aliyuncs.com","description":"Regional endpoint, for example https://imgsearch.cn-shanghai.aliyuncs.com"},"Name":{"type":"string","description":"The name of the database"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-imgsearch/list-image-dbs":{"post":{"operationId":"cloud_aliyun_imgsearch_list_image_dbs","summary":"This topic describes the syntax and examples of the ListImageDbs operation for querying the list of databases","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"endpoint":{"type":"string","enum":["https://imgsearch.cn-shanghai.aliyuncs.com"],"default":"https://imgsearch.cn-shanghai.aliyuncs.com","description":"Regional endpoint, for example https://imgsearch.cn-shanghai.aliyuncs.com"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-imgsearch/list-images":{"post":{"operationId":"cloud_aliyun_imgsearch_list_images","summary":"This topic describes the syntax and examples of the ListImages operation for viewing the image data list","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["DbName"],"properties":{"endpoint":{"type":"string","enum":["https://imgsearch.cn-shanghai.aliyuncs.com"],"default":"https://imgsearch.cn-shanghai.aliyuncs.com","description":"Regional endpoint, for example https://imgsearch.cn-shanghai.aliyuncs.com"},"DbName":{"type":"string","description":"The name of the database"},"Token":{"type":"string","description":"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":{"type":"integer","description":"The start record"},"Limit":{"type":"integer","description":"The maximum number of entries to return per page"},"Order":{"type":"string","description":"The sort order. Valid values: asc: ascending order. desc: descending order"},"EntityIdPrefix":{"type":"string","description":"The prefix of the sample ID"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-imgsearch/search-image":{"post":{"operationId":"cloud_aliyun_imgsearch_search_image","summary":"This topic describes the syntax and examples of the SearchImage operation","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["DbName","ImageUrl","Limit"],"properties":{"endpoint":{"type":"string","enum":["https://imgsearch.cn-shanghai.aliyuncs.com"],"default":"https://imgsearch.cn-shanghai.aliyuncs.com","description":"Regional endpoint, for example https://imgsearch.cn-shanghai.aliyuncs.com"},"DbName":{"type":"string","description":"The name of the database"},"ImageUrl":{"type":"string","description":"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":{"type":"integer","description":"The maximum number of results to return. Valid values: 1 to 200"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-imgsearch/version":{"post":{"operationId":"cloud_aliyun_imgsearch_version","summary":"version","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"endpoint":{"type":"string","enum":["https://imgsearch.cn-shanghai.aliyuncs.com"],"default":"https://imgsearch.cn-shanghai.aliyuncs.com","description":"Regional endpoint, for example https://imgsearch.cn-shanghai.aliyuncs.com"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}}},"components":{"securitySchemes":{"ApiKeyAuth":{"type":"apiKey","in":"header","name":"x-api-key"}},"schemas":{"RunEnvelope":{"type":"object","required":["project","data","timestamp"],"properties":{"project":{"type":"string","example":"dev-tools:hash"},"data":{},"timestamp":{"type":"string","format":"date-time"}}},"ErrorEnvelope":{"type":"object","properties":{"content":{},"message":{"type":"string"},"errors":{"type":"array","items":{}},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"}}}}}},"responses":{"Error":{"description":"Invalid key, plan gate, rate limit or upstream failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}}}}}