{"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-agentretailvision/generate-group-image":{"post":{"operationId":"cloud_aliyun_agentretailvision_generate_group_image","summary":"Generates image groups for a single item with multiple images or for multiple items","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"endpoint":{"type":"string","enum":["https://agentretailvision.cn-beijing.aliyuncs.com"],"default":"https://agentretailvision.cn-beijing.aliyuncs.com","description":"Regional endpoint, for example https://agentretailvision.cn-beijing.aliyuncs.com"},"GroupId":{"type":"string","description":"The image group request ID generated by the caller"},"GroupType":{"type":"integer","description":"The image group type. Valid values: 1: image group for a single SKU with multiple images. 2: image group for multiple SKUs"},"PlatformItemIdList":{"type":"string","description":"The list of platform item IDs, which correspond to smart_retail_item.platform_item_id (JSON-encoded)"},"ImageUrlList":{"type":"string","description":"The list of image URLs used for single SKU image groups. This parameter is required when groupType is set to 1. A maximum of 10 images are…"}}}}}},"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-agentretailvision/import-products":{"post":{"operationId":"cloud_aliyun_agentretailvision_import_products","summary":"Creates product information for a business. After a successful import, the platform returns a globally…","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"endpoint":{"type":"string","enum":["https://agentretailvision.cn-beijing.aliyuncs.com"],"default":"https://agentretailvision.cn-beijing.aliyuncs.com","description":"Regional endpoint, for example https://agentretailvision.cn-beijing.aliyuncs.com"},"ItemUniqueId":{"type":"string","description":"The product ID of the business. This ID must be unique within the same business"},"ImageTitle":{"type":"string","description":"The product title"},"MainImage":{"type":"string","description":"The list of main product image URLs. At least one URL is required (JSON-encoded)"},"MultiViewImages":{"type":"string","description":"The list of multi-view product images (JSON-encoded)"},"ExtraImages":{"type":"string","description":"The list of additional image URLs that can be provided (JSON-encoded)"},"DeviceId":{"type":"string","description":"The device ID, which is used to establish an association between the device and the product vector"}}}}}},"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-agentretailvision/query-recognition-result":{"post":{"operationId":"cloud_aliyun_agentretailvision_query_recognition_result","summary":"At least one result retrieval method must be configured: webhook callback or task status polling. Both…","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"endpoint":{"type":"string","enum":["https://agentretailvision.cn-beijing.aliyuncs.com"],"default":"https://agentretailvision.cn-beijing.aliyuncs.com","description":"Regional endpoint, for example https://agentretailvision.cn-beijing.aliyuncs.com"},"TaskId":{"type":"string","description":"The platform task ID"},"OrderUniqueId":{"type":"string","description":"The idempotent request ID specified by the business side"}}}}}},"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-agentretailvision/recognize-order":{"post":{"operationId":"cloud_aliyun_agentretailvision_recognize_order","summary":"Creates an asynchronous recognition task for intelligent recognition scenarios by using the OSS URL of a…","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"endpoint":{"type":"string","enum":["https://agentretailvision.cn-beijing.aliyuncs.com"],"default":"https://agentretailvision.cn-beijing.aliyuncs.com","description":"Regional endpoint, for example https://agentretailvision.cn-beijing.aliyuncs.com"},"OrderUniqueId":{"type":"string","description":"The unique idempotent ID for the business party. The ID must be unique within the same business party"},"VideoUrls":{"type":"string","description":"The list of OSS URLs for shopping videos. Currently, only one URL is supported (JSON-encoded)"},"DeviceId":{"type":"string","description":"The device ID"},"CandidateItems":{"type":"string","description":"The list of candidate items. We recommend that you specify platform_item_id (JSON-encoded)"},"CallbackUrl":{"type":"string","description":"The callback URL for the current task. If this parameter is not specified, the registered default URL is used"}}}}}},"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-agentretailvision/register-webhook":{"post":{"operationId":"cloud_aliyun_agentretailvision_register_webhook","summary":"Registers or updates the default webhook callback URL","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"endpoint":{"type":"string","enum":["https://agentretailvision.cn-beijing.aliyuncs.com"],"default":"https://agentretailvision.cn-beijing.aliyuncs.com","description":"Regional endpoint, for example https://agentretailvision.cn-beijing.aliyuncs.com"},"CallbackUrl":{"type":"string","description":"The default callback URL. A public HTTPS URL is required"},"CallbackSecret":{"type":"string","description":"The key used for callback signature verification"}}}}}},"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-agentretailvision/update-product":{"post":{"operationId":"cloud_aliyun_agentretailvision_update_product","summary":"Updates the information of an existing item on the platform","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"endpoint":{"type":"string","enum":["https://agentretailvision.cn-beijing.aliyuncs.com"],"default":"https://agentretailvision.cn-beijing.aliyuncs.com","description":"Regional endpoint, for example https://agentretailvision.cn-beijing.aliyuncs.com"},"ItemUniqueId":{"type":"string","description":"The item ID of the business party. This ID is unique within the same business party"},"PlatformItemId":{"type":"string","description":"The platform item ID. This ID is globally unique"},"ImageTitle":{"type":"string","description":"The item title"},"MainImage":{"type":"string","description":"The list of main image URLs for the item. You must provide at least one image (JSON-encoded)"},"MultiViewImages":{"type":"string","description":"The list of multi-view images for the item (JSON-encoded)"},"ExtraImages":{"type":"string","description":"The list of additional image URLs that can be provided (JSON-encoded)"},"DeviceId":{"type":"string","description":"The device ID. This ID is used to establish a vector association between the device and the item"}}}}}},"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-agentretailvision/version":{"post":{"operationId":"cloud_aliyun_agentretailvision_version","summary":"version","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"endpoint":{"type":"string","enum":["https://agentretailvision.cn-beijing.aliyuncs.com"],"default":"https://agentretailvision.cn-beijing.aliyuncs.com","description":"Regional endpoint, for example https://agentretailvision.cn-beijing.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"}}}}}}}