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

Conductor Workflow API

APIs for managing workflow executions

Conductor Workflow API is one of 6 APIs that Conductor publishes on the APIs.io network, described by a machine-readable OpenAPI specification and an AsyncAPI event-driven specification.

This API exposes 4 JSON Schema definitions.

Tagged areas include Workflows. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, an AsyncAPI specification, a JSON-LD context, and 4 JSON Schemas.

This API exposes 11 operations across 10 paths, and defines 9 schemas. It is described by OpenAPI 3.2.0, at version 3.x.

Requests are made against 2 base URLs: https://localhost:8080/api, https://play.orkes.io/api.

11 operations 10 paths 9 schemas 2 DELETE3 GET3 POST3 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
3.x
Servers
https://localhost:8080/api
https://play.orkes.io/api
License
Resource Areas
1

Paths & Operations 11

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

Workflow 11

APIs for managing workflow executions

POST
/workflow
Conductor Start a New Workflow
startWorkflow body → 200404
GET
/workflow/{workflowId}
Conductor Get Workflow Execution Status
getWorkflowExecution 2 params → 200404
DELETE
/workflow/{workflowId}
Conductor Delete a Workflow Execution
deleteWorkflowExecution 2 params → 204404
PUT
/workflow/{workflowId}/pause
Conductor Pause a Running Workflow
pauseWorkflow 1 param → 200404
PUT
/workflow/{workflowId}/resume
Conductor Resume a Paused Workflow
resumeWorkflow 1 param → 200404
POST
/workflow/{workflowId}/restart
Conductor Restart a Completed Workflow
restartWorkflow 2 params → 204404
POST
/workflow/{workflowId}/retry
Conductor Retry a Failed Workflow
retryWorkflow 2 params → 204404
DELETE
/workflow/{workflowId}/terminate
Conductor Terminate a Running Workflow
terminateWorkflow 2 params → 200404
PUT
/workflow/{workflowId}/skiptask/{taskReferenceName}
Conductor Skip a Task in a Running Workflow
skipTaskFromWorkflow 2 params body → 200404
GET
/workflow/search
Conductor Search for Workflow Executions
searchWorkflows 5 params → 200
GET
/workflow/running/{name}
Conductor Get Running Workflow Instances
getRunningWorkflows 4 params → 200

Schemas 9

The contract defines 9 schemas that model the data the API accepts and returns. The most detailed are Task (24 properties), Workflow (21 properties), WorkflowTask (17 properties), WorkflowDef (15 properties). Each schema is shown below with its type and property counts.

TaskExecLog
object
3 properties
Task
object
24 properties
SearchResultWorkflowSummary
object
2 properties
Workflow
object
21 properties
SkipTaskRequest
object
2 properties
WorkflowSummary
object
15 properties
StartWorkflowRequest
object
8 properties 1 required
WorkflowTask
object
17 properties 3 required
WorkflowDef
object
15 properties 2 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

conductor-workflow-api-openapi.yml Raw ↑

Other APIs Conductor publishes across the network.

Conductor Admin API
Conductor Event API
Conductor Metadata - Task API
Conductor Metadata - Workflow API
Conductor Task API
Where this information came from

This is an independent, third-party profile of Conductor 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.