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

Operations for creating, updating, listing, and deleting workflow definitions.

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

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

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

5 operations 2 paths 7 schemas 1 DELETE2 GET1 POST1 PUT

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 Workflows 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 5

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

Workflows 5

Operations for creating, updating, listing, and deleting workflow definitions.

GET
/workflows
Xceptor List Workflows
listWorkflows 5 params → 200401
POST
/workflows
Xceptor Create Workflow
createWorkflow body → 201400401
GET
/workflows/{workflowId}
Xceptor Get Workflow Details
getWorkflow 1 param → 200401404
PUT
/workflows/{workflowId}
Xceptor Update Workflow
updateWorkflow 1 param body → 200400401404
DELETE
/workflows/{workflowId}
Xceptor Delete Workflow
deleteWorkflow 1 param → 204401404

Schemas 7

The contract defines 7 schemas that model the data the API accepts and returns. The most detailed are Workflow (11 properties), WorkflowStep (6 properties), WorkflowUpdate (6 properties), WorkflowCreate (5 properties). Each schema is shown below with its type and property counts.

Error
object
An error response from the Xceptor API
3 properties
WorkflowUpdate
object
Request body for updating an existing workflow
6 properties
Workflow
object
A workflow definition that describes a multi-step data processing pipeline in the Xceptor platform.
11 properties
WorkflowList
object
A paginated list of workflows
2 properties
WorkflowCreate
object
Request body for creating a new workflow
5 properties 2 required
Pagination
object
Pagination information for list responses
4 properties
WorkflowStep
object
A single processing step within a workflow. Steps are executed in sequence and each performs a specific data processing operation.
6 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

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