Member Junction
    Preparing search index...

    Interface RunAIAgentFromConversationDetailParams

    Parameters for running an AI agent from an existing conversation detail. This is the optimized method that loads conversation history server-side.

    interface RunAIAgentFromConversationDetailParams {
        agentHistoryFrom?: Date;
        agentId: string;
        autoPopulateLastRunPayload?: boolean;
        configurationId?: string;
        conversationDetailId: string;
        createArtifacts?: boolean;
        createNotification?: boolean;
        data?: Record<string, unknown>;
        lastRunId?: string;
        maxHistoryMessages?: number;
        onProgress?: (
            progress: {
                currentStep: string;
                message: string;
                metadata?: Record<string, unknown>;
                percentage?: number;
            },
        ) => void;
        payload?: string
        | Record<string, unknown>;
        planMode?: boolean;
        requestedSkillIDs?: string[];
        sourceArtifactId?: string;
        sourceArtifactVersionId?: string;
    }
    Index

    Properties

    agentHistoryFrom? agentId autoPopulateLastRunPayload? configurationId? conversationDetailId createArtifacts? createNotification? data? lastRunId? maxHistoryMessages? onProgress? payload? planMode? requestedSkillIDs? sourceArtifactId? sourceArtifactVersionId?

    Properties

    agentHistoryFrom?: Date

    The first moment of the conversation this run may read. When set, the server loads the agent's history from there and skips its summary of earlier messages.

    Sent only when set: the argument is left out of the mutation document entirely otherwise, so a server that predates it (and would reject an unknown argument) keeps working.

    agentId: string

    The ID of the AI agent to run

    autoPopulateLastRunPayload?: boolean

    Whether to auto-populate payload from last run

    configurationId?: string

    Configuration ID to use

    conversationDetailId: string

    The ID of the conversation detail (user's message) to use as context

    createArtifacts?: boolean

    Whether to create artifacts from the agent's payload

    createNotification?: boolean

    Whether to create a user notification on completion

    data?: Record<string, unknown>

    Data context to pass to the agent (will be JSON serialized)

    lastRunId?: string

    ID of the last agent run for continuity

    maxHistoryMessages?: number

    Maximum number of history messages to include (default: 20)

    onProgress?: (
        progress: {
            currentStep: string;
            message: string;
            metadata?: Record<string, unknown>;
            percentage?: number;
        },
    ) => void

    Optional callback for progress updates

    payload?: string | Record<string, unknown>

    Payload to pass to the agent (will be JSON serialized)

    planMode?: boolean

    Whether Plan Mode is requested for this run (requires the agent's SupportsPlanMode capability)

    requestedSkillIDs?: string[]

    Skill IDs the user requested via /skill-name mentions. The server intersects these with the agent's accepted skills AND the user's Run permission before any are activated.

    sourceArtifactId?: string

    Source artifact ID for versioning

    sourceArtifactVersionId?: string

    Source artifact version ID for versioning

    Settings

    Member Visibility

    On This Page

    Properties