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 Tags API

Tag management for parsed documents. Tags can be arbitrarily attached to documents to support routing, segmentation, search filters, and downstream workflow triggers. Supports batch-add and batch-remove on document collections.

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

Tagged areas include Tags, Metadata, and Organization. The published artifact set on APIs.io includes API documentation and an OpenAPI specification.

This API exposes 7 operations across 4 paths, and defines 10 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.

7 operations 4 paths 10 schemas 1 DELETE2 GET1 PATCH3 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 Tags 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 7

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

Tags 7
GET
/v3/tags
Get list of all tags
getAllTags 4 params → 200400401default
POST
/v3/tags
Create a tag
createTag body → 201400401default
GET
/v3/tags/{id}
Get specific tag
getTag 1 param → 200400401default
PATCH
/v3/tags/{id}
Update a tag
updateTag 1 param body → 200400401default
DELETE
/v3/tags/{id}
Delete an tag
deleteTag 1 param → 204400401default
POST
/v3/documents/batch_add_tag
Add a tag to documents
batchAddTag body → 204400401default
POST
/v3/documents/batch_remove_tag
Remove a tag from documents
batchRemoveTag body → 204400401default

Schemas 10

The contract defines 10 schemas that model the data the API accepts and returns. The most detailed are Tag (4 properties), TagCreate (2 properties), TagUpdate (2 properties), BatchRemoveTagRequest (2 properties). Each schema is shown below with its type and property counts.

id
integer
Uniquely identify a tag.
TagUpdate
object
2 properties
TagCreate
object
2 properties 2 required
Tag
object
4 properties 4 required
BatchAddTagRequest
object
2 properties
RequestError
object
2 properties 2 required
DocumentMeta_properties-identifier
string
Unique identifier for the document
BatchRemoveTagRequest
object
2 properties
identifier
string
Uniquely identify a workspace.
name
string

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

affinda-tags-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 Annotations API
Affinda Validation Results API
Affinda Usage API
Affinda Webhooks API
Affinda Search and Match API
Affinda Add x-hidden to endpoints API
Affinda Deprecated End Points API