GET
/
v3
/
annotations
/
{id}
Get specific annotation
curl --request GET \
  --url https://{region}.affinda.com/v3/annotations/{id} \
  --header 'Authorization: Bearer <token>'
{
  "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
    }
  ],
  "document": "<string>",
  "pageIndex": 0,
  "raw": "<string>",
  "confidence": 0.86,
  "classificationConfidence": 0.95,
  "textExtractionConfidence": 0.9,
  "isVerified": true,
  "isClientVerified": true,
  "isAutoVerified": true,
  "dataPoint": "<string>",
  "field": "<string>",
  "contentType": "text",
  "parent": 123
}

Authorizations

Authorization
string
header
required

Basic authentication using an API key, e.g. {Authorization: Bearer aff_0bb4fbdf97b7e4111ff6c0015471094155f91}. You can find your API key within the Settings page of the Affinda web app. You can obtain an API key by signing up for a free trial.

Path Parameters

id
integer
required

Annotation's ID

Required range: x >= 1
Example:

1

Response

200
application/json

Successfully retrieved annotation.

The response is of type object.