---
title: "Get Page Info"
method: POST
path: "/documents/get-page-info"
tags: ["Documents"]
---

# Get Page Info

`POST /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.

## Request body

- GetPageInfoRequest
  - `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 — 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 `200`

Successful Response

- GetPageInfoResponse
  - `page` PageResponse, required
    - `id` string, uuid, required
    - `collection_name` string, required — The name of the collection.
    - `path` string, required — The filepath of the document associated with this page.
    - `page_index` integer, required — The specific page index of this page. Pages are 0-indexed, so that the 1st page of a PDF is of page index 0.
    - `content` string, nullable — The content of the page. This field will only be provided if `include_content` was set to `true`, and the document has finished parsing. Otherwise, this field will be set to `null`.
    - `image_url` string, nullable, required — A URL to an image of the page. This field will only be provided if the document has finished parsing, and if it is a filetype that is capable of producing images (e.g. PDF, DOCX, PPT, etc). In all other cases, this field will be `null`. NOTE: If a `/documents/update-document` call returned a new document id, then this url will be invalidated and must be retrieved again.

## Other responses

- `400` — Bad Request
- `404` — Not Found
- `422` — Validation Error

## Changes

- **2025-01-27** `99a41bb73e43` — 2 warning, 1 info
  - removed the request property `include_image`
  - removed the optional property `page/image_base64_data` from the response with the `200` status
  - added the required property `page/image_url` to the response with the `200` status

[Change history](https://skmtc.dev/zeroentropy-ai/apis/zeroentropy-api/changes/documents/get-page-info/post.md)

---

[API](https://skmtc.dev/zeroentropy-ai/apis/zeroentropy-api.md) · [All operations](https://skmtc.dev/zeroentropy-ai/apis/zeroentropy-api/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/zeroentropy-ai/zeroentropy-api/revisions/5ff1b24060b9/schema)