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 Document Types API

Manage document type definitions — the model configuration governing how a specific document category (invoice, resume, custom contract) is parsed. Each document type exposes a JSON Schema and optional Pydantic model representation. Document types are configured in the dashboard or natural-language workflow builder and reused across workspaces and collections.

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

Tagged areas include Document Processing, Document Types, Models, and Configuration. The published artifact set on APIs.io includes API documentation and an OpenAPI specification.

This API exposes 7 operations across 4 paths, and defines 6 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 6 schemas 1 DELETE4 GET1 PATCH1 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 Document Types 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, 4 GET, 1 PATCH, 1 POST. Each is listed below with its method, path, parameters, and response codes.

Document Types 7
GET
/v3/document_types
List document types
getDocumentTypes 2 params → 200400401default
POST
/v3/document_types
Create a document type
createDocumentType body → 201400401403default
GET
/v3/document_types/{identifier}
Get a document type
getDocumentType 1 param → 200401404default
PATCH
/v3/document_types/{identifier}
Update a document type
updateDocumentType 1 param body → 200400401403404default
DELETE
/v3/document_types/{identifier}
Delete a document type
deleteDocumentType 1 param → 204401403404default
GET
/v3/document_types/{identifier}/json_schema
Generate JSON schema from a document type
jsonSchemaFromDocumentType 2 params → 200400401default
GET
/v3/document_types/{identifier}/pydantic_models
Generate Pydantic models from a document type
pydanticModelsFromDocumentType 2 params → 200400401default

Schemas 6

The contract defines 6 schemas that model the data the API accepts and returns. The most detailed are DocumentType (5 properties), DocumentTypeCreate (3 properties), RequestError (2 properties), DocumentTypeUpdate (2 properties). Each schema is shown below with its type and property counts.

DocumentTypeUpdate
object
2 properties
RequestError
object
2 properties 2 required
DocumentTypeCreate
object
3 properties 2 required
DocumentType_properties-identifier
string
Uniquely identify a document type.
PydanticModelsResponse
object
1 property 1 required
DocumentType
object
5 properties 3 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

affinda-document-types-api-openapi.yml Raw ↑

Other APIs Affinda publishes across the network.

Affinda Documents API
Affinda Workspaces API
Affinda Organizations API
Affinda Data Sources API
Affinda Annotations 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