PDF - Extract Hyperlinks

** AVAILABLE JUNE / JULY 2025 **

Overview

The 'PDF - Extract Hyperlinks' flow action extracts hyperlinks from the PDF document provided pertaining to the set configuration.

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.

Default Parameters

The default 'PDF - Extract Hyperlinks' flow action parameters are detailed below:

• File Content: The PDF document to process

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 Hyperlinks' flow action parameters are detailed below:

• Advanced Data: Set whether to return additional information such as Text, Hyperlink and Page Number
• Start Page: Specifies the page number to start extracting hyperlinks from
• End Page: Specifies the page number to stop extracting hyperlinks on
• Page Numbers: A comma separated list of page numbers of the pages to extract hyperlinks from: 1,3,4

Return Parameters

The 'PDF - Extract Hyperlinks' flow action returns the following data. 

Action Specific Return Values

• Result - A JSON array of the extracted hyperlinks

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.