How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

aPriori Workflow API

Workflows Controller

aPriori Workflow API is one of 2 APIs that aPriori 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, an API reference, authentication docs, and a changelog.

This API exposes 8 operations across 8 paths, and defines 4 schemas. It is described by OpenAPI 3.2.0, at version 4.0.2.

Requests are made against a single base URL, http://localhost:{port_number}.

8 operations 8 paths 4 schemas 6 GET2 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
4.0.2
Base URL
http://localhost/api
Authentication
API Key, API Key
Resource Areas
1

Authentication & Security 2

aPriori Workflow API declares 2 security schemes for authenticating requests. An API key is passed in the header as Authorization (JWTBearer). An API key is passed in the query as key (SharedSecret).

  • JWTBearer — Published by aPriori as security scheme "JWT Bearer" — type apiKey, name Authorization, in HEADER.
  • SharedSecret — Published by aPriori as security scheme "Shared Secret" — type apiKey, name key, in QUERY.

Paths & Operations 8

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

Workflow 8

Workflows Controller

GET
/api/workflows
Returns a list of all workflows
listWorkflows → 200400401403404415
GET
/api/workflows/{workflowIdentity}
Returns details to a given workflow
getWorkflow 1 param → 200400401403404415
POST
/api/workflows/{workflowIdentity}/{action}
Runs a workflow action
runWorkflowAction 2 params body → 200201400401403404415
GET
/api/workflows/{workflowIdentity}/jobs
Returns a list of jobs to a given workflow
listWorkflowJobs 1 param → 200400401403404415
GET
/api/workflows/{workflowIdentity}/jobs/{jobIdentity}
Returns details to a workflow job
getWorkflowJob 2 params → 200400401403404415
POST
/api/workflows/{workflowIdentity}/jobs/{jobIdentity}/{action}
Runs a job action
runWorkflowJobAction 3 params → 201202400401403404415
GET
/api/workflows/{workflowIdentity}/jobs/{jobIdentity}/results
Returns the results for all parts within a job
getJobResults 2 params → 200400401403404409415
GET
/api/workflows/{workflowIdentity}/jobs/{jobIdentity}/parts/{plmPartIdentity}/results
Returns the results for a part within a job
getPartResults 3 params → 200400401403404409415

Schemas 4

The contract defines 4 schemas that model the data the API accepts and returns. The most detailed are WorkflowJob (9 properties), Workflow (5 properties), WorkflowJobSummary (3 properties), WorkflowActionResult (2 properties). Each schema is shown below with its type and property counts.

WorkflowActionResult
object
2 properties
WorkflowJob
object
9 properties
WorkflowJobSummary
object
3 properties
Workflow
object
5 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

apriori-workflow-api-openapi.yml Raw ↑

Other APIs aPriori publishes across the network.

aPriori Agent API
Where this information came from

This is an independent, third-party profile of aPriori Workflow API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.