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

Xceptor Extraction API

Operations for triggering and monitoring document data extraction using Xceptor's AI-powered processing engine.

Xceptor Extraction API is one of 14 APIs that Xceptor publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Extraction. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and authentication docs.

This API exposes 2 operations across 1 path, and defines 6 schemas. It is described by OpenAPI 3.1.0, at version 1.0.

Requests are made against a single base URL, https://api.xceptor.com/v1.

2 operations 1 paths 6 schemas 1 GET1 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.1.0
API Version
1.0
Base URL
https://api.xceptor.com/v1
Authentication
HTTP Bearer
Terms of Service
Resource Areas
1

Authentication & Security 1

Xceptor Extraction API declares 1 security scheme for authenticating requests. It accepts HTTP bearer tokens (JWT) (bearerAuth). By default, every request must be authenticated.

  • bearerAuth — OAuth2 access token obtained via the client credentials flow. Include as a Bearer token in the Authorization header.

Paths & Operations 2

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

Extraction 2

Operations for triggering and monitoring document data extraction using Xceptor's AI-powered processing engine.

GET
/documents/{documentId}/extraction
Xceptor Get extraction results
getDocumentExtraction 1 param → 200401404
POST
/documents/{documentId}/extraction
Xceptor Trigger document extraction
triggerExtraction 1 param body → 202400401404

Schemas 6

The contract defines 6 schemas that model the data the API accepts and returns. The most detailed are Document (12 properties), ExtractionResult (9 properties), ExtractedField (7 properties), ExtractedTable (5 properties). Each schema is shown below with its type and property counts.

ExtractedTable
object
A table extracted from a document with its rows and column headers
5 properties
Error
object
An error response from the Xceptor API
3 properties
BoundingBox
object
The bounding box coordinates of an extracted element on the document page, in normalized coordinates (0.0 to 1.0).
4 properties
ExtractedField
object
A single field extracted from a document with its value and metadata
7 properties
Document
object
A document that has been uploaded to the Xceptor platform for intelligent data extraction and processing.
12 properties
ExtractionResult
object
The data extraction results for a processed document, including all extracted fields, tables, and their confidence scores.
9 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

xceptor-extraction-api-openapi.yml Raw ↑

Other APIs Xceptor publishes across the network.

Xceptor Workflow API
Xceptor Document Upload API
Xceptor Data Export API
Xceptor Connector API
Xceptor Authentication API
Xceptor Data Sources API
Xceptor Documents API
Xceptor Health API
Xceptor Jobs API
Xceptor Templates API
Xceptor Workflow Runs API
Xceptor Workflow Steps API