ZUzuva
OCR

Get OCR request

Changed on

Retrieves the status of an OCR request.

get/ocr/{request_id}

Request

Path parameters

request_idstring required

Request ID

Response

The status of an OCR request

file_idstring required
request_idstring required
status'queued' | 'processing' | 'complete' | 'failed' required
page_countinteger
character_countinteger
scan_qualitystring
scan_scoreinteger

Example response

{
  "error": {
    "code": "http-error",
    "message": "Something went wrong, please try again later."
  },
  "file_id": "c5e407f1qk1er7odm6tg",
  "request_id": "c5e463f1qk154j5e3sjg",
  "status": "complete",
  "page_count": 10,
  "character_count": 10000,
  "scan_quality": "A",
  "scan_score": 100
}

Changes

  • 51f2a4c5de2eRevision changes
    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status