Skip to main content
POST
Get Page Info

Authorizations

Authorization
string
header
required

The Authorization header must be provided in the format Bearer <your-api-key>.

You can get your API Key at the Dashboard!

Body

application/json
collection_name
string
required

The name of the collection.

path
string
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_index
integer
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_content
boolean
default:false

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

page
PageResponse · object
required