POST
/
v3
/
annotations
Create a annotation
curl --request POST \
  --url https://{region}.affinda.com/v3/annotations \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "rectangles": [
    {
      "pageIndex": 1,
      "x0": 2.43,
      "y0": 4.55,
      "x1": 4.56,
      "y1": 6.32
    }
  ],
  "document": "<string>",
  "pageIndex": 0,
  "dataPoint": "<string>",
  "field": "<string>",
  "raw": "<string>",
  "parsed": "<string>",
  "isClientVerified": true,
  "parent": 123,
  "validationResults": [
    {
      "created": [
        {
          "id": 1,
          "annotations": [
            1,
            2,
            3
          ],
          "passed": true,
          "ruleSlug": "supplier-name-is-alphanumeric",
          "message": "Expected '\''ThisInputShouldMatch'\'' to match regex pattern '\''[0-9]*",
          "document": "<string>"
        }
      ],
      "updated": [
        {
          "id": 1,
          "annotations": [
            1,
            2,
            3
          ],
          "passed": true,
          "ruleSlug": "supplier-name-is-alphanumeric",
          "message": "Expected '\''ThisInputShouldMatch'\'' to match regex pattern '\''[0-9]*",
          "document": "<string>"
        }
      ],
      "deleted": [
        {
          "id": 1,
          "annotations": [
            1,
            2,
            3
          ],
          "passed": true,
          "ruleSlug": "supplier-name-is-alphanumeric",
          "message": "Expected '\''ThisInputShouldMatch'\'' to match regex pattern '\''[0-9]*",
          "document": "<string>"
        }
      ]
    }
  ]
}'
{
  "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,
  "validationResults": [
    {
      "id": 1,
      "annotations": [
        1,
        2,
        3
      ],
      "passed": true,
      "ruleSlug": "supplier-name-is-alphanumeric",
      "message": "Expected 'ThisInputShouldMatch' to match regex pattern '[0-9]*",
      "document": "<string>"
    }
  ]
}

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.

Body

application/json

Response

201
application/json

Successfully created a annotation.

The response is of type object.