Workflow
Defined in: packages/core/src/workflow/types.ts:103
Type Parameters
Section titled “Type Parameters”TInput
Section titled “TInput”TInput
TOutput
Section titled “TOutput”TOutput
Properties
Section titled “Properties”
readonlyid:string
Defined in: packages/core/src/workflow/types.ts:104
Methods
Section titled “Methods”run(
input,options?):WorkflowRunHandle<TOutput>
Defined in: packages/core/src/workflow/types.ts:109
Start a workflow run. The bound runtime creates WorkflowContext internally.
Use workflowRunId on the handle to subscribe before result settles.
Parameters
Section titled “Parameters”TInput
options?
Section titled “options?”Returns
Section titled “Returns”WorkflowRunHandle<TOutput>
stream()
Section titled “stream()”stream(
input):WorkflowStreamHandle<TOutput>
Defined in: packages/core/src/workflow/types.ts:115
Start a run and expose live run events (steps, agents, lifecycle) for in-process consumers.
Persisted history still goes through WorkflowStore; production UI may use
run + SSE instead.
Parameters
Section titled “Parameters”TInput
Returns
Section titled “Returns”WorkflowStreamHandle<TOutput>