ReferenceAPI reference
Runs
7 operations in the Runs group.
GET /api/resources/{workspace}/workflow-runs
Operation ID: listWorkflowRuns
Parameters
| Name | In | Required | Type | Description |
|---|---|---|---|---|
workspace | path | yes | string |
Responses
| Status | Description | Schema |
|---|---|---|
| 200 | Run summaries. | — |
POST /api/resources/{workspace}/workflow-runs
Operation ID: createWorkflowRun
Parameters
| Name | In | Required | Type | Description |
|---|---|---|---|---|
workspace | path | yes | string |
Responses
| Status | Description | Schema |
|---|---|---|
| 201 | Created run. | — |
GET /api/resources/{workspace}/workflow-runs/{workflowRun}
Operation ID: getWorkflowRun
Parameters
| Name | In | Required | Type | Description |
|---|---|---|---|---|
workspace | path | yes | string | |
workflowRun | path | yes | string |
Responses
| Status | Description | Schema |
|---|---|---|
| 200 | Run detail. | WorkflowRunResponse |
GET /api/resources/{workspace}/workflow-runs/{workflowRun}/story
Operation ID: getWorkflowRunStory
Parameters
| Name | In | Required | Type | Description |
|---|---|---|---|---|
workspace | path | yes | string | |
workflowRun | path | yes | string |
Responses
| Status | Description | Schema |
|---|---|---|
| 200 | Redacted customer-facing run story projected from the workflow trace feed. | WorkflowRunStoryResponse |
GET /api/resources/{workspace}/workflow-runs/{workflowRun}/telemetry
Operation ID: getWorkflowRunTelemetry
Parameters
| Name | In | Required | Type | Description |
|---|---|---|---|---|
workspace | path | yes | string | |
workflowRun | path | yes | string |
Responses
| Status | Description | Schema |
|---|---|---|
| 200 | Frontend run telemetry projected from persisted run trace, gateway usage, and receipt ledgers. | WorkflowRunTelemetryResponse |
GET /api/resources/{workspace}/workflow-runs/{workflowRun}/trace-feed
Operation ID: getWorkflowRunTraceFeed
Parameters
| Name | In | Required | Type | Description |
|---|---|---|---|---|
workspace | path | yes | string | |
workflowRun | path | yes | string |
Responses
| Status | Description | Schema |
|---|---|---|
| 200 | Normalized run trace, audit, approval, and receipt timeline for UI run storytelling. | WorkflowRunTraceFeedResponse |
GET /api/resources/{workspace}/workflow-runs/{workflowRun}/trace-feed/export
Operation ID: exportWorkflowRunTraceFeed
Parameters
| Name | In | Required | Type | Description |
|---|---|---|---|---|
workspace | path | yes | string | |
workflowRun | path | yes | string |
Responses
| Status | Description | Schema |
|---|---|---|
| 200 | Redacted workflow run trace export bundle for support, audit, and incident review. | WorkflowRunTraceExportResponse |