APIHub
Back to Explore

Computer Vision Client

The Computer Vision Client provides asynchronous OCR capabilities, letting you submit images or documents for batch reading or text recognition, receive an operation URL, and later poll that URL to retrieve the extracted text results.

Development
apiKeyHeader
HTTPS
CORS: Unknown
Description enriched
Visit official documentation

Latency

340ms p95

Uptime

100.0% 30d

Playground

Verified

live

Endpoints

REST · JSON
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 documents. When you use the Read File interface, the response contains a field called 'Operation-Location'. The 'Operation-Location' field contains the URL that you must use for your 'GetReadOperationResult' operation to access OCR results.​

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 Batch Read File interface.

  • operationId (path, required) — Id of read operation returned in the response of the 'Batch Read File' interface.
POST

/recognizeText

Recognize Text operation. When you use the Recognize Text interface, the response contains a field called 'Operation-Location'. The 'Operation-Location' field contains the URL that you must use for your Get Recognize Text Operation Result operation.

  • mode (query, required) — Type of text to recognize.
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 Text interface.

  • operationId (path, required) — Id of the text operation returned in the response of the 'Recognize Text'

4 endpoints auto-detected

Authentication

This API uses an API key, passed in the "Ocp-Apim-Subscription-Key" header. No OAuth required.

curl -X POST \
  "https://westcentralus.api.cognitive.microsoft.com/vision/v2.1/read/core/asyncBatchAnalyze" \
  -H "Ocp-Apim-Subscription-Key: YOUR_API_KEY"

westcentralus.api.cognitive.microsoft.com · HTTPS only