Skip to main content
POST
Execute Workflow
Executes a published workflow definition by creating a new orchestration run. The workflow’s DAG of steps is resolved and executed in dependency order. Each step’s inputs and outputs are recorded for full provenance tracking. Only workflows in published status can be executed. Use the Create Workflow endpoint to define workflows, then publish them through the workflow lifecycle API before execution.

Authentication

string
required
API key with workflows:execute scope. Alternatively, pass a Bearer JWT token in the Authorization header.
string
required
Tenant identifier for multi-tenant isolation.

Path Parameters

string
required
Workflow definition identifier.

Request

string
required
MAIP agent identifier that will execute the workflow.
object
Input data passed to the workflow’s first steps. Schema depends on the workflow definition.
object
Runtime parameter overrides for the workflow execution. These override default step configurations without modifying the workflow definition.

Response

string
Unique run identifier for this execution (maip-orch:ULID). Use this to query execution status via the Get Orchestration endpoint.
string
The executed workflow definition identifier.
string
Version of the workflow that was executed.
string
The agent executing the workflow.
string
Execution status. Always running on creation.
string
ISO 8601 timestamp when execution began.

Authorizations

X-API-Key
string
header
required

API key for machine-to-machine authentication

Path Parameters

workflowId
string<uuid>
required

Workflow identifier

Body

application/json
parameters
object

Runtime parameters for this execution

dry_run
boolean
default:false

If true, return the execution plan without running it

Response

Workflow execution started

execution_id
string<uuid>
workflow_id
string<uuid>
status
enum<string>
Available options:
pending,
running,
completed,
failed
steps
object[]
created_at
string<date-time>