Sign in

v44

latestOpenAPI 3.1.0Proprietaryraw.githubusercontent.com2026-05-192301780.0 KB
OCR

Get OCR job status

Retrieve the status and results of an OCR job. Returns job progress, extracted text, and metadata when processing is complete.

get/ocr/v1/{id}

Path parameters

idstring required

The OCR job ID returned from the create OCR endpoint

Query parameters

include_text'true' | 'false'

Include full OCR text in completed responses (default: true)

Response

OCR job status and results

idstring required

OCR job ID

status'pending' | 'processing' | 'completed' | 'failed' required

Current job status

page_countinteger

Number of pages processed

textstring

Extracted text content (when completed)

metadataobject

Additional processing metadata

created_atstring date-time required

Job creation timestamp

completed_atstring date-time

Job completion timestamp