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

The Document API - Splitting API from Affinda — 3 operation(s) for document api - splitting.

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

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

3 operations 3 paths 17 schemas 2 GET1 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 - Splitting 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 3

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

Document API - Splitting 3
GET
/v3/document_splittersdeprecated
Get list of all document splitters
getAllDocumentSplitters 4 params → 200400401default
GET
/v3/document_splitters/{identifier}deprecated
Get specific document splitter
getDocumentSplitter 1 param → 200400401default
POST
/v3/validate/{identifier}/splitdeprecated
Split pages of a document
editDocumentPages 1 param body → 200400401default

Schemas 17

The contract defines 17 schemas that model the data the API accepts and returns. The most detailed are Meta (19 properties), PageMeta (7 properties), DocumentSplitter (6 properties), RegionBias (4 properties). Each schema is shown below with its type and property counts.

RegionBias
object
4 properties
DocumentSplit
object
Describe a split of a document.
2 properties 1 required
Meta
object
19 properties
RequestError
object
2 properties 2 required
DocumentMeta_properties-identifier
string
Unique identifier for the document
DocumentSplitPage
object
List the pages within this split. Not including a page here will signal that the page should be deleted.
2 properties 1 required
DocumentSplitter_properties-identifier
string
Uniquely identify a document splitter.
DocumentEditRequest
object
1 property 1 required
DocumentSplitter
object
6 properties 6 required
Organization_properties-identifier
string
Uniquely identify an organization.
ExpiryTime
string
The date/time in ISO-8601 format when the document will be automatically deleted. Defaults to no expiry.
DocumentSplitterType
string
The different types of document splitters
FileName
string
Optional filename of the file
Meta_properties-identifier
string
Unique identifier for the document
PageMeta
object
7 properties 6 required
Extractor_properties-identifier
string
Uniquely identify an extractor.
DocumentEditResponse
array

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

affinda-document-api-splitting-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