v16

latestOpenAPI 3.1.0raw.githubusercontent.com2026-03-032765158.3 KB

Documents

Get Page Info

Retrieves information about a specific page. The request parameters define what information you would like to receive.

A 404 Not Found will be returned if either the collection name does not exist, or the document path does not exist within the provided collection.

post/documents/get-page-info

Request body

collection_namestring required

The name of the collection.

pathstring required

The filepath of the document whose page you are requesting. A 404 Not Found status code will be returned if no document with this path was found.

page_indexinteger required

The specific page index whose info is being requested. Pages are 0-indexed, so that the 1st page of a PDF is of page index 0. You may use the num_pages attribute of /documents/get-document-info or /documents/get-document-info-list to know what the range of valid indices are. A 404 Not Found status code will be returned if no such page index exists.

include_contentboolean

If true, then the response will have the content attribute be a string, rather than null. This string will contain the full contents of the page.

Response

Successful Response