Skip to navigation

Get Ocr Document

Get OCR processing status and extracted pages for an owned OCR document.

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Path parameters

document_idUUIDRequired
OCR document ID returned by public OCR creation.

Response

This endpoint returns an object.
document_idUUID
Stable OCR document ID. Internally this is also the current OCR job key.
titlestring
Document title.
completed_pagesinteger
Pages successfully processed so far.
failed_pagesinteger
Pages that failed processing so far.
statusstring
OCR status such as PENDING, PROCESSING, COMPLETED, or FAILED.
pageslist of objects
OCR output by page.
folder_idUUIDOptional
Containing document folder, or null for root.
file_namestringOptional
Original file name.
created_atdatetimeOptional
Document creation time.
num_pagesintegerOptional
Total number of pages detected.
errorstringOptional

User-facing failure reason, when available. A failed document may still contain successfully extracted pages.

Errors

401
Authentication Error
404
OCR Document Not Found