PDF - Extract Text by Page

** AVAILABLE FROM JULY / AUGUST 2025 **

Overview

The 'PDF - Extract Text by Page' flow action extracts and returns the text layer from the PDF document provided. 

Whilst this action is limited to extracting text from PDF documents, simply convert files to PDF format using the 'Convert to PDF' flow action prior to executing this action to enable text to be extracted from 70+ different file types.

Please refer to the Supported Document Types articles for a complete list of the different file formats/document types which are supported for PDF conversion.

Credit Count

This action consumes 1 credit per operation.

Note, different Encodian actions can consume different number credits. Please always check the action specific documentation and read What is an Encodian Action for a full description of how credits are consumed.

Parameters

The default 'PDF - Extract Text by Page' flow action parameters are detailed below:

• File Content: A Base64 encoded representation of the PDF file to be processed.

Please refer to the Obtaining the 'File Contents' Parameter article for guidance on how to obtain the 'File Content' parameter ready to provide to an Encodian flow action. 

Advanced Parameters

The advanced 'PDF - Extract Text by Page' flow action parameters are detailed below:

• Start Page: Sets the page number to begin text extraction from, defaults to the document's first page.
• End Page: Sets the page number to end text layer extraction from, defaults to the document's last page.
• Page Numbers: A comma separated list of page numbers of the pages to extract hyperlinks from: 1,3,4
• Remove Control Characters: Set whether to automatically remove 'Control Characters' from the extracted text
• Encoding Type: Sets the encoding type used for text extraction, and defaults to UTF8.

Return Parameters

The 'PDF - Extract Text by Page' flow action returns the following data:

Action Specific Return Values

• Pages - The collection of text values extracted from the PDF document provided

Each page within the pages collection contains the following values:

• Pages Number - The page number the text was extracted from
• Pages Text - The text value extracted

Standard Return Values

• OperationId: The unique ID assigned to this operation.
• HttpStatusCode: The HTTP Status code for the response.
• HttpStatusMessage: The HTTP Status message for the response.
• Errors: An array of error messages should an error occur.
• Operation Status: Indicates whether the operation has been completed, has been queued or has failed.