Update an annotation

curl --request PATCH \
  --url https://{region}.affinda.com/v3/annotations/{id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data @- <<EOF
{
  "rectangles": [
    {
      "x0": 2.43,
      "y0": 4.55,
      "x1": 4.56,
      "y1": 6.32,
      "pageIndex": 1
    }
  ],
  "document": "<string>",
  "pageIndex": 0,
  "raw": "<string>",
  "parsed": "<string>",
  "isClientVerified": true,
  "dataPoint": "<string>",
  "field": "<string>",
  "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>"
        }
      ]
    }
  ]
}
EOF

import requests

url = "https://{region}.affinda.com/v3/annotations/{id}"

payload = {
    "rectangles": [
        {
            "x0": 2.43,
            "y0": 4.55,
            "x1": 4.56,
            "y1": 6.32,
            "pageIndex": 1
        }
    ],
    "document": "<string>",
    "pageIndex": 0,
    "raw": "<string>",
    "parsed": "<string>",
    "isClientVerified": True,
    "dataPoint": "<string>",
    "field": "<string>",
    "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>"
                }
            ]
        }
    ]
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.patch(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'PATCH',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    rectangles: [{x0: 2.43, y0: 4.55, x1: 4.56, y1: 6.32, pageIndex: 1}],
    document: '<string>',
    pageIndex: 0,
    raw: '<string>',
    parsed: '<string>',
    isClientVerified: true,
    dataPoint: '<string>',
    field: '<string>',
    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>'
          }
        ]
      }
    ]
  })
};

fetch('https://{region}.affinda.com/v3/annotations/{id}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

{
  "id": 1,
  "rectangle": {
    "x0": 2.43,
    "y0": 4.55,
    "x1": 4.56,
    "y1": 6.32,
    "pageIndex": 1
  },
  "rectangles": [
    {
      "x0": 2.43,
      "y0": 4.55,
      "x1": 4.56,
      "y1": 6.32,
      "pageIndex": 1
    }
  ],
  "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>",
  "parent": 123
}

{
  "type": "validation_error",
  "errors": [
    {
      "attr": "non_field_errors",
      "code": "unique",
      "detail": "This index name has already been used"
    }
  ]
}

{
  "type": "validation_error",
  "errors": [
    {
      "attr": "non_field_errors",
      "code": "unique",
      "detail": "This index name has already been used"
    }
  ]
}

{
  "type": "validation_error",
  "errors": [
    {
      "attr": "non_field_errors",
      "code": "unique",
      "detail": "This index name has already been used"
    }
  ]
}

PATCH

annotations

{id}

Update an annotation

curl --request PATCH \
  --url https://{region}.affinda.com/v3/annotations/{id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data @- <<EOF
{
  "rectangles": [
    {
      "x0": 2.43,
      "y0": 4.55,
      "x1": 4.56,
      "y1": 6.32,
      "pageIndex": 1
    }
  ],
  "document": "<string>",
  "pageIndex": 0,
  "raw": "<string>",
  "parsed": "<string>",
  "isClientVerified": true,
  "dataPoint": "<string>",
  "field": "<string>",
  "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>"
        }
      ]
    }
  ]
}
EOF

import requests

url = "https://{region}.affinda.com/v3/annotations/{id}"

payload = {
    "rectangles": [
        {
            "x0": 2.43,
            "y0": 4.55,
            "x1": 4.56,
            "y1": 6.32,
            "pageIndex": 1
        }
    ],
    "document": "<string>",
    "pageIndex": 0,
    "raw": "<string>",
    "parsed": "<string>",
    "isClientVerified": True,
    "dataPoint": "<string>",
    "field": "<string>",
    "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>"
                }
            ]
        }
    ]
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.patch(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'PATCH',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    rectangles: [{x0: 2.43, y0: 4.55, x1: 4.56, y1: 6.32, pageIndex: 1}],
    document: '<string>',
    pageIndex: 0,
    raw: '<string>',
    parsed: '<string>',
    isClientVerified: true,
    dataPoint: '<string>',
    field: '<string>',
    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>'
          }
        ]
      }
    ]
  })
};

fetch('https://{region}.affinda.com/v3/annotations/{id}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

{
  "id": 1,
  "rectangle": {
    "x0": 2.43,
    "y0": 4.55,
    "x1": 4.56,
    "y1": 6.32,
    "pageIndex": 1
  },
  "rectangles": [
    {
      "x0": 2.43,
      "y0": 4.55,
      "x1": 4.56,
      "y1": 6.32,
      "pageIndex": 1
    }
  ],
  "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>",
  "parent": 123
}

{
  "type": "validation_error",
  "errors": [
    {
      "attr": "non_field_errors",
      "code": "unique",
      "detail": "This index name has already been used"
    }
  ]
}

{
  "type": "validation_error",
  "errors": [
    {
      "attr": "non_field_errors",
      "code": "unique",
      "detail": "This index name has already been used"
    }
  ]
}

{
  "type": "validation_error",
  "errors": [
    {
      "attr": "non_field_errors",
      "code": "unique",
      "detail": "This index name has already been used"
    }
  ]
}

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

integer

required

Annotation's ID

Required range: x >= 1

Example:

1

Body

application/json

Annotation data to update

rectangles

object[]

x/y coordinates for the rectangles containing the data. An annotation can be contained within multiple rectangles.

Show child attributes

document

string

Unique identifier for the document

pageIndex

integer | null

The page number within the document, starting from 0.

Required range: x >= 0

Example:

0

raw

string | null

Raw data extracted from the before any post-processing

parsed

isClientVerified

boolean

Indicates whether the data has been validated by a human

dataPoint

string

Data point's identifier

field

string | null

Field's identifier

parent

integer | null

The parent annotation's ID

validationResults

(object | null)[]

The validation results created, changed or deleted as a result of updating the annotation.

Show child attributes

Response

object | null

Successfully updated annotation data.

integer

required

Annotation's ID

Required range: x >= 1

Example:

1

rectangle

object | null

required

x/y coordinates for the rectangular bounding box containing the data

Show child attributes

rectangles

object[]

required

x/y coordinates for the rectangles containing the data. An annotation can be contained within multiple rectangles.

Show child attributes

document

string

required

Unique identifier for the document

pageIndex

integer | null

required

The page number within the document, starting from 0.

Required range: x >= 0

Example:

0

raw

string | null

required

Raw data extracted from the before any post-processing

confidence

number | null

required

The overall confidence that the model's prediction is correct

Example:

0.86

classificationConfidence

number | null

required

The model's confidence that the text has been classified correctly

Example:

0.95

textExtractionConfidence

number | null

required

If the document was submitted as an image, this is the confidence that the text in the image has been correctly read by the model

Example:

0.9

isVerified

boolean

required

Indicates whether the data has been validated, either by a human using our validation tool or through auto-validation rules

isClientVerified

boolean

required

Indicates whether the data has been validated by a human

isAutoVerified

boolean

required

Indicates whether the data has been auto-validated

contentType

enum<string>

required

The different data types of annotations

Available options:

text,

integer,

float,

decimal,

date,

datetime,

daterange,

boolean,

enum,

location,

phonenumber,

json,

table,

expectedremuneration,

jobtitle,

language,

skill,

yearsexperience,

group,

table_deprecated,

url,

image,

docclf

dataPoint

string

Data point's identifier

field

string | null

Field's identifier

parent

integer | null

The parent annotation's ID

Delete an annotation Batch create annotations

⌘I

Developer Guide

Developer Tools

Endpoints

Deprecated Versions

Update an annotation

Authorizations

Path Parameters

Body

Response