Schema
SubWorkStreamStepDefinition
Sub-workstream step - invokes another workstream.
| Field | Type | Description |
|---|---|---|
idrequired | string | — |
namerequired | string | — |
type | string | — |
description | string | null | — |
depends_on | string | object[] | — |
stage | string | null | — |
timeout | string | null | — |
retry_policy | RetryPolicy | null | — |
error_handler | StepErrorHandler | null | — |
impact_level | "low" | "medium" | "high" | "critical" | Impact classification for steps.lowmediumhighcritical |
run_mode | "propose" | "auto_run" | Execution mode for steps.proposeauto_run |
requires_approval | boolean | — |
metadata | object | null | — |
examples | StepExample[] | null | Attached example files for this step. Each entry pairs a platform.file_uploads.file_id with a role + tags + notes so the runtime can shape its instruction. Bounded at 20 to keep a reasonable upper limit on the prompt preamble. |
tags | string[] | null | Categorical labels on the step itself (e.g. 'pdf-read', 'coutts', 'fy25'). Free-form; recommended tag set is documented per workstream surface. |
workstream_idrequired | string | ID of workstream to invoke |
inputs | object | null | Input mappings |
outputs | object | null | Output mappings |
wait | boolean | — |
on_complete | OnCompleteAction | null | — |
on_failure | BranchAction | null | — |