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

Orkes Workflow Execution API

The Workflow Execution API from Orkes — 7 operation(s) for workflow execution.

Orkes Workflow Execution API is one of 8 APIs that Orkes publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Workflow Execution. The published artifact set on APIs.io includes an OpenAPI specification.

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

Requests are made against a single base URL, {baseUrl}/api.

8 operations 7 paths 3 schemas 1 DELETE2 GET3 POST2 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
2.0.0
Server
{baseUrl}/api
Authentication
HTTP Bearer
Contact
License
Resource Areas
1

Authentication & Security 1

Orkes Workflow Execution API declares 1 security scheme for authenticating requests. It accepts HTTP bearer tokens (BearerAuth). By default, every request must be authenticated.

Paths & Operations 8

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

Workflow Execution 8
POST
/workflow
Start a workflow
startWorkflow body → 200
GET
/workflow/{workflowId}
Get workflow execution
getWorkflowExecution 2 params → 200
DELETE
/workflow/{workflowId}
Terminate a workflow
terminateWorkflow 2 params → 200
PUT
/workflow/{workflowId}/pause
Pause a workflow
pauseWorkflow 1 param → 200
PUT
/workflow/{workflowId}/resume
Resume a workflow
resumeWorkflow 1 param → 200
POST
/workflow/{workflowId}/retry
Retry a workflow
retryWorkflow 1 param → 200
POST
/workflow/{workflowId}/restart
Restart a workflow
restartWorkflow 1 param → 200
GET
/workflow/search
Search workflows
searchWorkflows 5 params → 200

Schemas 3

The contract defines 3 schemas that model the data the API accepts and returns. The most detailed are Workflow (9 properties), Task (7 properties), StartWorkflowRequest (6 properties). Each schema is shown below with its type and property counts.

Workflow
object
9 properties
Task
object
7 properties
StartWorkflowRequest
object
6 properties 1 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

orkes-workflow-execution-api-openapi.yml Raw ↑

Other APIs Orkes publishes across the network.

Orkes Authentication API
Orkes Human Tasks API
Orkes Schedules API
Orkes Secrets API
Orkes Task Metadata API
Orkes Tasks API
Orkes Workflow Metadata API
Where this information came from

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