Computer Vision Client API

by microsoft.com

Overview

The Computer Vision API provides state-of-the-art algorithms to process images and return information. For example, it can be used to determine if an image contains mature content, or it can be used to find all the faces in an image. It also has other features like estimating dominant and accent colors, categorizing the content of images, and describing an image with complete English sentences. Additionally, it can also intelligently generate images thumbnails for displaying large images effectively.

Computer Vision Client is a development API from microsoft.com. Requests are authenticated with an API key. It is served over HTTPS. Its OpenAPI description documents 13 endpoints.

At a glance

Authentication: API key
HTTPS: Yes
CORS: Unknown
Category: Development
Base URL: https://westcentralus.api.cognitive.microsoft.com/vision/v2.1
Version: 2.1
Endpoints: 13
OpenAPI: Specification ↗
Spec updated: 2023-02-15

Make a first request

Replace the placeholders; the documentation says exactly where credentials go.

cURL

curl -X GET "https://westcentralus.api.cognitive.microsoft.com/vision/v2.1/models" \
  -H "Accept: application/json" \
  -H "X-API-Key: YOUR_API_KEY"

JavaScript

const response = await fetch("https://westcentralus.api.cognitive.microsoft.com/vision/v2.1/models", {
  method: "GET",
  headers: {
    "Accept": "application/json",
    "X-API-Key": "YOUR_API_KEY",
  },
});
const data = await response.json();
console.log(data);

Python

import requests

response = requests.request(
    "GET",
    "https://westcentralus.api.cognitive.microsoft.com/vision/v2.1/models",
    headers={
    "Accept": "application/json",
    "X-API-Key": "YOUR_API_KEY",
    },
    timeout=30,
)
print(response.json())

Endpoints

Method	Path	What it does
POST	`/analyze`	This operation extracts a rich set of visual features based on the image content.
POST	`/areaOfInterest`	This operation returns a bounding box around the most important area of the image.
POST	`/describe`	This operation generates a description of an image in human readable language with complete sentences. The description is based on a collection of content tags,
POST	`/detect`	Performs object detection on the specified image.
POST	`/generateThumbnail`	This operation generates a thumbnail image with the user-specified width and height. By default, the service analyzes the image, identifies the region of intere
GET	`/models`	This operation returns the list of domain-specific models that are supported by the Computer Vision API. Currently, the API supports following domain-specific m
POST	`/models/{model}/analyze`	This operation recognizes content within an image by applying a domain-specific model. The list of domain-specific models that are supported by the Computer Vis
POST	`/ocr`	Optical Character Recognition (OCR) detects text in an image and extracts the recognized characters into a machine-usable character stream.
POST	`/tag`	This operation generates a list of words, or tags, that are relevant to the content of the supplied image. The Computer Vision API can return tags based on obje
POST	`/read/core/asyncBatchAnalyze`	Use this interface to get the result of a Read operation, employing the state-of-the-art Optical Character Recognition (OCR) algorithms optimized for text-heavy
GET	`/read/operations/{operationId}`	This interface is used for getting OCR results of Read operation. The URL to this interface should be retrieved from 'Operation-Location' field returned from Ba
POST	`/recognizeText`	Recognize Text operation. When you use the Recognize Text interface, the response contains a field called 'Operation-Location'. The 'Operation-Location' field c
GET	`/textOperations/{operationId}`	This interface is used for getting text operation result. The URL to this interface should be retrieved from 'Operation-Location' field returned from Recognize