Run OCR

Extract searchable text from a supported image or document.

Authentication

API key

Scopes

jobs:create

Contract

API v1

Request

curl -X POST 'https://api.maxscanner.app/api/v1/ocr' \
  -H 'Authorization: Bearer $MAXSCANNER_API_KEY' \
  -H 'Content-Type: application/json' \
  -H 'Idempotency-Key: unique-request-id' \
  -d '{ "sourceKey": "…", "format": "text" }'

Request body

{ "sourceKey": "…", "format": "text" }

Response

{ "jobId": "job_123", "status": "queued" }

Implementation notes

OCR runs through the processing queue.

Try this endpoint

Use the API Playground to authenticate and test safely before wiring the endpoint into your application.

Open Playground →