ReferenceAPI reference
Workflow Runs
27 operations in the Workflow Runs group.
26 of 27 operations on this page are generated contract stubs: the routes are real, the schemas are placeholders pending the owning subsystem's contract pass.
POST /api/resources/{workspace}/workflow-runs/preflight
Operation ID: preflightWorkflowRun
Parameters
| Name | In | Required | Type | Description |
|---|---|---|---|---|
workspace | path | yes | string |
Request body — application/json · WorkflowRunPreflightRequest
| Field | Type | Required |
|---|---|---|
workflow_definition_id | `string | integer |
workflow_version_id | `string | integer |
workflow_route_id | `string | integer |
workflow_route_version_id | `string | integer |
workflow_execution_profile_id | `string | integer |
workflow_execution_profile_version_id | `string | integer |
integration_event_id | `string | integer |
runtime_target_id | `string | integer |
managed_executor_id | `string | integer |
workflow_digest | `string | null` |
yaml_snapshot | `string | null` |
status | enum(queued, draft, blocked) | no |
data_capture_policy | `object | null` |
Responses
| Status | Description | Schema |
|---|---|---|
| 200 | Validates a first-run workflow request without creating a workflow run. | WorkflowRunPreflightResponse |
| 422 | Returns runnable-readiness issues without creating a workflow run. | WorkflowRunPreflightResponse |
GET /api/workflow-runs
Generated contract stub — the route is real and served, but its request/response schema has not been hand-tightened yet.
Operation ID: getApiWorkflowRuns
Responses
| Status | Description | Schema |
|---|---|---|
| 200 | Successful response | GenericApiResponse |
| 401 | Authentication is required | ErrorEnvelope |
| 403 | Permission denied | ErrorEnvelope |
| 422 | Validation failed | ErrorEnvelope |
| 500 | Server error | ErrorEnvelope |
POST /api/workflow-runs
Generated contract stub — the route is real and served, but its request/response schema has not been hand-tightened yet.
Operation ID: postApiWorkflowRuns
Request body — application/json · object
Responses
| Status | Description | Schema |
|---|---|---|
| 200 | Successful response | GenericApiResponse |
| 201 | Successful response | GenericApiResponse |
| 401 | Authentication is required | ErrorEnvelope |
| 403 | Permission denied | ErrorEnvelope |
| 422 | Validation failed | ErrorEnvelope |
| 500 | Server error | ErrorEnvelope |
GET /api/workflow-runs/{workflowRun}
Generated contract stub — the route is real and served, but its request/response schema has not been hand-tightened yet.
Operation ID: getApiWorkflowRunsWorkflowRun
Parameters
| Name | In | Required | Type | Description |
|---|---|---|---|---|
workflowRun | path | yes | string |
Responses
| Status | Description | Schema |
|---|---|---|
| 200 | Successful response | GenericApiResponse |
| 401 | Authentication is required | ErrorEnvelope |
| 403 | Permission denied | ErrorEnvelope |
| 422 | Validation failed | ErrorEnvelope |
| 500 | Server error | ErrorEnvelope |
PATCH /api/workflow-runs/{workflowRun}
Generated contract stub — the route is real and served, but its request/response schema has not been hand-tightened yet.
Operation ID: patchApiWorkflowRunsWorkflowRun
Parameters
| Name | In | Required | Type | Description |
|---|---|---|---|---|
workflowRun | path | yes | string |
Request body — application/json · object
Responses
| Status | Description | Schema |
|---|---|---|
| 200 | Successful response | GenericApiResponse |
| 401 | Authentication is required | ErrorEnvelope |
| 403 | Permission denied | ErrorEnvelope |
| 422 | Validation failed | ErrorEnvelope |
| 500 | Server error | ErrorEnvelope |
POST /api/workflow-runs/{workflowRun}/action-proposals/{proposalKey}/decision
Generated contract stub — the route is real and served, but its request/response schema has not been hand-tightened yet.
Operation ID: postApiWorkflowRunsWorkflowRunActionProposalsProposalKeyDecision
Parameters
| Name | In | Required | Type | Description |
|---|---|---|---|---|
workflowRun | path | yes | string | |
proposalKey | path | yes | string |
Request body — application/json · object
Responses
| Status | Description | Schema |
|---|---|---|
| 200 | Successful response | GenericApiResponse |
| 201 | Successful response | GenericApiResponse |
| 401 | Authentication is required | ErrorEnvelope |
| 403 | Permission denied | ErrorEnvelope |
| 422 | Validation failed | ErrorEnvelope |
| 500 | Server error | ErrorEnvelope |
POST /api/workflow-runs/{workflowRun}/action-proposals/{proposalKey}/execute
Generated contract stub — the route is real and served, but its request/response schema has not been hand-tightened yet.
Operation ID: postApiWorkflowRunsWorkflowRunActionProposalsProposalKeyExecute
Parameters
| Name | In | Required | Type | Description |
|---|---|---|---|---|
workflowRun | path | yes | string | |
proposalKey | path | yes | string |
Request body — application/json · object
Responses
| Status | Description | Schema |
|---|---|---|
| 200 | Successful response | GenericApiResponse |
| 201 | Successful response | GenericApiResponse |
| 401 | Authentication is required | ErrorEnvelope |
| 403 | Permission denied | ErrorEnvelope |
| 422 | Validation failed | ErrorEnvelope |
| 500 | Server error | ErrorEnvelope |
POST /api/workflow-runs/{workflowRun}/approvals/{nodeKey}
Generated contract stub — the route is real and served, but its request/response schema has not been hand-tightened yet.
Operation ID: postApiWorkflowRunsWorkflowRunApprovalsNodeKey
Parameters
| Name | In | Required | Type | Description |
|---|---|---|---|---|
workflowRun | path | yes | string | |
nodeKey | path | yes | string |
Request body — application/json · object
Responses
| Status | Description | Schema |
|---|---|---|
| 200 | Successful response | GenericApiResponse |
| 201 | Successful response | GenericApiResponse |
| 401 | Authentication is required | ErrorEnvelope |
| 403 | Permission denied | ErrorEnvelope |
| 422 | Validation failed | ErrorEnvelope |
| 500 | Server error | ErrorEnvelope |
GET /api/workflow-runs/{workflowRun}/audit-packet
Generated contract stub — the route is real and served, but its request/response schema has not been hand-tightened yet.
Operation ID: getApiWorkflowRunsWorkflowRunAuditPacket
Parameters
| Name | In | Required | Type | Description |
|---|---|---|---|---|
workflowRun | path | yes | string |
Responses
| Status | Description | Schema |
|---|---|---|
| 200 | Successful response | GenericApiResponse |
| 401 | Authentication is required | ErrorEnvelope |
| 403 | Permission denied | ErrorEnvelope |
| 422 | Validation failed | ErrorEnvelope |
| 500 | Server error | ErrorEnvelope |
POST /api/workflow-runs/{workflowRun}/cancel
Generated contract stub — the route is real and served, but its request/response schema has not been hand-tightened yet.
Operation ID: postApiWorkflowRunsWorkflowRunCancel
Parameters
| Name | In | Required | Type | Description |
|---|---|---|---|---|
workflowRun | path | yes | string |
Request body — application/json · object
Responses
| Status | Description | Schema |
|---|---|---|
| 200 | Successful response | GenericApiResponse |
| 201 | Successful response | GenericApiResponse |
| 401 | Authentication is required | ErrorEnvelope |
| 403 | Permission denied | ErrorEnvelope |
| 422 | Validation failed | ErrorEnvelope |
| 500 | Server error | ErrorEnvelope |
GET /api/workflow-runs/{workflowRun}/contract-health
Generated contract stub — the route is real and served, but its request/response schema has not been hand-tightened yet.
Operation ID: getApiWorkflowRunsWorkflowRunContractHealth
Parameters
| Name | In | Required | Type | Description |
|---|---|---|---|---|
workflowRun | path | yes | string |
Responses
| Status | Description | Schema |
|---|---|---|
| 200 | Successful response | GenericApiResponse |
| 401 | Authentication is required | ErrorEnvelope |
| 403 | Permission denied | ErrorEnvelope |
| 422 | Validation failed | ErrorEnvelope |
| 500 | Server error | ErrorEnvelope |
POST /api/workflow-runs/{workflowRun}/events
Generated contract stub — the route is real and served, but its request/response schema has not been hand-tightened yet.
Operation ID: postApiWorkflowRunsWorkflowRunEvents
Parameters
| Name | In | Required | Type | Description |
|---|---|---|---|---|
workflowRun | path | yes | string |
Request body — application/json · object
Responses
| Status | Description | Schema |
|---|---|---|
| 200 | Successful response | GenericApiResponse |
| 201 | Successful response | GenericApiResponse |
| 401 | Authentication is required | ErrorEnvelope |
| 403 | Permission denied | ErrorEnvelope |
| 422 | Validation failed | ErrorEnvelope |
| 500 | Server error | ErrorEnvelope |
POST /api/workflow-runs/{workflowRun}/execution-receipts/{executionReceipt}/verify
Generated contract stub — the route is real and served, but its request/response schema has not been hand-tightened yet.
Operation ID: postApiWorkflowRunsWorkflowRunExecutionReceiptsExecutionReceiptVerify
Parameters
| Name | In | Required | Type | Description |
|---|---|---|---|---|
workflowRun | path | yes | string | |
executionReceipt | path | yes | string |
Request body — application/json · object
Responses
| Status | Description | Schema |
|---|---|---|
| 200 | Successful response | GenericApiResponse |
| 201 | Successful response | GenericApiResponse |
| 401 | Authentication is required | ErrorEnvelope |
| 403 | Permission denied | ErrorEnvelope |
| 422 | Validation failed | ErrorEnvelope |
| 500 | Server error | ErrorEnvelope |
GET /api/workflow-runs/{workflowRun}/gates
Generated contract stub — the route is real and served, but its request/response schema has not been hand-tightened yet.
Operation ID: getApiWorkflowRunsWorkflowRunGates
Parameters
| Name | In | Required | Type | Description |
|---|---|---|---|---|
workflowRun | path | yes | string |
Responses
| Status | Description | Schema |
|---|---|---|
| 200 | Successful response | GenericApiResponse |
| 401 | Authentication is required | ErrorEnvelope |
| 403 | Permission denied | ErrorEnvelope |
| 422 | Validation failed | ErrorEnvelope |
| 500 | Server error | ErrorEnvelope |
POST /api/workflow-runs/{workflowRun}/nodes/{node}/context/proposals
Generated contract stub — the route is real and served, but its request/response schema has not been hand-tightened yet.
Operation ID: postApiWorkflowRunsWorkflowRunNodesNodeContextProposals
Parameters
| Name | In | Required | Type | Description |
|---|---|---|---|---|
workflowRun | path | yes | string | |
node | path | yes | string |
Request body — application/json · object
Responses
| Status | Description | Schema |
|---|---|---|
| 200 | Successful response | GenericApiResponse |
| 201 | Successful response | GenericApiResponse |
| 401 | Authentication is required | ErrorEnvelope |
| 403 | Permission denied | ErrorEnvelope |
| 422 | Validation failed | ErrorEnvelope |
| 500 | Server error | ErrorEnvelope |
POST /api/workflow-runs/{workflowRun}/nodes/{node}/context/receipts
Generated contract stub — the route is real and served, but its request/response schema has not been hand-tightened yet.
Operation ID: postApiWorkflowRunsWorkflowRunNodesNodeContextReceipts
Parameters
| Name | In | Required | Type | Description |
|---|---|---|---|---|
workflowRun | path | yes | string | |
node | path | yes | string |
Request body — application/json · object
Responses
| Status | Description | Schema |
|---|---|---|
| 200 | Successful response | GenericApiResponse |
| 201 | Successful response | GenericApiResponse |
| 401 | Authentication is required | ErrorEnvelope |
| 403 | Permission denied | ErrorEnvelope |
| 422 | Validation failed | ErrorEnvelope |
| 500 | Server error | ErrorEnvelope |
POST /api/workflow-runs/{workflowRun}/nodes/{node}/context/resolve
Generated contract stub — the route is real and served, but its request/response schema has not been hand-tightened yet.
Operation ID: postApiWorkflowRunsWorkflowRunNodesNodeContextResolve
Parameters
| Name | In | Required | Type | Description |
|---|---|---|---|---|
workflowRun | path | yes | string | |
node | path | yes | string |
Request body — application/json · object
Responses
| Status | Description | Schema |
|---|---|---|
| 200 | Successful response | GenericApiResponse |
| 201 | Successful response | GenericApiResponse |
| 401 | Authentication is required | ErrorEnvelope |
| 403 | Permission denied | ErrorEnvelope |
| 422 | Validation failed | ErrorEnvelope |
| 500 | Server error | ErrorEnvelope |
GET /api/workflow-runs/{workflowRun}/policy-simulation
Generated contract stub — the route is real and served, but its request/response schema has not been hand-tightened yet.
Operation ID: getApiWorkflowRunsWorkflowRunPolicySimulation
Parameters
| Name | In | Required | Type | Description |
|---|---|---|---|---|
workflowRun | path | yes | string |
Responses
| Status | Description | Schema |
|---|---|---|
| 200 | Successful response | GenericApiResponse |
| 401 | Authentication is required | ErrorEnvelope |
| 403 | Permission denied | ErrorEnvelope |
| 422 | Validation failed | ErrorEnvelope |
| 500 | Server error | ErrorEnvelope |
GET /api/workflow-runs/{workflowRun}/replay
Generated contract stub — the route is real and served, but its request/response schema has not been hand-tightened yet.
Operation ID: getApiWorkflowRunsWorkflowRunReplay
Parameters
| Name | In | Required | Type | Description |
|---|---|---|---|---|
workflowRun | path | yes | string |
Responses
| Status | Description | Schema |
|---|---|---|
| 200 | Successful response | GenericApiResponse |
| 401 | Authentication is required | ErrorEnvelope |
| 403 | Permission denied | ErrorEnvelope |
| 422 | Validation failed | ErrorEnvelope |
| 500 | Server error | ErrorEnvelope |
POST /api/workflow-runs/{workflowRun}/rerun
Generated contract stub — the route is real and served, but its request/response schema has not been hand-tightened yet.
Operation ID: postApiWorkflowRunsWorkflowRunRerun
Parameters
| Name | In | Required | Type | Description |
|---|---|---|---|---|
workflowRun | path | yes | string |
Request body — application/json · object
Responses
| Status | Description | Schema |
|---|---|---|
| 200 | Successful response | GenericApiResponse |
| 201 | Successful response | GenericApiResponse |
| 401 | Authentication is required | ErrorEnvelope |
| 403 | Permission denied | ErrorEnvelope |
| 422 | Validation failed | ErrorEnvelope |
| 500 | Server error | ErrorEnvelope |
GET /api/workflow-runs/{workflowRun}/story
Generated contract stub — the route is real and served, but its request/response schema has not been hand-tightened yet.
Operation ID: getApiWorkflowRunsWorkflowRunStory
Parameters
| Name | In | Required | Type | Description |
|---|---|---|---|---|
workflowRun | path | yes | string |
Responses
| Status | Description | Schema |
|---|---|---|
| 200 | Successful response | GenericApiResponse |
| 401 | Authentication is required | ErrorEnvelope |
| 403 | Permission denied | ErrorEnvelope |
| 422 | Validation failed | ErrorEnvelope |
| 500 | Server error | ErrorEnvelope |
GET /api/workflow-runs/{workflowRun}/telemetry
Generated contract stub — the route is real and served, but its request/response schema has not been hand-tightened yet.
Operation ID: getApiWorkflowRunsWorkflowRunTelemetry
Parameters
| Name | In | Required | Type | Description |
|---|---|---|---|---|
workflowRun | path | yes | string |
Responses
| Status | Description | Schema |
|---|---|---|
| 200 | Successful response | GenericApiResponse |
| 401 | Authentication is required | ErrorEnvelope |
| 403 | Permission denied | ErrorEnvelope |
| 422 | Validation failed | ErrorEnvelope |
| 500 | Server error | ErrorEnvelope |
GET /api/workflow-runs/{workflowRun}/trace-feed
Generated contract stub — the route is real and served, but its request/response schema has not been hand-tightened yet.
Operation ID: getApiWorkflowRunsWorkflowRunTraceFeed
Parameters
| Name | In | Required | Type | Description |
|---|---|---|---|---|
workflowRun | path | yes | string |
Responses
| Status | Description | Schema |
|---|---|---|
| 200 | Successful response | GenericApiResponse |
| 401 | Authentication is required | ErrorEnvelope |
| 403 | Permission denied | ErrorEnvelope |
| 422 | Validation failed | ErrorEnvelope |
| 500 | Server error | ErrorEnvelope |
GET /api/workflow-runs/{workflowRun}/trace-feed/export
Generated contract stub — the route is real and served, but its request/response schema has not been hand-tightened yet.
Operation ID: getApiWorkflowRunsWorkflowRunTraceFeedExport
Parameters
| Name | In | Required | Type | Description |
|---|---|---|---|---|
workflowRun | path | yes | string |
Responses
| Status | Description | Schema |
|---|---|---|
| 200 | Successful response | GenericApiResponse |
| 401 | Authentication is required | ErrorEnvelope |
| 403 | Permission denied | ErrorEnvelope |
| 422 | Validation failed | ErrorEnvelope |
| 500 | Server error | ErrorEnvelope |
POST /api/workflow-runs/{workflowRun}/verify-contract-health
Generated contract stub — the route is real and served, but its request/response schema has not been hand-tightened yet.
Operation ID: postApiWorkflowRunsWorkflowRunVerifyContractHealth
Parameters
| Name | In | Required | Type | Description |
|---|---|---|---|---|
workflowRun | path | yes | string |
Request body — application/json · object
Responses
| Status | Description | Schema |
|---|---|---|
| 200 | Successful response | GenericApiResponse |
| 201 | Successful response | GenericApiResponse |
| 401 | Authentication is required | ErrorEnvelope |
| 403 | Permission denied | ErrorEnvelope |
| 422 | Validation failed | ErrorEnvelope |
| 500 | Server error | ErrorEnvelope |
POST /api/workflow-runs/preflight
Generated contract stub — the route is real and served, but its request/response schema has not been hand-tightened yet.
Operation ID: postApiWorkflowRunsPreflight
Request body — application/json · object
Responses
| Status | Description | Schema |
|---|---|---|
| 200 | Successful response | GenericApiResponse |
| 201 | Successful response | GenericApiResponse |
| 401 | Authentication is required | ErrorEnvelope |
| 403 | Permission denied | ErrorEnvelope |
| 422 | Validation failed | ErrorEnvelope |
| 500 | Server error | ErrorEnvelope |
GET /api/workflow-runs/replay
Generated contract stub — the route is real and served, but its request/response schema has not been hand-tightened yet.
Operation ID: getApiWorkflowRunsReplay
Responses
| Status | Description | Schema |
|---|---|---|
| 200 | Successful response | GenericApiResponse |
| 401 | Authentication is required | ErrorEnvelope |
| 403 | Permission denied | ErrorEnvelope |
| 422 | Validation failed | ErrorEnvelope |
| 500 | Server error | ErrorEnvelope |