Member Junction
    Preparing search index...

    Interface RunAgentFromConversationDetailParams

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

    interface RunAgentFromConversationDetailParams {
        AgentHistoryFrom?: Date;
        AgentId: string;
        AnnouncedByAgentId?: string;
        AutoPopulateLastRunPayload?: boolean;
        ConfigurationId?: string;
        CreateArtifacts?: boolean;
        CreateNotification?: boolean;
        Data?: Record<string, unknown>;
        LastRunId?: string;
        MaxHistoryMessages?: number;
        OnAccepted?: (reply: AgentReplyAcknowledgement) => void;
        OnProgress?: (
            progress: {
                CurrentStep: string;
                Message: string;
                Metadata?: Record<string, unknown>;
                Percentage?: number;
            },
        ) => void;
        Payload?: string
        | Record<string, unknown>;
        PlanMode?: boolean;
        ReplyBranchId?: string;
        ReplyParentId?: string;
        RequestedSkillIDs?: string[];
        SourceArtifactId?: string;
        SourceArtifactVersionId?: string;
        UserMessageId: string;
    }
    Index

    Properties

    AgentHistoryFrom? AgentId AnnouncedByAgentId? AutoPopulateLastRunPayload? ConfigurationId? CreateArtifacts? CreateNotification? Data? LastRunId? MaxHistoryMessages? OnAccepted? OnProgress? Payload? PlanMode? ReplyBranchId? ReplyParentId? RequestedSkillIDs? SourceArtifactId? SourceArtifactVersionId? UserMessageId

    Properties

    AgentHistoryFrom?: Date

    The first moment of the conversation the 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, so a server that predates the argument keeps working.

    AgentId: string

    The ID of the agent to run

    AnnouncedByAgentId?: string

    An active agent whose fixed line "Continuing with {agent} for refinement..." the server posts before the reply, which then threads under it. OnAccepted names the line as AnnouncementDetailId.

    AutoPopulateLastRunPayload?: boolean

    Whether to auto-populate payload from last run

    ConfigurationId?: string

    Configuration ID to use

    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>

    Optional data context passed to the agent

    LastRunId?: string

    Optional ID of the last agent run for continuity

    MaxHistoryMessages?: number

    Maximum number of history messages to include

    OnAccepted?: (reply: AgentReplyAcknowledgement) => void

    Called once the server accepts the run, before any progress, with the reply row it created: its ID keys the run's progress and completion, and its creation time starts the reply's timer. Not called when a headless provider runs the turn synchronously; the result's agentRun.ConversationDetailID names the row then.

    OnProgress?: (
        progress: {
            CurrentStep: string;
            Message: string;
            Metadata?: Record<string, unknown>;
            Percentage?: number;
        },
    ) => void

    Optional callback for progress updates

    Payload?: string | Record<string, unknown>

    Optional payload passed to the agent

    PlanMode?: boolean

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

    ReplyBranchId?: string

    The fork the reply and history run on, when the turn forks from UserMessageId (such as Regenerate). Checked by the server to be a branch of the conversation whose path holds UserMessageId.

    ReplyParentId?: string

    The message the reply threads under, when not the user's message: one of the same conversation.

    RequestedSkillIDs?: string[]

    Skill IDs the user requested via /skill-name mentions. 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

    UserMessageId: string

    The person's message this turn answers, already saved. The server creates the agent's reply row (only the server writes agent replies) and names it to OnAccepted.

    Settings

    Member Visibility

    On This Page

    Properties