Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Affinda Annotations API

Manually create, update, and delete annotations on uploaded documents. Annotations are the field-level extraction objects (value, confidence, bounding box, parent field) and provide the surface for human-in-the-loop validation and review. Supports batch create, update, and delete for high-throughput review workflows.

Affinda Annotations API is one of 16 APIs that Affinda publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Annotations, Validation, and Human in the Loop. The published artifact set on APIs.io includes API documentation and an OpenAPI specification.

This API exposes 8 operations across 5 paths, and defines 29 schemas. It is described by OpenAPI 3.0.3, at version 3.0.0.

Requests are made against a single base URL, https://{region}.affinda.com.

8 operations 5 paths 29 schemas 1 DELETE2 GET1 PATCH4 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.3
API Version
3.0.0
Server
https://{region}.affinda.com
Authentication
HTTP Bearer
Resource Areas
1

Authentication & Security 1

Affinda Annotations API declares 1 security scheme for authenticating requests. It accepts HTTP bearer tokens (ApiKeyAuth). By default, every request must be authenticated.

  • ApiKeyAuth — Basic authentication using an API key, e.g. {Authorization: Bearer aff0bb4fbdf97b7e4111ff6c0015471094155f91}. You can find your API key within the Settings pag…

Paths & Operations 8

Across 5 paths, the API surfaces 8 operations — 1 DELETE, 2 GET, 1 PATCH, 4 POST. Each is listed below with its method, path, parameters, and response codes.

Annotations 8
GET
/v3/annotations
Get list of all annotations
getAllAnnotations 1 param → 200400401default
POST
/v3/annotations
Create a annotation
createAnnotation body → 201400401default
GET
/v3/annotations/{id}
Get specific annotation
getAnnotation 1 param → 200400401default
PATCH
/v3/annotations/{id}
Update an annotation
updateAnnotation 1 param body → 200400401default
DELETE
/v3/annotations/{id}
Delete an annotation
deleteAnnotation 1 param → 200400401default
POST
/v3/annotations/batch_create
Batch create annotations
batchCreateAnnotations body → 201400401default
POST
/v3/annotations/batch_update
Batch update annotations
batchUpdateAnnotations body → 200400401default
POST
/v3/annotations/batch_delete
Batch delete annotations
batchDeleteAnnotations body → 200400401default

Schemas 29

The contract defines 29 schemas that model the data the API accepts and returns. The most detailed are Annotation (16 properties), AnnotationCreate (10 properties), AnnotationBatchUpdate (10 properties), AnnotationUpdate (10 properties). Each schema is shown below with its type and property counts.

Annotation
object
16 properties 13 required
field
string
Field's identifier
BatchDeleteAnnotationsResponse
object
1 property
AnnotationWithValidationResults
object
pageIndex
integer
The page number within the document, starting from 0.
BatchCreateAnnotationsResponse
array
RequestError
object
2 properties 2 required
DocumentMeta_properties-identifier
string
Unique identifier for the document
Rectangle
object
5 properties 4 required
isClientVerified
boolean
Indicates whether the data has been validated by a human
AnnotationContentType
string
The different data types of annotations
rectangles
array
x/y coordinates for the rectangles containing the data. An annotation can be contained within multiple rectangles.
PaginatedResponse
object
3 properties 1 required
ValidationResult
object
Validation result arising from a ValidationRule
6 properties 6 required
BatchCreateAnnotationsRequest
array
ChangedValidationResults
object
3 properties
BatchUpdateAnnotationsRequest
array
AnnotationUpdate
object
10 properties
AnnotationBatchUpdate
object
10 properties 1 required
dataPoint
string
Data point's identifier
BatchDeleteAnnotationsRequest
array
Array of annotation IDs to be deleted
BatchUpdateAnnotationsResponse
array
validationResults
array
The validation results created, changed or deleted as a result of updating the annotation.
parent
integer
The parent annotation's ID
AnotationDelete
object
1 property
parsed
AnnotationCreate
object
10 properties 2 required
raw
string
Raw data extracted from the before any post-processing
Annotation_properties-id
integer
Annotation's ID

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

affinda-annotations-api-openapi.yml Raw ↑

Other APIs Affinda publishes across the network.

Affinda Documents API
Affinda Document Types API
Affinda Workspaces API
Affinda Organizations API
Affinda Data Sources API
Affinda Validation Results API
Affinda Tags API
Affinda Usage API
Affinda Webhooks API
Affinda Search and Match API
Affinda Add x-hidden to endpoints API
Affinda Deprecated End Points API