@pouchy_ai/companion-sdk - v0.1.0
    Preparing search index...

    Interface HelloAckPayload

    Payload of a hello.ack — the handshake reply. On the REST plane this is the /session response body (what connect() normalizes into HelloAck); the event stream's greeting open frame carries a partial echo (just { resumeCursor }), so every field is optional at the wire level.

    interface HelloAckPayload {
        grantedScopes?: string[];
        modalities?: string[];
        pendingToolCalls?: PendingToolCall[];
        representative?: boolean;
        resumeCursor?: number;
        session?: string;
        visitorPaired?: boolean;
    }
    Index
    grantedScopes? modalities? pendingToolCalls? representative? resumeCursor? session? visitorPaired?
    grantedScopes?: string[]
    modalities?: string[]
    pendingToolCalls?: PendingToolCall[]

    Outstanding tool calls from a turn that paused before this handshake — present (non-empty) only when resuming a session mid-pause. See PendingToolCall; the SDK re-emits them to onToolCall with replayed: true unless replayPendingToolCalls: false.

    representative?: boolean
    resumeCursor?: number
    session?: string
    visitorPaired?: boolean

    Settings
    Member Visibility

    On This Page
    Properties