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

Operations for creating, monitoring, and managing data processing jobs that execute within the Xceptor platform.

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

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

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

4 operations 2 paths 5 schemas 1 DELETE2 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 Jobs 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 4

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

Jobs 4

Operations for creating, monitoring, and managing data processing jobs that execute within the Xceptor platform.

GET
/jobs
Xceptor List Processing Jobs
listJobs 6 params → 200401
POST
/jobs
Xceptor Create Processing Job
createJob body → 201400401
GET
/jobs/{jobId}
Xceptor Get Job Details
getJob 1 param → 200401404
DELETE
/jobs/{jobId}
Xceptor Cancel Processing Job
cancelJob 1 param → 200401404

Schemas 5

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

Job
object
A data processing job that executes on the Xceptor platform. Jobs represent units of work such as document ingestion, data extraction, transformation, or expor…
9 properties
JobCreate
object
Request body for creating a new processing job
5 properties 1 required
Error
object
An error response from the Xceptor API
3 properties
JobList
object
A paginated list of processing jobs
2 properties
Pagination
object
Pagination information for list responses
4 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

xceptor-jobs-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 Templates API
Xceptor Workflow Runs API
Xceptor Workflow Steps API