{"openapi":"3.1.0","info":{"title":"Apizie","version":"2.0.0","description":"One API key, one envelope, many public data sources."},"servers":[{"url":"https://www.apizie.tech"}],"security":[{"ApiKeyAuth":[]}],"paths":{"/v1/dev-tools:microsoft-cognitiveservices-computer-vision/analyze-image":{"post":{"operationId":"dev_tools_microsoft_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":["dev-tools"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["body"],"properties":{"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","enum":["en","es","ja","pt","zh"],"default":"en","description":"The desired language for output generation. If this parameter is not specified, the default value is "en".Supported languages:en…"},"descriptionExclude":{"type":"array","description":"Turn off specified domain models when generating the description."},"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/dev-tools:microsoft-cognitiveservices-computer-vision/get-area-of-interest":{"post":{"operationId":"dev_tools_microsoft_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":["dev-tools"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["body"],"properties":{"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/dev-tools:microsoft-cognitiveservices-computer-vision/describe-image":{"post":{"operationId":"dev_tools_microsoft_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":["dev-tools"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["body"],"properties":{"maxCandidates":{"type":"integer","default":1,"description":"Maximum number of candidate descriptions to be returned. The default is 1."},"language":{"type":"string","enum":["en","es","ja","pt","zh"],"default":"en","description":"The desired language for output generation. If this parameter is not specified, the default value is "en".Supported languages:en…"},"descriptionExclude":{"type":"array","description":"Turn off specified domain models when generating the description."},"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/dev-tools:microsoft-cognitiveservices-computer-vision/detect-objects":{"post":{"operationId":"dev_tools_microsoft_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":["dev-tools"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["body"],"properties":{"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/dev-tools:microsoft-cognitiveservices-computer-vision/generate-thumbnail":{"post":{"operationId":"dev_tools_microsoft_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":["dev-tools"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["width","height","body"],"properties":{"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."},"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/dev-tools:microsoft-cognitiveservices-computer-vision/list-models":{"get":{"operationId":"dev_tools_microsoft_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":["dev-tools"],"parameters":[],"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/dev-tools:microsoft-cognitiveservices-computer-vision/analyze-image-by-domain":{"post":{"operationId":"dev_tools_microsoft_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":["dev-tools"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["model","body"],"properties":{"model":{"type":"string","description":"The domain-specific content to recognize."},"language":{"type":"string","enum":["en","es","ja","pt","zh"],"default":"en","description":"The desired language for output generation. If this parameter is not specified, the default value is "en".Supported languages:en…"},"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/dev-tools:microsoft-cognitiveservices-computer-vision/recognize-printed-text":{"post":{"operationId":"dev_tools_microsoft_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":["dev-tools"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["detectOrientation","body"],"properties":{"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'."},"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/dev-tools:microsoft-cognitiveservices-computer-vision/tag-image":{"post":{"operationId":"dev_tools_microsoft_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":["dev-tools"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["body"],"properties":{"language":{"type":"string","enum":["en","es","ja","pt","zh"],"default":"en","description":"The desired language for output generation. If this parameter is not specified, the default value is "en".Supported languages:en…"},"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/dev-tools:microsoft-cognitiveservices-computer-vision/analyze-image-in-stream":{"post":{"operationId":"dev_tools_microsoft_cognitiveservices_computer_vision_analyze_image_in_stream","summary":"This operation extracts a rich set of visual features based on the image content. Two input methods are…","description":"POST /analyze","tags":["dev-tools"],"parameters":[],"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"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","enum":["en","es","ja","pt","zh"],"default":"en","description":"The desired language for output generation. If this parameter is not specified, the default value is "en".Supported languages:en…"},"descriptionExclude":{"type":"array","description":"Turn off specified domain models when generating the description."}}}}}},"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/dev-tools:microsoft-cognitiveservices-computer-vision/get-area-of-interest-in-stream":{"post":{"operationId":"dev_tools_microsoft_cognitiveservices_computer_vision_get_area_of_interest_in_stream","summary":"This operation returns a bounding box around the most important area of the image. A successful response…","description":"POST /areaOfInterest","tags":["dev-tools"],"parameters":[],"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/dev-tools:microsoft-cognitiveservices-computer-vision/describe-image-in-stream":{"post":{"operationId":"dev_tools_microsoft_cognitiveservices_computer_vision_describe_image_in_stream","summary":"This operation generates a description of an image in human readable language with complete sentences. The…","description":"POST /describe","tags":["dev-tools"],"parameters":[],"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"maxCandidates":{"type":"integer","default":1,"description":"Maximum number of candidate descriptions to be returned. The default is 1."},"language":{"type":"string","enum":["en","es","ja","pt","zh"],"default":"en","description":"The desired language for output generation. If this parameter is not specified, the default value is "en".Supported languages:en…"},"descriptionExclude":{"type":"array","description":"Turn off specified domain models when generating the description."}}}}}},"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/dev-tools:microsoft-cognitiveservices-computer-vision/detect-objects-in-stream":{"post":{"operationId":"dev_tools_microsoft_cognitiveservices_computer_vision_detect_objects_in_stream","summary":"Performs object detection on the specified image. Two input methods are supported -- (1) Uploading an image…","description":"POST /detect","tags":["dev-tools"],"parameters":[],"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/dev-tools:microsoft-cognitiveservices-computer-vision/generate-thumbnail-in-stream":{"post":{"operationId":"dev_tools_microsoft_cognitiveservices_computer_vision_generate_thumbnail_in_stream","summary":"This operation generates a thumbnail image with the user-specified width and height. By default, the service…","description":"POST /generateThumbnail","tags":["dev-tools"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["width","height"],"properties":{"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."}}}}}},"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/dev-tools:microsoft-cognitiveservices-computer-vision/analyze-image-by-domain-in-stream":{"post":{"operationId":"dev_tools_microsoft_cognitiveservices_computer_vision_analyze_image_by_domain_in_stream","summary":"This operation recognizes content within an image by applying a domain-specific model. The list of…","description":"POST /models/{model}/analyze","tags":["dev-tools"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["model"],"properties":{"model":{"type":"string","description":"The domain-specific content to recognize."},"language":{"type":"string","enum":["en","es","ja","pt","zh"],"default":"en","description":"The desired language for output generation. If this parameter is not specified, the default value is "en".Supported languages:en…"}}}}}},"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/dev-tools:microsoft-cognitiveservices-computer-vision/recognize-printed-text-in-stream":{"post":{"operationId":"dev_tools_microsoft_cognitiveservices_computer_vision_recognize_printed_text_in_stream","summary":"Optical Character Recognition (OCR) detects text in an image and extracts the recognized characters into a…","description":"POST /ocr","tags":["dev-tools"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["detectOrientation"],"properties":{"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'."}}}}}},"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/dev-tools:microsoft-cognitiveservices-computer-vision/tag-image-in-stream":{"post":{"operationId":"dev_tools_microsoft_cognitiveservices_computer_vision_tag_image_in_stream","summary":"This operation generates a list of words, or tags, that are relevant to the content of the supplied image.…","description":"POST /tag","tags":["dev-tools"],"parameters":[],"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"language":{"type":"string","enum":["en","es","ja","pt","zh"],"default":"en","description":"The desired language for output generation. If this parameter is not specified, the default value is "en".Supported languages:en…"}}}}}},"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"}}}}}}}