js-bao-wss-client / StartWorkflowOptions
Interface: StartWorkflowOptions
Options for starting a workflow
Properties
contextDocId?
optionalcontextDocId?:string
Document ID to associate the run with
forceRerun?
optionalforceRerun?:boolean
If true, terminates any existing run with the same runKey and starts a new one
input?
optionalinput?:Record<string,any>
Input data to pass to the workflow. Defaults to {} if not provided.
meta?
optionalmeta?:Record<string,unknown>
User-defined metadata attached to the run (max 1KB). Returned in listRuns and getStatus.
runKey?
optionalrunKey?:string
Key to identify this run (for idempotency). Auto-generated if not provided.
workflowKey
workflowKey:
string
The workflow key identifying which workflow to start