API ReferenceOCR

Run OCR (Async)

Run OCR on an Base64 encoded image or PDF. This endpoint will return immediately and the OCR will be processed asynchronously.

Headers

AuthorizationstringRequired

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

Request

This endpoint expects an object.
mimeTypestringRequired

MIME type of the image. Supported types are image/png, image/jpeg, and application/pdf.

imagestringRequired

Base64 encoded image or PDF. PNG, JPG, WEBP, and PDF are supported. 10MB max.

vendorNetworkenumOptional

Limit OCR vendor search to a specific network

Allowed values:
entityIdstringOptional

When using the Entity vendor network, specify the entity to use if. EntityId on an auth token will take precedence over this parameter.

Response

This endpoint returns an object.
jobIdstring

Errors