{"openapi":"3.1.0","info":{"title":"Apizie","version":"2.0.0","description":"One API key, one envelope, many public data sources."},"servers":[{"url":"https://apizie.tech"}],"security":[{"ApiKeyAuth":[]}],"paths":{"/v1/cloud:azure-cognitiveservices-computer-vision/analyze-image":{"post":{"operationId":"cloud_azure_cognitiveservices_computer_vision_analyze_image","summary":"This operation extracts a rich set of visual features based on the image content. Two input methods are…","description":"POST /analyze","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["Endpoint","body"],"properties":{"Endpoint":{"type":"string","description":"Supported Cognitive Services endpoints."},"visualFeatures":{"type":"array","description":"A string indicating what visual feature types to return. Multiple values should be comma-separated. Valid visual feature types include:…"},"details":{"type":"array","description":"A string indicating which domain-specific details to return. Multiple values should be comma-separated. Valid visual feature types…"},"language":{"type":"string","default":"en","description":"The desired language for output generation. If this parameter is not specified, the default value is \"en\". See https://aka.ms/cv-languages…"},"descriptionExclude":{"type":"array","description":"Turn off specified domain models when generating the description."},"model-version":{"type":"string","default":"latest","description":"Optional parameter to specify the version of the AI model. Accepted values are: \"latest\", \"2021-04-01\", \"2021-05-01\". Defaults to \"latest\"."},"body":{"type":"object","description":"JSON request body"}}}}}},"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:azure-cognitiveservices-computer-vision/describe-image":{"post":{"operationId":"cloud_azure_cognitiveservices_computer_vision_describe_image","summary":"This operation generates a description of an image in human readable language with complete sentences. The…","description":"POST /describe","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["Endpoint","body"],"properties":{"Endpoint":{"type":"string","description":"Supported Cognitive Services endpoints."},"maxCandidates":{"type":"integer","default":1,"description":"Maximum number of candidate descriptions to be returned. The default is 1."},"language":{"type":"string","default":"en","description":"The desired language for output generation. If this parameter is not specified, the default value is \"en\". See https://aka.ms/cv-languages…"},"descriptionExclude":{"type":"array","description":"Turn off specified domain models when generating the description."},"model-version":{"type":"string","default":"latest","description":"Optional parameter to specify the version of the AI model. Accepted values are: \"latest\", \"2021-04-01\", \"2021-05-01\". Defaults to \"latest\"."},"body":{"type":"object","description":"JSON request body"}}}}}},"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:azure-cognitiveservices-computer-vision/detect-objects":{"post":{"operationId":"cloud_azure_cognitiveservices_computer_vision_detect_objects","summary":"Performs object detection on the specified image. Two input methods are supported -- (1) Uploading an image…","description":"POST /detect","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["Endpoint","body"],"properties":{"Endpoint":{"type":"string","description":"Supported Cognitive Services endpoints."},"model-version":{"type":"string","default":"latest","description":"Optional parameter to specify the version of the AI model. Accepted values are: \"latest\", \"2021-04-01\", \"2021-05-01\". Defaults to \"latest\"."},"body":{"type":"object","description":"JSON request body"}}}}}},"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:azure-cognitiveservices-computer-vision/list-models":{"get":{"operationId":"cloud_azure_cognitiveservices_computer_vision_list_models","summary":"This operation returns the list of domain-specific models that are supported by the Computer Vision API.…","description":"GET /models","tags":["cloud"],"parameters":[{"name":"Endpoint","in":"query","required":true,"description":"Supported Cognitive Services endpoints.","schema":{"type":"string","description":"Supported Cognitive Services endpoints."}}],"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":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/cloud:azure-cognitiveservices-computer-vision/analyze-image-by-domain":{"post":{"operationId":"cloud_azure_cognitiveservices_computer_vision_analyze_image_by_domain","summary":"This operation recognizes content within an image by applying a domain-specific model. The list of…","description":"POST /models/{model}/analyze","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["Endpoint","model","body"],"properties":{"Endpoint":{"type":"string","description":"Supported Cognitive Services endpoints."},"model":{"type":"string","description":"The domain-specific content to recognize."},"language":{"type":"string","default":"en","description":"The desired language for output generation. If this parameter is not specified, the default value is \"en\". See https://aka.ms/cv-languages…"},"model-version":{"type":"string","default":"latest","description":"Optional parameter to specify the version of the AI model. Accepted values are: \"latest\", \"2021-04-01\", \"2021-05-01\". Defaults to \"latest\"."},"body":{"type":"object","description":"JSON request body"}}}}}},"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:azure-cognitiveservices-computer-vision/recognize-printed-text":{"post":{"operationId":"cloud_azure_cognitiveservices_computer_vision_recognize_printed_text","summary":"Optical Character Recognition (OCR) detects text in an image and extracts the recognized characters into a…","description":"POST /ocr","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["Endpoint","detectOrientation","body"],"properties":{"Endpoint":{"type":"string","description":"Supported Cognitive Services endpoints."},"detectOrientation":{"type":"boolean","default":true,"description":"Whether detect the text orientation in the image. With detectOrientation=true the OCR service tries to detect the image orientation and…"},"language":{"type":"string","enum":["unk","zh-Hans","zh-Hant","cs","da","nl","en","fi","fr","de","el","hu","it","ja","ko","nb","pl","pt","ru","es","sv","tr","ar","ro","sr-Cyrl","sr-Latn","sk"],"default":"unk","description":"The BCP-47 language code of the text to be detected in the image. The default value is 'unk'."},"model-version":{"type":"string","default":"latest","description":"Optional parameter to specify the version of the AI model. Accepted values are: \"latest\", \"2021-04-01\", \"2021-05-01\". Defaults to \"latest\"."},"body":{"type":"object","description":"JSON request body"}}}}}},"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:azure-cognitiveservices-computer-vision/tag-image":{"post":{"operationId":"cloud_azure_cognitiveservices_computer_vision_tag_image","summary":"This operation generates a list of words, or tags, that are relevant to the content of the supplied image.…","description":"POST /tag","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["Endpoint","body"],"properties":{"Endpoint":{"type":"string","description":"Supported Cognitive Services endpoints."},"language":{"type":"string","default":"en","description":"The desired language for output generation. If this parameter is not specified, the default value is \"en\". See https://aka.ms/cv-languages…"},"model-version":{"type":"string","default":"latest","description":"Optional parameter to specify the version of the AI model. Accepted values are: \"latest\", \"2021-04-01\", \"2021-05-01\". Defaults to \"latest\"."},"body":{"type":"object","description":"JSON request body"}}}}}},"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:azure-cognitiveservices-computer-vision/generate-thumbnail":{"post":{"operationId":"cloud_azure_cognitiveservices_computer_vision_generate_thumbnail","summary":"This operation generates a thumbnail image with the user-specified width and height. By default, the service…","description":"POST /generateThumbnail","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["Endpoint","width","height","body"],"properties":{"Endpoint":{"type":"string","description":"Supported Cognitive Services endpoints."},"width":{"type":"integer","description":"Width of the thumbnail, in pixels. It must be between 1 and 1024. Recommended minimum of 50."},"height":{"type":"integer","description":"Height of the thumbnail, in pixels. It must be between 1 and 1024. Recommended minimum of 50."},"smartCropping":{"type":"boolean","default":false,"description":"Boolean flag for enabling smart cropping."},"model-version":{"type":"string","default":"latest","description":"Optional parameter to specify the version of the AI model. Accepted values are: \"latest\", \"2021-04-01\", \"2021-05-01\". Defaults to \"latest\"."},"body":{"type":"object","description":"JSON request body"}}}}}},"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:azure-cognitiveservices-computer-vision/get-area-of-interest":{"post":{"operationId":"cloud_azure_cognitiveservices_computer_vision_get_area_of_interest","summary":"This operation returns a bounding box around the most important area of the image. A successful response…","description":"POST /areaOfInterest","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["Endpoint","body"],"properties":{"Endpoint":{"type":"string","description":"Supported Cognitive Services endpoints."},"model-version":{"type":"string","default":"latest","description":"Optional parameter to specify the version of the AI model. Accepted values are: \"latest\", \"2021-04-01\", \"2021-05-01\". Defaults to \"latest\"."},"body":{"type":"object","description":"JSON request body"}}}}}},"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:azure-cognitiveservices-computer-vision/read":{"post":{"operationId":"cloud_azure_cognitiveservices_computer_vision_read","summary":"Use this interface to get the result of a Read operation, employing the state-of-the-art Optical Character…","description":"POST /read/analyze","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["Endpoint","body"],"properties":{"Endpoint":{"type":"string","description":"Supported Cognitive Services endpoints."},"language":{"type":"string","description":"The BCP-47 language code of the text in the document. Read supports auto language identification and multi-language documents, so only…"},"pages":{"type":"array","description":"Custom page numbers for multi-page documents(PDF/TIFF), input the number of the pages you want to get OCR result. For a range of pages,…"},"model-version":{"type":"string","default":"latest","description":"Optional parameter to specify the version of the OCR model used for text extraction. Accepted values are: \"latest\", \"latest-preview\",…"},"readingOrder":{"type":"string","default":"basic","description":"Optional parameter to specify which reading order algorithm should be applied when ordering the extract text elements. Can be either…"},"body":{"type":"object","description":"JSON request body"}}}}}},"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:azure-cognitiveservices-computer-vision/get-read-result":{"get":{"operationId":"cloud_azure_cognitiveservices_computer_vision_get_read_result","summary":"This interface is used for getting OCR results of Read operation. The URL to this interface should be…","description":"GET /read/analyzeResults/{operationId}","tags":["cloud"],"parameters":[{"name":"Endpoint","in":"query","required":true,"description":"Supported Cognitive Services endpoints.","schema":{"type":"string","description":"Supported Cognitive Services endpoints."}},{"name":"operationId","in":"query","required":true,"description":"Id of read operation returned in the response of the 'Read' interface.","schema":{"type":"string","description":"Id of read operation returned in the response of the 'Read' interface."}}],"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":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"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"}}}}}}}