Member Junction
    Preparing search index...

    Interface RunAgentParams

    Parameters for running an agent via the SDK. This is a simplified interface wrapping the GraphQL mutation parameters. The SDK handles serialization and session ID injection internally.

    interface RunAgentParams {
        AgentId: string;
        AutoPopulateLastRunPayload?: boolean;
        ConfigurationId?: string;
        ConversationDetailId?: string;
        ConversationId?: string;
        CreateArtifacts?: boolean;
        CreateNotification?: boolean;
        Data?: Record<string, unknown>;
        LastRunId?: string;
        Messages: { content: string; role: string }[];
        OnProgress?: (progress: AgentProgress) => void;
        Payload?: string | Record<string, unknown>;
        PlanMode?: boolean;
        RequestedSkillIDs?: string[];
        SourceArtifactId?: string;
        SourceArtifactVersionId?: string;
    }
    Index

    Properties

    AgentId AutoPopulateLastRunPayload? ConfigurationId? ConversationDetailId? ConversationId? CreateArtifacts? CreateNotification? Data? LastRunId? Messages OnProgress? Payload? PlanMode? RequestedSkillIDs? SourceArtifactId? SourceArtifactVersionId?

    Properties

    AgentId: string

    The ID of the agent to run

    AutoPopulateLastRunPayload?: boolean

    Whether to auto-populate payload from last run

    ConfigurationId?: string

    Configuration ID to use

    ConversationDetailId?: string

    Optional conversation detail ID (triggers artifact/notification creation)

    ConversationId?: string

    Optional conversation ID (for resuming a conversation)

    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

    Messages: { content: string; role: string }[]

    User message(s) to send to the agent

    OnProgress?: (progress: AgentProgress) => 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)

    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

    Settings

    Member Visibility

    On This Page

    Properties