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 Workflow Runs API

Operations for executing workflows, monitoring run status, and retrieving run history and output.

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

Tagged areas include Workflow Runs. 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 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.

4 operations 2 paths 6 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 Workflow Runs 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.

Workflow Runs 4

Operations for executing workflows, monitoring run status, and retrieving run history and output.

GET
/workflows/{workflowId}/runs
Xceptor List Workflow Runs
listWorkflowRuns 4 params → 200401404
POST
/workflows/{workflowId}/runs
Xceptor Execute Workflow
executeWorkflow 1 param body → 201400401404
GET
/workflows/{workflowId}/runs/{runId}
Xceptor Get Workflow Run Details
getWorkflowRun 2 params → 200401404
DELETE
/workflows/{workflowId}/runs/{runId}
Xceptor Cancel Workflow Run
cancelWorkflowRun 2 params → 200401404

Schemas 6

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

Pagination
object
Pagination information for list responses
4 properties
Error
object
An error response from the Xceptor API
3 properties
WorkflowRunList
object
A paginated list of workflow runs
2 properties
StepResult
object
The result of executing a single workflow step
8 properties
WorkflowRun
object
A single execution instance of a workflow. Tracks the progress and outcome of running a workflow's processing pipeline.
10 properties
WorkflowRunCreate
object
Request body for triggering a workflow execution
1 property

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

xceptor-workflow-runs-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 Steps API