{"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-address-purification/correct-address":{"post":{"operationId":"cloud_aliyun_address_purification_correct_address","summary":"Corrects errors in address text entered by users","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["ServiceCode","Text","AppKey"],"properties":{"endpoint":{"type":"string","enum":["https://address-purification.cn-hangzhou.aliyuncs.com"],"default":"https://address-purification.cn-hangzhou.aliyuncs.com","description":"Regional endpoint, for example https://address-purification.cn-hangzhou.aliyuncs.com"},"ServiceCode":{"type":"string","description":"Fixed value: addrp"},"Text":{"type":"string","description":"The text content"},"DefaultProvince":{"type":"string","description":"The default province"},"DefaultCity":{"type":"string","description":"The default city"},"DefaultDistrict":{"type":"string","description":"The default district"},"AppKey":{"type":"string","description":"The AppKey of the project"}}}}}},"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-address-purification/extract-address":{"post":{"operationId":"cloud_aliyun_address_purification_extract_address","summary":"Extracts address segments from unstructured data","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["ServiceCode","Text","AppKey"],"properties":{"endpoint":{"type":"string","enum":["https://address-purification.cn-hangzhou.aliyuncs.com"],"default":"https://address-purification.cn-hangzhou.aliyuncs.com","description":"Regional endpoint, for example https://address-purification.cn-hangzhou.aliyuncs.com"},"ServiceCode":{"type":"string","description":"Fixed value: addrp"},"Text":{"type":"string","description":"The text content"},"DefaultProvince":{"type":"string","description":"The default province"},"DefaultCity":{"type":"string","description":"The default city"},"DefaultDistrict":{"type":"string","description":"The default district"},"AppKey":{"type":"string","description":"The AppKey of the project"}}}}}},"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-address-purification/extract-name":{"post":{"operationId":"cloud_aliyun_address_purification_extract_name","summary":"Extracts name segments from natural text","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["ServiceCode","Text","AppKey"],"properties":{"endpoint":{"type":"string","enum":["https://address-purification.cn-hangzhou.aliyuncs.com"],"default":"https://address-purification.cn-hangzhou.aliyuncs.com","description":"Regional endpoint, for example https://address-purification.cn-hangzhou.aliyuncs.com"},"ServiceCode":{"type":"string","description":"Fixed value: addrp"},"Text":{"type":"string","description":"The text content"},"DefaultProvince":{"type":"string","description":"The default province"},"DefaultCity":{"type":"string","description":"The default city"},"DefaultDistrict":{"type":"string","description":"The default district"},"AppKey":{"type":"string","description":"The project AppKey"}}}}}},"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-address-purification/extract-phone":{"post":{"operationId":"cloud_aliyun_address_purification_extract_phone","summary":"Extracts phone number segments from natural text","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["ServiceCode","Text","AppKey"],"properties":{"endpoint":{"type":"string","enum":["https://address-purification.cn-hangzhou.aliyuncs.com"],"default":"https://address-purification.cn-hangzhou.aliyuncs.com","description":"Regional endpoint, for example https://address-purification.cn-hangzhou.aliyuncs.com"},"ServiceCode":{"type":"string","description":"Fixed value: addrp"},"Text":{"type":"string","description":"The text content"},"DefaultProvince":{"type":"string","description":"The default province"},"DefaultCity":{"type":"string","description":"The default city"},"DefaultDistrict":{"type":"string","description":"The default district"},"AppKey":{"type":"string","description":"The AppKey of the project"}}}}}},"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-address-purification/get-address-division-code":{"post":{"operationId":"cloud_aliyun_address_purification_get_address_division_code","summary":"Identifies the four-level administrative divisions (province, city, district/county, and street/town) from…","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["ServiceCode","Text","AppKey"],"properties":{"endpoint":{"type":"string","enum":["https://address-purification.cn-hangzhou.aliyuncs.com"],"default":"https://address-purification.cn-hangzhou.aliyuncs.com","description":"Regional endpoint, for example https://address-purification.cn-hangzhou.aliyuncs.com"},"ServiceCode":{"type":"string","description":"Fixed value: addrp"},"Text":{"type":"string","description":"The text content"},"DefaultProvince":{"type":"string","description":"The default province"},"DefaultCity":{"type":"string","description":"The default city"},"DefaultDistrict":{"type":"string","description":"The default district"},"AppKey":{"type":"string","description":"The AppKey of the project"}}}}}},"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-address-purification/get-address-similarity":{"post":{"operationId":"cloud_aliyun_address_purification_get_address_similarity","summary":"Determines whether two addresses are the same address and returns the finest-granularity level at which the…","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["ServiceCode","Text","AppKey"],"properties":{"endpoint":{"type":"string","enum":["https://address-purification.cn-hangzhou.aliyuncs.com"],"default":"https://address-purification.cn-hangzhou.aliyuncs.com","description":"Regional endpoint, for example https://address-purification.cn-hangzhou.aliyuncs.com"},"ServiceCode":{"type":"string","description":"Fixed value: addrp"},"Text":{"type":"string","description":"The text content"},"DefaultProvince":{"type":"string","description":"The default province"},"DefaultCity":{"type":"string","description":"The default city"},"DefaultDistrict":{"type":"string","description":"The default district"},"AppKey":{"type":"string","description":"The AppKey of the project"}}}}}},"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-address-purification/get-zipcode":{"post":{"operationId":"cloud_aliyun_address_purification_get_zipcode","summary":"Returns the postal code that corresponds to a specified address","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["ServiceCode","Text","AppKey"],"properties":{"endpoint":{"type":"string","enum":["https://address-purification.cn-hangzhou.aliyuncs.com"],"default":"https://address-purification.cn-hangzhou.aliyuncs.com","description":"Regional endpoint, for example https://address-purification.cn-hangzhou.aliyuncs.com"},"ServiceCode":{"type":"string","description":"Fixed value: addrp"},"Text":{"type":"string","description":"The text content"},"DefaultProvince":{"type":"string","description":"The default province"},"DefaultCity":{"type":"string","description":"The default city"},"DefaultDistrict":{"type":"string","description":"The default district"},"AppKey":{"type":"string","description":"The AppKey of the project"}}}}}},"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-address-purification/structure-address":{"post":{"operationId":"cloud_aliyun_address_purification_structure_address","summary":"Classifies an original address into hierarchical levels and supports auto-completion of province, city,…","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["ServiceCode","Text","AppKey"],"properties":{"endpoint":{"type":"string","enum":["https://address-purification.cn-hangzhou.aliyuncs.com"],"default":"https://address-purification.cn-hangzhou.aliyuncs.com","description":"Regional endpoint, for example https://address-purification.cn-hangzhou.aliyuncs.com"},"ServiceCode":{"type":"string","description":"Fixed value: addrp"},"Text":{"type":"string","description":"The text content"},"DefaultProvince":{"type":"string","description":"The default province"},"DefaultCity":{"type":"string","description":"The default city"},"DefaultDistrict":{"type":"string","description":"The default district"},"AppKey":{"type":"string","description":"The AppKey of the project"}}}}}},"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-address-purification/version":{"post":{"operationId":"cloud_aliyun_address_purification_version","summary":"version","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"endpoint":{"type":"string","enum":["https://address-purification.cn-hangzhou.aliyuncs.com"],"default":"https://address-purification.cn-hangzhou.aliyuncs.com","description":"Regional endpoint, for example https://address-purification.cn-hangzhou.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"}}}}}}}