Read

Frends task to read Pdf documents

Task version: 1.2.0

Required Frends version: 5.7+

Required .NET version: 8.0

Compatible Agents: Crossplatform

Source code: https://github.com/FrendsPlatform/Frends.Pdf/tree/main/Frends.Pdf.Read

Task Parameters

Input

Name	Description
FilePath : String	Full path to the PDF file. Default: - Example: C:\temp\file.pdf

Options

Name	Description
IncludeImages : Boolean	Include images in result. Default: False Example: false
ThrowErrorOnFailure : Boolean	Whether to throw an error on failure. Default: True Example: true
ErrorMessageOnFailure : String	Overrides the error message on failure. Default: - Example: Custom error message

Task Result

Name	Description
Success : Boolean	Indicates if the task completed successfully. Example: true
Json : String	JSON representation of the extracted PDF content, including document metadata and page-level content. Text is extracted in reading order; tables and columns are flattened. Images (if IncludeImages is true) are returned as a byte array, with its width and height. If the extraction library could convert the image, Format is "PNG"; otherwise Format is "RAW". A single visible image may produce multiple extracted images due to transparency masks or internal PDF structure. Example: { "Metadata": { "Title": "Example PDF", "Author": "John Doe", "PageCount": 2 }, "Pages": [ { "Number": 1, "Text": "Hello world", "Images": [] }, { "Number": 2, "Text": "Second page text", "Images": [] } ] }
Error : Error	Error that occurred during task execution. Example: object { string Message, Exception AdditionalInfo }

Task Changelog

Changelog for Task Frends.Pdf.Read.

[1.2.0] - 2026-02-23

Fixed

• Ensure FrendsTaskMetadata.json is included in NuGet package

[1.1.0] - 2026-02-03

Changed

• Rename task prefix from PDF to Pdf

[1.0.0] - 2026-01-19

Added

• Initial implementation