Layers

Fetch Document Text

This endpoint allows you to fetch the text of all pages in a document.

get/api/documents/{documentId}/layers/{layerName}/pages/text

Request

  • Base URL: http://localhost:5000
  • URL: http://localhost:5000/api/documents/{documentId}/layers/{layerName}/pages/text
  • Auth: one of:
    • API key in header Authorization
    • HTTP bearer

Path parameters

documentIdstring required

The document ID

layerNamestring required

The layer name

Headers

pspdfkit-pdf-passwordstring

The PDF document password.

The value can be either a plain-text password or a base64 encoded password in a form base64:<encoded-password>. Use the Base64 encoding if your password contains characters that are not allowed in HTTP header or would be otherwise mangled (e.g. trailing or leading spaces)

If the document is password protected, any operations performed on it require supplying a password.

Response

Document Engine returned the lines of text for all pages in the layer.

pageIndexinteger required

0-based index of the page.

Example response

[
  {
    "textLines": [
      {
        "contents": "PSPDKit is a leading PDF SDK for Mobile and Web",
        "height": 14,
        "width": 331.7496337890625,
        "left": 79.02290344238281,
        "top": 312.2259521484375
      }
    ]
  }
]

Changes

No recorded changes to this operation across all 1 revision of this API.