Sign in

v44

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

Process document with OCR

Submit a document for OCR processing to extract text, detect tables, forms, and other features. Supports PDFs, images, and scanned documents. Returns a job ID that can be used to track processing status.

post/ocr/v1/process

Request body

document_urlstring required

URL or S3 path to the document to process

document_idstring

Optional custom document identifier

callback_urlstring

URL to receive completion webhook

engine'doctr' | 'paddleocr'

OCR engine to use

result_bucketstring

S3 bucket to store results

result_prefixstring

S3 key prefix for results

Example request

{
  "document_url": "https://example.com/contract.pdf",
  "document_id": "contract-2024-001",
  "callback_url": "https://your-app.com/webhooks/ocr-complete",
  "engine": "doctr",
  "features": {
    "embed": {},
    "tables": {
      "format": "csv"
    }
  },
  "result_bucket": "my-ocr-results",
  "result_prefix": "ocr/2024/"
}

Response

OCR job created successfully

idstring

Unique job identifier

status'queued' | 'processing' | 'completed' | 'failed'

Current job status

document_idstring

Document identifier

enginestring

OCR engine used

page_countinteger

Number of pages detected

created_atstring date-time

Job creation timestamp

estimated_completionstring date-time

Estimated completion time