Interface AutomationParticipantSlot

A named participant slot declared by an automation's workflow. Embedded stages hand work to the agent the invoker names for the slot.

interface AutomationParticipantSlot {
    description?: string | null;
    name: string;
    required: boolean;
    type: string;
}

Properties

description?: string | null

Workflow-authored explanation of the slot's role. null when the workflow declares none.

name: string

The slot's name, as referenced by the workflow. Supply the chosen agent under the top-level participants[name] field when invoking.

required: boolean

Whether the workflow requires this slot to be filled for the run to complete its embedded stages.

type: string

The kind of principal the slot accepts. Currently always "agent_user" — the value supplied at invoke is an agent ID (agi_...).