Get Document Page
get_pageReturns one page of an FAA document from Aviation Resources: an image of the whole page plus the full text of the passages on it. Use it after search_documents to read a page in full or to see figures, charts and tables, or to read on with nextPageNumber / previousPageNumber. Cite the page with its viewerUrl.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| pageNumber | Yes | 1-based page number in the PDF, as search_documents returns it (not the number printed on the page). | |
| resourceId | Yes | The document's ID, from search_documents. | |
| includeImage | No | Set false to get only the text, for example when reading through several pages. |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| image | Yes | Describes the image content block (the whole page), or null when there is none. | |
| indexed | Yes | False when the document has no text index yet; passages is then empty. | |
| passages | Yes | Every indexed passage that covers this page, in document order. | |
| resource | Yes | ||
| viewerUrl | Yes | Opens this page in the Aviation Resources web app. Give this to the user as the source link. | |
| pageNumber | Yes | ||
| nextPageNumber | Yes | The page after, or null on the last page. | |
| previousPageNumber | Yes | The page before, or null on the first page. | |
| imageUnavailableReason | Yes | Why image is null when an image was asked for. |