AFaffinda
Annotations

Get list of all annotations

Changed on

Returns your annotations.

get/v3/annotations

Request

Query parameters

documentstring required

Unique identifier for the document

Filter by document.

Response

All matching annotations.

countinteger required

Number of items in results.

nextstring nullable

URL to request next page of results.

previousstring nullable

URL to request previous page of results.

Example response

{
  "count": 10,
  "results": [
    {
      "id": 1,
      "rectangle": {
        "pageIndex": 1,
        "x0": 2.43,
        "y0": 4.55,
        "x1": 4.56,
        "y1": 6.32
      },
      "rectangles": [
        {
          "pageIndex": 1,
          "x0": 2.43,
          "y0": 4.55,
          "x1": 4.56,
          "y1": 6.32
        }
      ],
      "confidence": 0.86,
      "classificationConfidence": 0.95,
      "textExtractionConfidence": 0.9
    }
  ]
}

Changes

  • 978cf99a2ac0Revision changes
    • info

      api tag Annotations added

    • info

      api tag Document API - Annotation removed

  • 0913ed9391cbRevision changes
    • breaking

      the response property /// became optional for the status

    • info

      added the optional property /// to the response with the status