/
OR
orkescloud
Search skmtc…
⌘K
Docs
Sign in
Docs
History
Schema
Generate
Filter operations
admin-resource
5
API Gateway
26
application-resource
15
audit-resource
3
authorization-resource
5
business-rule-resource
10
context-controller
1
environment-resource
7
event-execution-resource
2
event-message-resource
2
event-resource
16
global-schema-resource
2
group-resource
10
health-check-resource
1
human-task
14
human-task-resource
1
incoming-webhook-resource
2
integration-resource
26
limits-resource
1
LLM
3
metadata-resource
12
metrics-resource
1
org-config-resource
1
orkes-agent-controller
39
prompt-resource
14
provider-controller
1
queue-admin-resource
2
role-resource
9
scheduler-bulk-resource
2
scheduler-resource
18
schema-resource
6
secret-resource
13
service-registry-resource
15
sharing-resource
3
tags
11
task-resource
18
token-resource
2
user-form
6
user-form-template-resource
3
user-resource
6
version-resource
1
webhooks-config-resource
8
workflow-bulk-resource
6
workflow-resource
31
post
/api/workflow
Start a new workflow with StartWorkflowRequest, which allows task to be executed in a domain
post
/api/workflow/correlated/batch
Lists workflows for the given correlation id list and workflow name list
put
/api/workflow/decide/{workflowId}
Starts the decision task for a workflow
get
/api/workflow/execute/{name}
Execute a workflow synchronously with input and outputs using get api
post
/api/workflow/execute/{name}
Execute a workflow synchronously with input and outputs
post
/api/workflow/execute/{name}/{version}
Execute a workflow synchronously
get
/api/workflow/running/{name}
Retrieve all the running workflows
get
/api/workflow/search
Search for workflow executions based on payload and other parameters
post
/api/workflow/start/{name}/{version}
Start a new workflow asynchronously. Returns the ID of the workflow instance that can be later used for tracking
post
/api/workflow/test
Test workflow execution using mock data
post
/api/workflow/test/sync
Test workflow execution using mock data, blocking until the workflow completes or reaches the specified task
post
/api/workflow/{name}
Start a new workflow. Returns the ID of the workflow instance that can be later used for tracking
post
/api/workflow/{name}/correlated
Lists workflows for the given correlation id list
get
/api/workflow/{name}/correlated/{correlationId}
Lists workflows for the given correlation id
get
/api/workflow/{workflowId}
Gets the workflow by workflow (execution) id
delete
/api/workflow/{workflowId}
Terminate workflow execution
post
/api/workflow/{workflowId}/jump/{taskReferenceName}
Jump workflow execution to given task
put
/api/workflow/{workflowId}/pause
Pauses the workflow
delete
/api/workflow/{workflowId}/remove
Removes the workflow from the system
post
/api/workflow/{workflowId}/rerun
Reruns the workflow from a specific task
post
/api/workflow/{workflowId}/resetcallbacks
Resets callback times of all non-terminal SIMPLE tasks to 0
post
/api/workflow/{workflowId}/restart
Restarts a completed workflow
put
/api/workflow/{workflowId}/resume
Resumes the workflow
post
/api/workflow/{workflowId}/retry
Retries the last failed task
get
/api/workflow/{workflowId}/size
Gets the current serialized payload size of a workflow
put
/api/workflow/{workflowId}/skiptask/{taskReferenceName}
Skips a given task from a current running workflow
post
/api/workflow/{workflowId}/state
Update a workflow state by updating variables or in progress task
get
/api/workflow/{workflowId}/status
Gets the workflow by workflow (execution) id
get
/api/workflow/{workflowId}/tasks
Gets the workflow tasks by workflow (execution) id
post
/api/workflow/{workflowId}/upgrade
Upgrade running workflow to newer version
post
/api/workflow/{workflowId}/variables
Update workflow variables
workflow-resource
Copy
Copy Markdown
Copy Markdown
Copying…
Copied
Copy failed
Changes to Upgrade running workflow to newer version
post
/api/workflow/{workflowId}/upgrade
Oct 10, 2026
a142cbe9d486
Revision changes
breaking
the request's body type changed from no type to
object