GEgetaxonflow
Workflows

Execute a workflow

Execute a defined workflow with input parameters

post/api/v1/workflows/execute

Request

Request body

inputobject

Response

Workflow execution result: every step ran, each decided by the organization's policy before it ran (#4382). The returned id is where a caller first observes the wfe_ prefix introduced in #3442, so an integration that matches run ids on wf_ breaks here rather than on a later GET.

Since v11.1.0 every step is decided on every deployment, and AXONFLOW_HITL_ENABLED is ignored. Before it, steps were decided only when that variable was true, and a run paused by an approval answered 200 with status: "paused" (or 202 when the approval could not be created). Neither pause exists any more: a step that requires an approval is withheld (403, approval_requires_durable_record). A plan run in confirm or step mode holds its steps durably.

idstring

In-process declarative workflow-engine run identifier. Since #3442 these carry the wfe_ prefix, not wf_: this engine runs a spec handed to it in the request body and appears in workflows, workflow_steps and execution_history nowhere at all, so it is a different thing from a governed control-plane workflow and no longer shares that workflow's prefix. No component derives meaning from a wfe_ id; the one place in the platform that parses id prefixes is the unified-executions resolver, which dispatches on wf_/wcp_/plan_, and a wfe_ id deliberately no longer matches any of them. A caller that stored one and matches on the wf_ prefix stops matching. Ids minted before v10.0.0 keep their old prefix; no row is rewritten.

workflow_namestring
status'pending' | 'running' | 'completed' | 'failed'
inputobject
start_timestring date-time

Earlier revisions of this spec named this field started_at; the wire has always been start_time. Same for end_time below, previously misdocumented as completed_at.

end_timestring date-time

Omitted while the run is still executing.

errorstring

Present only when the run failed.

outputobject

Example response

{
  "id": "wfe_1787399674_6t245pvn"
}

Changes

No recorded changes to this operation across all 1 revision of this API.