POST
/ocr/convert
Authenticated
Initiate a OCR conversion job. Converts uploaded files into OCR-processed formats including text, JSON, PDF, PDF/A, and hOCR. Converts to PDF by default.

Authentication

To authenticate, include your API key in the x-api-key header of your request.

Input File

Input Parameters

This route accepts a string-encoded JSON object under the FormData key options, containing the following parameters.

Response

The response contains a JSON object with the following keys:

POST
/ocr/status
Authenticated
Retrieve the processing status of up to 100 ongoing OCR jobs.

Authentication

To authenticate, include your API key in the x-api-key header of your request.

Input Parameters

This route accepts a JSON-formatted request body with the following parameters.

Response

The response contains a JSON object with the following key:

GET
/ocr/download/<job_id>
Authenticated
Download the OCR product for any job_id (specified in the URL)

Authentication

To authenticate, include your API key in the x-api-key header of your request.

Input Parameters

This route accepts a single job_id within the URL.

Response

This route returns an HTTP 302 redirect to a pre-signed download URL for the OCR product.