Skip to content

Rulvar API reference


Rulvar API reference / @rulvar/core / Workflow

Interface: Workflow<A, R>

Defined in: packages/core/src/engine/ctx.ts:668

Closure-form workflow value; in-process only.

Type Parameters

Type ParameterDefault type
Aunknown
Runknown

Properties

PropertyModifierTypeDescriptionDefined in
argsSchema?readonlySchemaSpec<A>-packages/core/src/engine/ctx.ts:671
bodyreadonly(ctx, args) => Promise<R>-packages/core/src/engine/ctx.ts:685
effort?readonlyEffort-packages/core/src/engine/ctx.ts:684
errorPolicyreadonlyErrorPolicy-packages/core/src/engine/ctx.ts:672
kindreadonly"workflow"-packages/core/src/engine/ctx.ts:669
model?readonlyModelSpecWorkflow defaults: the third layer of the resolution chain, under the call override and the agent profile and over the engine defaults. A workflow that declares nothing contributes no layer and resolves exactly as it did before. The layer follows the CALL TREE, not the file: a child spawned through ctx.workflow contributes ITS OWN defaults inside its scope, so nesting a cheap workflow under an expensive one does the obvious thing.packages/core/src/engine/ctx.ts:682
namereadonlystring-packages/core/src/engine/ctx.ts:670
routing?readonlyPartial<Record<InvocationRole, ModelSpec>>-packages/core/src/engine/ctx.ts:683