Member Junction
    Preparing search index...

    Interface AIAgentDefinition

    Complete agent definition that supports n-levels of sub-agent hierarchy All text fields support markdown formatting for rich documentation

    interface AIAgentDefinition {
        actions: { id: string; name: string; reason: string }[];
        description: string;
        executionOrder?: number;
        exposeAsAction?: boolean;
        finalPayloadValidation?: string;
        finalPayloadValidationMaxRetries?: number;
        finalPayloadValidationMode?: "Fail" | "Warn" | "Retry";
        iconClass?: string;
        name: string;
        payloadDownstreamPaths?: string[];
        payloadUpstreamPaths?: string[];
        prompt: {
            promptNotes?: string;
            systemPrompt?: string;
            templateVariables?: string;
        };
        purpose: string;
        subAgents?: AIAgentDefinition[];
        type: "Loop";
    }
    Index

    Properties

    actions description executionOrder? exposeAsAction? finalPayloadValidation? finalPayloadValidationMaxRetries? finalPayloadValidationMode? iconClass? name payloadDownstreamPaths? payloadUpstreamPaths? prompt purpose subAgents? type

    Properties

    actions: { id: string; name: string; reason: string }[]

    Type Declaration

    • id: string

      Action ID from the system action library

    • name: string

      Human-readable name of the action

    • reason: string

      Justification for why this action is needed

    description: string
    executionOrder?: number
    exposeAsAction?: boolean
    finalPayloadValidation?: string
    finalPayloadValidationMaxRetries?: number
    finalPayloadValidationMode?: "Fail" | "Warn" | "Retry"
    iconClass?: string
    name: string
    payloadDownstreamPaths?: string[]
    payloadUpstreamPaths?: string[]
    prompt: {
        promptNotes?: string;
        systemPrompt?: string;
        templateVariables?: string;
    }

    Type Declaration

    • OptionalpromptNotes?: string

      Prompt analysis and notes

    • OptionalsystemPrompt?: string

      System prompt for this agent

    • OptionaltemplateVariables?: string

      Template variables documentation

    purpose: string
    subAgents?: AIAgentDefinition[]
    type: "Loop"

    Settings

    Member Visibility

    On This Page

    Properties