Welcome to the new Affinda Docs – explore the Academy, browse guides, or ask the AI assistant any questions you have!
curl --request POST \
--url https://{region}.affinda.com/v3/annotations/batch_update \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '[
{
"id": 1,
"rectangles": [
{
"pageIndex": 1,
"x0": 2.43,
"y0": 4.55,
"x1": 4.56,
"y1": 6.32
}
],
"document": "<string>",
"pageIndex": 0,
"raw": "<string>",
"parsed": "<string>",
"isClientVerified": true,
"dataPoint": "<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>"
}
]
}
]
}
]'
[
{
"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
}
]
Batch update annotations
curl --request POST \
--url https://{region}.affinda.com/v3/annotations/batch_update \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '[
{
"id": 1,
"rectangles": [
{
"pageIndex": 1,
"x0": 2.43,
"y0": 4.55,
"x1": 4.56,
"y1": 6.32
}
],
"document": "<string>",
"pageIndex": 0,
"raw": "<string>",
"parsed": "<string>",
"isClientVerified": true,
"dataPoint": "<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>"
}
]
}
]
}
]'
[
{
"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
}
]
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.
The body is of type object[]
.
Successfully updated annotations.