Annotation

Retrieve page spatial data

Get text content for every page, including position coordinates, considering granularity options like lines, words, characters, or complete page text content.

get/api/v1/annotations/{annotationID}/page_data

Path parameters

annotationIDinteger required

Annotation ID

Query parameters

page_numbersstring
Example:1,2,3

Comma-separated list of page numbers to retrieve. The default is the first 20 pages of the document. Max. 20 page numbers, if there is more, they are silently ignored.

granularity'words' | 'lines' | 'chars' | 'texts' | 'barcodes' required
Example:words

Level of text granularity to return

Response

Spatial data retrieved successfully

Example response

{
  "results": [
    {
      "page_number": 1,
      "granularity": "words",
      "items": [
        {
          "text": "Invoice",
          "position": [
            100,
            50,
            150,
            20
          ]
        }
      ]
    }
  ]
}

Changes

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