Orkes

Orkes Workflow Execution API

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

GitHub OpenAPI

Operations 8

POST /workflow Start a workflow #
GET /workflow/{workflowId} Get workflow execution #
DELETE /workflow/{workflowId} Terminate a workflow #
PUT /workflow/{workflowId}/pause Pause a workflow #
PUT /workflow/{workflowId}/resume Resume a workflow #
POST /workflow/{workflowId}/retry Retry a workflow #
POST /workflow/{workflowId}/restart Restart a workflow #
GET /workflow/search Search workflows #

Specifications

⚙
OpenAPI
https://artifacts.apis.io/orkes/openapi/orkes-workflow-execution-api-openapi.yml

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API 
curl "https://apis.io/api/v1/apis/orkes:orkes-workflow-execution-api"
All apis 
curl "https://apis.io/api/v1/apis?limit=25"

Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

orkes-workflow-execution-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: Orkes Conductor REST Workflow Execution API
  description: The Orkes Conductor REST API provides endpoints for managing workflows, tasks, human tasks, secrets, schedules, and other resources in the Orkes workflow orchestration platform built on Netflix Conductor.
  version: 2.0.0
  contact:
    name: Orkes
    url: https://orkes.io/
  license:
    name: Apache 2.0
    url: https://www.apache.org/licenses/LICENSE-2.0
servers:
- url: '{baseUrl}/api'
  description: Orkes Conductor Server
  variables:
    baseUrl:
      default: https://play.orkes.io
security:
- BearerAuth: []
tags:
- name: Workflow Execution
paths:
  /workflow:
    post:
      operationId: startWorkflow
      summary: Start a workflow
      description: Starts a new workflow execution.
      tags:
      - Workflow Execution
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/StartWorkflowRequest'
      responses:
        '200':
          description: Successful response
          content:
            text/plain:
              schema:
                type: string
  /workflow/{workflowId}:
    get:
      operationId: getWorkflowExecution
      summary: Get workflow execution
      description: Returns details of a workflow execution.
      tags:
      - Workflow Execution
      parameters:
      - name: workflowId
        in: path
        required: true
        schema:
          type: string
      - name: includeTasks
        in: query
        schema:
          type: boolean
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Workflow'
    delete:
      operationId: terminateWorkflow
      summary: Terminate a workflow
      description: Terminates a running workflow.
      tags:
      - Workflow Execution
      parameters:
      - name: workflowId
        in: path
        required: true
        schema:
          type: string
      - name: reason
        in: query
        schema:
          type: string
      responses:
        '200':
          description: Workflow terminated
  /workflow/{workflowId}/pause:
    put:
      operationId: pauseWorkflow
      summary: Pause a workflow
      description: Pauses a running workflow.
      tags:
      - Workflow Execution
      parameters:
      - name: workflowId
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Workflow paused
  /workflow/{workflowId}/resume:
    put:
      operationId: resumeWorkflow
      summary: Resume a workflow
      description: Resumes a paused workflow.
      tags:
      - Workflow Execution
      parameters:
      - name: workflowId
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Workflow resumed
  /workflow/{workflowId}/retry:
    post:
      operationId: retryWorkflow
      summary: Retry a workflow
      description: Retries a failed workflow from the last failed task.
      tags:
      - Workflow Execution
      parameters:
      - name: workflowId
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Workflow retried
  /workflow/{workflowId}/restart:
    post:
      operationId: restartWorkflow
      summary: Restart a workflow
      description: Restarts a completed workflow.
      tags:
      - Workflow Execution
      parameters:
      - name: workflowId
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Workflow restarted
  /workflow/search:
    get:
      operationId: searchWorkflows
      summary: Search workflows
      description: Search workflow executions.
      tags:
      - Workflow Execution
      parameters:
      - name: start
        in: query
        schema:
          type: integer
      - name: size
        in: query
        schema:
          type: integer
      - name: sort
        in: query
        schema:
          type: string
      - name: freeText
        in: query
        schema:
          type: string
      - name: query
        in: query
        schema:
          type: string
      responses:
        '200':
          description: Successful response
components:
  schemas:
    StartWorkflowRequest:
      type: object
      required:
      - name
      properties:
        name:
          type: string
        version:
          type: integer
        correlationId:
          type: string
        input:
          type: object
        taskToDomain:
          type: object
        priority:
          type: integer
    Workflow:
      type: object
      properties:
        workflowId:
          type: string
        workflowName:
          type: string
        workflowVersion:
          type: integer
        status:
          type: string
        input:
          type: object
        output:
          type: object
        tasks:
          type: array
          items:
            $ref: '#/components/schemas/Task'
        startTime:
          type: integer
          format: int64
        endTime:
          type: integer
          format: int64
    Task:
      type: object
      properties:
        taskId:
          type: string
        taskType:
          type: string
        status:
          type: string
        referenceTaskName:
          type: string
        workflowInstanceId:
          type: string
        inputData:
          type: object
        outputData:
          type: object
  securitySchemes:
    BearerAuth:
      type: http
      scheme: bearer