> For the complete documentation index, see [llms.txt](https://docs.frends.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.frends.com/tasks/tasks/pdf/read.md). # Read Task version: 1.3.0 Required Frends version: 5.7+ Required .NET version: 8.0 Compatible Agents: Crossplatform Source code: ## Task Parameters {% tabs %} {% tab title="Input" %} | Name | Description | | ------------------- | ------------------------------------------------------------------------------------------------------------- | | FilePath : `String` |

Full path to the PDF file.


Default: -
Example: C:\temp\file.pdf

| | {% endtab %} | | {% tab title="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

| | {% endtab %} | | | {% endtabs %} | | ## 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.3.0] - 2026-08-17 #### Changed * Updated copyright metadata to comply with platform standards. ### \[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 --- # Agent Instructions This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com. ## Querying This Documentation If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question. Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter: ``` GET https://docs.frends.com/tasks/tasks/pdf/read.md?ask=&goal= ``` `ask` is the immediate question: it should be specific, self-contained, and written in natural language. `goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal. The response will contain a direct answer to the question and relevant excerpts and sources from the documentation. Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.