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

Operations for managing extraction templates that define the fields and tables to extract from specific document types.

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

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

This API exposes 2 operations across 2 paths, 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 2 paths 6 schemas 2 GET

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 Templates 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 2 paths, the API surfaces 2 operations — 2 GET. Each is listed below with its method, path, parameters, and response codes.

Templates 2

Operations for managing extraction templates that define the fields and tables to extract from specific document types.

GET
/templates
Xceptor List extraction templates
listTemplates 3 params → 200401
GET
/templates/{templateId}
Xceptor Get template details
getTemplate 1 param → 200401404

Schemas 6

The contract defines 6 schemas that model the data the API accepts and returns. The most detailed are Template (9 properties), FieldDefinition (4 properties), Pagination (4 properties), Error (3 properties). Each schema is shown below with its type and property counts.

TableDefinition
object
A table definition within an extraction template
2 properties
Pagination
object
Pagination information for list responses
4 properties
Template
object
An extraction template that defines the fields and tables to extract from a specific document type, along with validation rules and confidence thresholds.
9 properties
TemplateList
object
A paginated list of extraction templates
2 properties
Error
object
An error response from the Xceptor API
3 properties
FieldDefinition
object
A field definition within an extraction template
4 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

xceptor-templates-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 Extraction API
Xceptor Health API
Xceptor Jobs API
Xceptor Workflow Runs API
Xceptor Workflow Steps API