Sign in
Annotation

Search text

Search for a phrase in the document.

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

Query parameters

phrasestring required

A phrase to search for.

toleranceinteger

Allowed Edit distance from the search phrase (number of removal, insertion or substitution operations that need to be performed for strings to match). Only used for OCR invoices (images, such as png or PDF with scanned images). Default value is computed as length(phrase)/4.

Response

OK

Example response

{
  "results": [
    {
      "rectangle": [
        67.15157010915198,
        545.9286363906203,
        87.99106633081445,
        563.4617583852776
      ],
      "page": 1
    }
  ]
}

Changes

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