PDF OCR Go

File to be converted. Value can be URL or file content.

Sets the password to open protected documents.

Set page range. Example 1-10 or 1,2,5.

The OcrMode setting controls how OCR is applied to PDF pages. In Auto mode, pages that already contain text are skipped, so OCR runs only where needed. In Always mode, OCR is applied to every page, keeping existing text while adding recognition for images and other visual content. In Reprocess mode, OCR is performed on the whole page, producing a fresh text layer regardless of what was there before.

Set the OCR language. Ask support to add your language if missing.

The PageSegmentationMode parameter specifies how the OCR engine segments and interprets text within PDF documents. Choosing the appropriate mode enhances OCR accuracy by aligning closely with your document's layout and structure.

Select one of the available modes to control text detection and layout analysis:

• SparseText - Detects as much text as possible without enforcing any specific order. Suitable for documents containing scattered or fragmented text.
• SparseTextOsd - Similar to SparseText, but also includes orientation and script detection (OSD). Useful for documents with rotated text or multiple scripts and languages.
• Auto - Automatically selects the best segmentation mode based on document content. Ideal for general documents with mixed or unknown layouts.
• AutoOsd - Combines automatic segmentation with orientation and script detection. Recommended for documents with uncertain text orientation or multilingual content.
• SingleColumn - Assumes a single column of text with varying text sizes. Best suited for straightforward layouts.
• SingleLine - Treats the entire image as a single line of text. Useful for single-line labels, banners, or narrow text snippets.
• SingleWord - Treats the entire image as a single word. Ideal for recognizing isolated words or short phrases.

When the StoreFile parameter is set to True, your converted file is written to ConvertAPI’s encrypted, temporary storage and made available via a time-limited secure download URL, valid for up to 3 hours. After this period, the file is permanently deleted.

When StoreFile is set to False, conversion happens entirely in-memory. The raw file bytes are streamed back in the API response without touching disk or external storage, ensuring maximum security and zero persistence so that only you can access the content.

This property is used to determine how the OCR layer should be returned. If the output type is PDF, the OCR layer will be embedded into the PDF file. Alternatively, if a text output is selected, the OCR layer will be returned as a text file.