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

The Document API - Extractor API from Affinda — 2 operation(s) for document api - extractor.

Affinda Document API - Extractor 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 API - Extractor. The published artifact set on APIs.io includes an OpenAPI specification and API documentation.

This API exposes 5 operations across 2 paths, and defines 20 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.

5 operations 2 paths 20 schemas 1 DELETE2 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 API - Extractor 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 5

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

Document API - Extractor 5
GET
/v3/extractorsdeprecated
Get list of all extractors
getAllExtractors 4 params → 200400401default
POST
/v3/extractorsdeprecated
Create an extractor
createExtractor body → 201400401default
GET
/v3/extractors/{identifier}deprecated
Get specific extractor
getExtractor 1 param → 200400401default
PATCH
/v3/extractors/{identifier}deprecated
Update an extractor
updateExtractor 1 param body → 200400401default
DELETE
/v3/extractors/{identifier}deprecated
Delete an extractor
deleteExtractor 1 param → 204400401default

Schemas 20

The contract defines 20 schemas that model the data the API accepts and returns. The most detailed are FieldDeprecated (14 properties), Extractor (11 properties), Organization (8 properties), ExtractorCreate (7 properties). Each schema is shown below with its type and property counts.

ThemeConfig
object
4 properties
RequestError
object
2 properties 2 required
ExtractorUpdate
object
6 properties
FieldGroup
object
2 properties 2 required
FieldDeprecated
object
14 properties 3 required
AnnotationContentType
string
The different data types of annotations
createdDt
string
Organization_properties-identifier
string
Uniquely identify an organization.
Extractor
object
11 properties 4 required
category
string
fieldGroups
array
namePlural
string
OrganizationRole
string
name
string
validatable
boolean
Extractor_properties-identifier
string
Uniquely identify an extractor.
Organization
object
8 properties
ExtractorCreate
object
7 properties 2 required
PaletteColorOptions
object
4 properties 1 required
isCustom
boolean

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

affinda-document-api-extractor-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 Tags API
Affinda Usage API
Affinda Webhooks API
Affinda Search and Match API
Affinda Add x-hidden to endpoints API