Skip to main content
GET
/
api
/
v1
/
ocr
/
{request_id}
OCR Result Check
curl --request GET \
  --url https://www.datalab.to/api/v1/ocr/{request_id} \
  --header 'X-API-Key: <api-key>'
{
  "status": "<string>",
  "pages": [
    {}
  ],
  "success": true,
  "error": "<string>",
  "page_count": 123,
  "total_cost": 123,
  "cost_breakdown": {},
  "versions": {}
}

Authorizations

​
X-API-Key
string
header
required

Path Parameters

​
request_id
string
required

Cookies

​
access_token
string

Response

Successful Response

​
status
string
required

The status of the request. Should be 'complete' when the request is done.

​
pages
Pages · object[] | null

The detected OCR text on each page. Each page will have the bboxes and detected text within each line.

​
success
boolean | null

Whether the conversion was successful.

​
error
string | null

If the conversion was not successful, this will contain an error message.

​
page_count
integer | null

The number of pages that had ocr run on them.

​
total_cost
integer | null
deprecated

The total cost of the conversion.

​
cost_breakdown
Cost Breakdown · object

A dictionary of the cost breakdown of this request. Includes the list cost without discounts and final cost to clients after any discounts (e.g. for opting into model training).

​
versions

A dictionary of the versions of the libraries used in the request.