Skip to main content
GET
OCR Result Check

Authorizations

X-API-Key
string
header
required

Path Parameters

request_id
string
required

Cookies

wos-session
string
datalab_active_team
string

Response

Successful Response

status
string
required

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

result_url
string | null

Signed URL for downloading the completed result JSON when direct result download is required.

expires_in
integer | null

Number of seconds until result_url expires.

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 | null

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.