{"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-imageseg/change-sky":{"post":{"operationId":"cloud_aliyun_imageseg_change_sky","summary":"Describes the syntax and examples of the ChangeSky operation in the image segmentation (imageseg) category","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["ImageURL","ReplaceImageURL"],"properties":{"endpoint":{"type":"string","enum":["https://imageseg.cn-shanghai.aliyuncs.com"],"default":"https://imageseg.cn-shanghai.aliyuncs.com","description":"Regional endpoint, for example https://imageseg.cn-shanghai.aliyuncs.com"},"ImageURL":{"type":"string","description":"The URL of the target image whose sky needs to be replaced. We recommend that you use an OSS URL in the China (Shanghai) region. If the…"},"ReplaceImageURL":{"type":"string","description":"The URL of the reference image. We recommend that you use an OSS URL in the China (Shanghai) region. If the file is stored locally or in…"}}}}}},"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-imageseg/get-async-job-result":{"post":{"operationId":"cloud_aliyun_imageseg_get_async_job_result","summary":"This topic describes the syntax and examples of the GetAsyncJobResult operation for querying asynchronous…","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["JobId"],"properties":{"endpoint":{"type":"string","enum":["https://imageseg.cn-shanghai.aliyuncs.com"],"default":"https://imageseg.cn-shanghai.aliyuncs.com","description":"Regional endpoint, for example https://imageseg.cn-shanghai.aliyuncs.com"},"JobId":{"type":"string","description":"The RequestId returned by the asynchronous operation. You can use this parameter to query the actual result of the asynchronous operation"}}}}}},"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-imageseg/refine-mask":{"post":{"operationId":"cloud_aliyun_imageseg_refine_mask","summary":"Describes the syntax and examples of the RefineMask operation in the image segmentation (imageseg) category","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["MaskImageURL","ImageURL"],"properties":{"endpoint":{"type":"string","enum":["https://imageseg.cn-shanghai.aliyuncs.com"],"default":"https://imageseg.cn-shanghai.aliyuncs.com","description":"Regional endpoint, for example https://imageseg.cn-shanghai.aliyuncs.com"},"MaskImageURL":{"type":"string","description":"The URL of the rough mask image corresponding to the input image"},"ImageURL":{"type":"string","description":"The URL of the image. We recommend that you use an OSS URL in the China (Shanghai) region. For files stored locally or in OSS buckets in…"}}}}}},"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-imageseg/segment-body":{"post":{"operationId":"cloud_aliyun_imageseg_segment_body","summary":"Describes the syntax and examples of the SegmentBody operation in the image segmentation (imageseg) category","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["ImageURL"],"properties":{"endpoint":{"type":"string","enum":["https://imageseg.cn-shanghai.aliyuncs.com"],"default":"https://imageseg.cn-shanghai.aliyuncs.com","description":"Regional endpoint, for example https://imageseg.cn-shanghai.aliyuncs.com"},"ImageURL":{"type":"string","description":"The image URL. Use an OSS URL in the China (Shanghai) region. For files stored on your on-premises machine or in an OSS bucket outside the…"},"ReturnForm":{"type":"string","description":"Specifies the format of the returned image. If you set this parameter to `mask`, a single-channel black-and-white image is returned. If…"}}}}}},"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-imageseg/segment-cloth":{"post":{"operationId":"cloud_aliyun_imageseg_segment_cloth","summary":"Describes the syntax and examples of the SegmentCloth operation in the image segmentation (imageseg) category","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["ImageURL"],"properties":{"endpoint":{"type":"string","enum":["https://imageseg.cn-shanghai.aliyuncs.com"],"default":"https://imageseg.cn-shanghai.aliyuncs.com","description":"Regional endpoint, for example https://imageseg.cn-shanghai.aliyuncs.com"},"ImageURL":{"type":"string","description":"The URL of the image. We recommend that you use an OSS URL in the China (Shanghai) region. If the file is stored locally or in an OSS…"},"OutMode":{"type":"integer","description":"The type of the returned segmentation result. This parameter affects the returned content of the ImageURL field and is optional. Valid…"},"ClothClass":{"type":"string","description":"The clothing category. Valid values: tops: Tops coat: Coats skirt: Skirts pants: Pants bag: Bags shoes: Shoes hat: Hats (JSON-encoded)"},"ReturnForm":{"type":"string","description":"The format of the returned image. Valid values: whiteBK: Returns an image with a white background. mask: Returns a single-channel mask. If…"}}}}}},"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-imageseg/segment-commodity":{"post":{"operationId":"cloud_aliyun_imageseg_segment_commodity","summary":"This topic describes the syntax and provides examples of the commodity segmentation feature (SegmentCommodity)","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["ImageURL"],"properties":{"endpoint":{"type":"string","enum":["https://imageseg.cn-shanghai.aliyuncs.com"],"default":"https://imageseg.cn-shanghai.aliyuncs.com","description":"Regional endpoint, for example https://imageseg.cn-shanghai.aliyuncs.com"},"ImageURL":{"type":"string","description":"The URL of the image. We recommend that you use an OSS URL in the Shanghai region. If the file is stored locally or in an OSS bucket…"},"ReturnForm":{"type":"string","description":"The format of the returned image. If this parameter is not set, a 4-channel PNG image is returned. If this parameter is set to `mask`, a…"}}}}}},"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-imageseg/segment-common-image":{"post":{"operationId":"cloud_aliyun_imageseg_segment_common_image","summary":"Describes the syntax and examples of the SegmentCommonImage operation in the image segmentation (imageseg)…","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["ImageURL"],"properties":{"endpoint":{"type":"string","enum":["https://imageseg.cn-shanghai.aliyuncs.com"],"default":"https://imageseg.cn-shanghai.aliyuncs.com","description":"Regional endpoint, for example https://imageseg.cn-shanghai.aliyuncs.com"},"ImageURL":{"type":"string","description":"The image URL. Use an OSS URL in the China (Shanghai) region. For local files or OSS URLs in regions other than China (Shanghai), see…"},"ReturnForm":{"type":"string","description":"Specifies the format of the returned image. If this parameter is not specified, a 4-channel PNG image is returned. If this parameter is…"}}}}}},"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-imageseg/segment-food":{"post":{"operationId":"cloud_aliyun_imageseg_segment_food","summary":"Describes the syntax and examples of the SegmentFood operation in the image segmentation (imageseg) category","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["ImageURL"],"properties":{"endpoint":{"type":"string","enum":["https://imageseg.cn-shanghai.aliyuncs.com"],"default":"https://imageseg.cn-shanghai.aliyuncs.com","description":"Regional endpoint, for example https://imageseg.cn-shanghai.aliyuncs.com"},"ImageURL":{"type":"string","description":"The URL of the image. Use an OSS URL in the China (Shanghai) region. For local files or OSS URLs in regions other than China (Shanghai),…"},"ReturnForm":{"type":"string","description":"Specifies the format of the returned image. If this parameter is not specified, a four-channel PNG image is returned. If this parameter is…"}}}}}},"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-imageseg/segment-hdbody":{"post":{"operationId":"cloud_aliyun_imageseg_segment_hdbody","summary":"Describes the syntax and examples of the SegmentHDBody operation in the image segmentation (imageseg) category","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["ImageURL"],"properties":{"endpoint":{"type":"string","enum":["https://imageseg.cn-shanghai.aliyuncs.com"],"default":"https://imageseg.cn-shanghai.aliyuncs.com","description":"Regional endpoint, for example https://imageseg.cn-shanghai.aliyuncs.com"},"ImageURL":{"type":"string","description":"The image URL. Use OSS URLs in the China (Shanghai) region. If your file is stored locally or in an OSS bucket outside the China…"}}}}}},"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-imageseg/segment-hdcommon-image":{"post":{"operationId":"cloud_aliyun_imageseg_segment_hdcommon_image","summary":"Describes the syntax and examples of the SegmentHDCommonImage operation in the image segmentation (imageseg)…","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["ImageUrl"],"properties":{"endpoint":{"type":"string","enum":["https://imageseg.cn-shanghai.aliyuncs.com"],"default":"https://imageseg.cn-shanghai.aliyuncs.com","description":"Regional endpoint, for example https://imageseg.cn-shanghai.aliyuncs.com"},"ImageUrl":{"type":"string","description":"The image URL. Use an Object Storage Service (OSS) URL in the China (Shanghai) region. For local files or OSS URLs in other regions, see…"}}}}}},"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-imageseg/segment-hdsky":{"post":{"operationId":"cloud_aliyun_imageseg_segment_hdsky","summary":"Describes the syntax and examples of the SegmentHDSky operation in the image segmentation (imageseg) category","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["ImageURL"],"properties":{"endpoint":{"type":"string","enum":["https://imageseg.cn-shanghai.aliyuncs.com"],"default":"https://imageseg.cn-shanghai.aliyuncs.com","description":"Regional endpoint, for example https://imageseg.cn-shanghai.aliyuncs.com"},"ImageURL":{"type":"string","description":"The URL of the image in which you want to segment the sky. We recommend that you use an OSS URL in the China (Shanghai) region. If the…"}}}}}},"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-imageseg/segment-hair":{"post":{"operationId":"cloud_aliyun_imageseg_segment_hair","summary":"Describes the syntax and examples for the SegmentHair operation in the image segmentation (imageseg) category","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["ImageURL"],"properties":{"endpoint":{"type":"string","enum":["https://imageseg.cn-shanghai.aliyuncs.com"],"default":"https://imageseg.cn-shanghai.aliyuncs.com","description":"Regional endpoint, for example https://imageseg.cn-shanghai.aliyuncs.com"},"ImageURL":{"type":"string","description":"The URL of the image. We recommend that you use an OSS URL in the China (Shanghai) region. For local files or OSS URLs in other regions,…"}}}}}},"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-imageseg/segment-head":{"post":{"operationId":"cloud_aliyun_imageseg_segment_head","summary":"Describes the syntax and examples of the SegmentHead operation in the image segmentation (imageseg) category","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["ImageURL"],"properties":{"endpoint":{"type":"string","enum":["https://imageseg.cn-shanghai.aliyuncs.com"],"default":"https://imageseg.cn-shanghai.aliyuncs.com","description":"Regional endpoint, for example https://imageseg.cn-shanghai.aliyuncs.com"},"ImageURL":{"type":"string","description":"The URL of the image. We recommend that you use an OSS URL in the China (Shanghai) region. If the file is stored on your on-premises…"},"ReturnForm":{"type":"string","description":"Specifies the format of the returned image. If you set this parameter to `mask`, a single-channel mask is returned. If you do not set this…"}}}}}},"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-imageseg/segment-skin":{"post":{"operationId":"cloud_aliyun_imageseg_segment_skin","summary":"Describes the syntax and examples of the SegmentSkin operation in the image segmentation (imageseg) category","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["URL"],"properties":{"endpoint":{"type":"string","enum":["https://imageseg.cn-shanghai.aliyuncs.com"],"default":"https://imageseg.cn-shanghai.aliyuncs.com","description":"Regional endpoint, for example https://imageseg.cn-shanghai.aliyuncs.com"},"URL":{"type":"string","description":"The URL of the image. We recommend that you use an OSS URL in the China (Shanghai) region. If the file is stored on your on-premises…"}}}}}},"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-imageseg/segment-sky":{"post":{"operationId":"cloud_aliyun_imageseg_segment_sky","summary":"Describes the syntax and examples of the SegmentSky operation in the image segmentation (imageseg) category","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["ImageURL"],"properties":{"endpoint":{"type":"string","enum":["https://imageseg.cn-shanghai.aliyuncs.com"],"default":"https://imageseg.cn-shanghai.aliyuncs.com","description":"Regional endpoint, for example https://imageseg.cn-shanghai.aliyuncs.com"},"ImageURL":{"type":"string","description":"The image URL. Use an OSS URL in the China (Shanghai) region. For local files or OSS URLs in regions other than China (Shanghai), see…"}}}}}},"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-imageseg/version":{"post":{"operationId":"cloud_aliyun_imageseg_version","summary":"version","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"endpoint":{"type":"string","enum":["https://imageseg.cn-shanghai.aliyuncs.com"],"default":"https://imageseg.cn-shanghai.aliyuncs.com","description":"Regional endpoint, for example https://imageseg.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"}}}}}}}