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

Operations for uploading, listing, and managing documents in the Xceptor platform.

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

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

This API exposes 6 operations across 4 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.

6 operations 4 paths 6 schemas 1 DELETE3 GET2 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 Documents 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 6

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

Documents 6

Operations for uploading, listing, and managing documents in the Xceptor platform.

GET
/documents
Xceptor List documents
listDocuments 6 params → 200401
POST
/documents
Xceptor Upload a document
uploadDocument body → 201400401413
POST
/documents/batch
Xceptor Upload a batch of documents
uploadDocumentBatch body → 201400401
GET
/documents/{documentId}
Xceptor Get document details
getDocument 1 param → 200401404
DELETE
/documents/{documentId}
Xceptor Delete a document
deleteDocument 1 param → 204401404
GET
/documents/{documentId}/download
Xceptor Download original document
downloadDocument 1 param → 200401404

Schemas 6

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

BatchFileError
object
An error associated with a specific file in a batch upload
2 properties
Error
object
An error response from the Xceptor API
3 properties
Document
object
A document that has been uploaded to the Xceptor platform for intelligent data extraction and processing.
12 properties
DocumentList
object
A paginated list of documents
2 properties
Pagination
object
Pagination information for list responses
4 properties
BatchUploadResult
object
The result of a batch document upload operation
6 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

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