v1

latestOpenAPI 3.1.02026-07-26151126273.9 KB

OCR Result Check

Poll this endpoint to check status of an OCR request and retrieve final results

get/api/v1/ocr/{request_id}

Path parameters

request_idstring required

Cookies

wos-sessionstring

datalab_active_teamstring

Response

Successful Response

statusstring required

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

result_urlstring nullable

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

expires_ininteger nullable

Number of seconds until result_url expires.

pagesobject[] nullable

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

successboolean nullable

Whether the conversion was successful.

errorstring nullable

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

page_countinteger nullable

The number of pages that had ocr run on them.

total_costinteger nullable

The total cost of the conversion.

cost_breakdownobject nullable

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).