Member Junction
    Preparing search index...

    Interface FlowAgentExecuteParams

    Flow Agent-specific execution parameters.

    These parameters allow callers to customize how a Flow Agent executes, including starting at a specific step or skipping certain steps. Use with ExecuteAgentParams.agentTypeParams for type-safe configuration.

    import { FlowAgentExecuteParams } from '@memberjunction/ai-agents';

    // Get the step to start at
    const approvalStep = AIEngine.Instance.GetAgentSteps(agentId)
      .find(s => s.Name === 'Approval Review');

    const params: ExecuteAgentParams<any, any, FlowAgentExecuteParams> = {
      agent: myFlowAgent,
      conversationMessages: messages,
      agentTypeParams: {
        startAtStep: approvalStep,  // Skip initial steps, start here
      }
    };

    2.127.0

    interface FlowAgentExecuteParams {
        executionMode?: FlowExecutionMode;
        skipSteps?: MJAIAgentStepEntity[];
        startAtStep?: MJAIAgentStepEntity;
    }
    Index

    Properties

    executionMode? skipSteps? startAtStep?

    Properties

    executionMode?: FlowExecutionMode

    Where the flow's steps execute. See FlowExecutionMode.

    Set 'inRun' when the caller needs the flow's result in the same request, for example an API handler that returns the final payload to its client. A dispatched run returns as soon as its steps are scheduled, so such a caller would otherwise continue before any work had happened.

    When omitted, a sub-agent run (one with parentRun) executes 'inRun', because its parent consumes the result, and a top-level run executes 'dispatch'. Setting 'dispatch' on a sub-agent run is refused for the same reason.

    6.1.3

    skipSteps?: MJAIAgentStepEntity[]

    Steps to skip during execution.

    When the flow would normally execute one of these steps, it will instead immediately evaluate the step's outgoing paths and continue to the next valid step. This is useful for:

    • Bypassing steps that have already been completed externally
    • Testing flows without certain side effects
    • Conditional step execution based on runtime state

    Skipped steps are still recorded in the execution path but marked as skipped. The step's output mapping is not applied when skipped.

    startAtStep?: MJAIAgentStepEntity

    Start execution at a specific step instead of the flow's entry point.

    When provided, the flow agent will begin execution at this step, skipping all steps that would normally precede it. This is useful for:

    • Resuming a flow from a specific point
    • Testing specific branches of a flow
    • Re-running a portion of a flow after a failure

    The step must belong to the agent being executed. Use AIEngine.Instance.GetAgentSteps(agentId) to retrieve available steps.

    A Decision step's answers are held by the run, never written into the payload, so a run started past a Decision step has none from it: every path that reads that decision stops the run with the reason. Start at or before the Decision step to route on it.

    Settings

    Member Visibility

    On This Page

    Properties