Get a document page

Get the parsed text of a single page of a document. Page numbers are 1-indexed.

On this page

HTTP request 

GET https://api.parsewise.ai/api/v1/projects/{project_id}/documents/{document_id}/pages/{page_number}/

URI Parameters

Name In Required Type Description
document_id path Yes string (uuid)  
page_number path Yes integer  
project_id path Yes string (uuid)  

Request Header

Name Required Type Description
X-API-Key Yes string API key with the pw_live_ prefix. See Authentication.

Responses

Status Type Description
200 V1DocumentPageResponse —

Security

  • ApiKeyAuth — apiKey — in X-API-Key header. API key with pw_live_ prefix.

Python example 

import os
import requests

API_KEY = os.environ["PARSEWISE_API_KEY"]
BASE_URL = "https://api.parsewise.ai/api/v1"

document_id = "<uuid>"
page_number = 0
project_id = "<uuid>"

resp = requests.get(
    f"{BASE_URL}/projects/{project_id}/documents/{document_id}/pages/{page_number}/",
    headers={"X-API-Key": API_KEY},
)
resp.raise_for_status()
print(resp.json() if resp.content else None)

Definitions

DocumentTypeEnum

Type: string. One of:

  • PDF
  • Audio
  • Image
  • Text
  • Excel
  • PPT
  • Word Document
  • Website
  • Email

V1DocumentPageResponse

Name Required Type Description
id Yes string (uuid) Stable identifier for the document page (UUID).
page_number Yes integer 1-indexed page number, matching the page_number in the URL.
parsed_text Yes string Plain-text contents of the page as produced by parsing.
document_type Yes DocumentTypeEnum Type of the parent document.