workflow-resource

Start a new workflow with StartWorkflowRequest, which allows task to be executed in a domain

Changed on Oct 10, 2026

post/api/workflow

Request

Base URL
https://developer.orkescloud.com
Auth
API key in header X-Authorization
TypeScript
https://skmtc.dev/orkescloud/apis/orkes-conductor-api-server/docs/api/workflow/post.ts
A function with typed inputs. Its response is checked against the schema.

Query parameters

consistency'SYNCHRONOUS' | 'DURABLE' | 'REGION_DURABLE'

Request body

correlationIdstring

createdBystring

externalInputPayloadStoragePathstring

idempotencyKeystring

idempotencyStrategy'FAIL' | 'RETURN_EXISTING' | 'FAIL_ON_RUNNING'

inputobject

namestring required

priorityinteger

taskToDomainobject

versioninteger

Response

Changes

Oct 10, 2026a142cbe9d486 Revision changes
- breaking
  added the new required request property //////
- breaking
  the request's body type changed from no type to object
- breaking
  the / request property's minItems was increased to 1
- breaking
  the / request property's minLength was increased from 0 to 1
- breaking
  the /// request property's minLength was increased from 0 to 1
- breaking
  the //// request property's minLength was increased from 0 to 1
- breaking
  the /// request property's minLength was increased from 0 to 1
- breaking
  the request property type changed from no type to object
- breaking
  the / request property type changed from no type to object
- breaking
  the / request property type changed from no type to object
- breaking
  the / request property type changed from no type to object
- breaking
  the / request property type changed from no type to object
- breaking
  the // request property type changed from no type to object
- breaking
  the /// request property type changed from no type to object
- breaking
  the ///// request property type changed from no type to object
- breaking
  the /// request property type changed from no type to object
- breaking
  the /// request property type changed from no type to object
- breaking
  the //// request property type changed from no type to object
- breaking
  the //// request property type changed from no type to object
- warning
  the request property's max was set to 99.00
- warning
  the / request property's max was set to 2.00
- warning
  the request property's min was set to 0.00
- warning
  the / request property's min was set to 2.00
- warning
  the //// request property's min was set to 0.00
- warning
  the //// request property's min was set to 1.00
- warning
  the //// request property's min was set to 0.00
- warning
  the //// request property's min was set to 0.00
- warning
  the //// request property's min was set to 1.00
- warning
  the //// request property's min was set to 0.00
- warning
  the //// request property's min was set to 0.00
- info
  added the new optional request property //////
- info
  the request property / became optional
- info
  the request property /// became optional
- info
  the request property //// became optional
- info
  the request property /// became optional

Operation history