Documents

Fetch Highlighted Text on a Page

Highlighted text in the document refers to any text that is highlighted with any of the markup annotations, like underline, strikeout, or highlight.

Note that the data returned by this endpoint is just an approximation and might not always exactly reflect the text highlighted in the PDF file.

get/api/documents/{documentId}/pages/{pageIndex}/highlighted

Request

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

Path parameters

documentIdstring required

The document ID

pageIndexinteger required

The index of the page in the document

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 highlighted text along with respective markup annotations.

Example response

{
  "data": [
    {
      "annotation": {
        "content": {
          "bbox": [
            255.10077620466092,
            656.7566095695641,
            145.91672653256705,
            18.390804597701162
          ],
          "action": {
            "relativePath": "/other_document.pdf"
          },
          "id": "01DNEDPQQ22W49KDXRFPG4EPEQ",
          "createdAt": "2019-09-16T15:05:03.712909Z",
          "updatedAt": "2019-09-16T15:05:03.712909Z",
          "customData": {
            "foo": "bar"
          },
          "rects": [
            [
              100,
              200,
              300,
              400
            ]
          ],
          "color": "#fcee7c",
          "note": "This is a note."
        },
        "id": "01DNEDPQQ22W49KDXRFPG4EPEQ"
      },
      "text": "a very important piece of content"
    }
  ]
}

Changes

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