Interface WorkflowInstance<TInput>

Workflow instance returned by AgentWorkflow.create().

interface WorkflowInstance<TInput = unknown> {
    inspect(): WorkflowInspection;
    resume(runArtifactId: string): Promise<WorkflowResult<TInput>>;
    run(options: WorkflowRunOptions<TInput>): Promise<WorkflowResult<TInput>>;
}

Type Parameters

TInput = unknown

Index

Methods

inspect resume run

Methods

inspect

inspect(): WorkflowInspection
Returns WorkflowInspection
- Defined in src/agent/workflow/types.ts:154

resume

resume(runArtifactId: string): Promise<WorkflowResult<TInput>>
Resume a previously failed workflow run from the first incomplete step. Requires workspace.store so the previous WorkflowRun artifact can be loaded.
Parameters
- runArtifactId: string
Returns Promise<WorkflowResult<TInput>>
- Defined in src/agent/workflow/types.ts:159

run

run(options: WorkflowRunOptions<TInput>): Promise<WorkflowResult<TInput>>
Parameters
- options: WorkflowRunOptions<TInput>
Returns Promise<WorkflowResult<TInput>>
- Defined in src/agent/workflow/types.ts:153