@cavell/kit API
    Preparing search index...

    Interface CavellProviderProps

    interface CavellProviderProps {
        agentId: string;
        baseUrl?: string;
        capabilities?: Partial<CavellCapabilities>;
        children: ReactNode;
        context?: Record<string, unknown>;
        defaultThrottleMs?: number;
        disablePreloading?: boolean;
        frontendTools?: ReactFrontendTool[];
        headers?: Record<string, string> | (() => Record<string, string>);
        humanInTheLoop?: ReactHumanInTheLoop[];
        locale?: string;
        onClientOutdated?: () => void;
        onError?: CavellErrorHandler;
        onSessionExpired?: () => void;
        prompt?: string;
        properties?: Record<string, unknown>;
        renderToolCalls?: ReactToolCallRenderer<unknown>[];
        runUrl?: string;
        threadId?: string;
        timezone?: string;
        toolCallbacks?: ToolCallback[];
    }
    Index
    agentId baseUrl? capabilities? children context? defaultThrottleMs? disablePreloading? frontendTools? headers? humanInTheLoop? locale? onClientOutdated? onError? onSessionExpired? prompt? properties? renderToolCalls? runUrl? threadId? timezone? toolCallbacks?
    agentId: string

    LOGICAL agent id — the {agent_id} segment of the run endpoint. Resolution to a concrete upstream may happen server-side (a routing proxy — ADR 0006 D3/D5).

    baseUrl?: string

    API origin (no trailing slash): the Cavell backend or a conforming proxy. Empty = same-origin.

    capabilities?: Partial<CavellCapabilities>

    Cavell-profile feature gates; defaults derive from the targeting mode (ADR 0006 D4).

    children: ReactNode
    context?: Record<string, unknown>

    Declarative EHR context — sent in full on every run (ADR 0004 §7).

    defaultThrottleMs?: number

    Snapshot throttle for agent subscriptions (CopilotKit-shaped; kit default 66ms).

    disablePreloading?: boolean

    Skip auto-resume of a recent conversation (the history list still loads).

    frontendTools?: ReactFrontendTool[]

    Frontend tools registered at mount (CopilotKit-shaped). Prefer the useFrontendTool hook for anything dynamic — keep this array stable.

    headers?: Record<string, string> | (() => Record<string, string>)

    Headers for the AG-UI runs AND the REST side channels (object or thunk) — CopilotKit-shaped, and the ONLY auth channel: headers={() => ({ Authorization: Bearer ${token} })}. A thunk re-resolves at every run/request boundary, which is how rotation reaches the transport.

    humanInTheLoop?: ReactHumanInTheLoop[]

    HITL tools registered at mount (CopilotKit parity). Same caveat as CopilotKit: only the useHumanInTheLoop HOOK wires an interactive respond; this installs a placeholder.

    locale?: string

    Host-declared locale. When ABSENT it is not sent, so the backend resolves the caregiver locale (ADR 0004 locale chain) and the kit chrome adopts it from the conversation state.

    onClientOutdated?: () => void

    The backend refused a run with RUN_ERROR client_outdated: this kit build is below the backend's min_supported floor (ADR 0007 D3) — ship a host update. Sticky per mount.

    onError?: CavellErrorHandler

    CopilotKit-shaped error surface (same event shape/codes as CopilotKitProvider.onError).

    onSessionExpired?: () => void
    prompt?: string

    One-shot prompt: boot skips auto-resume, opens a new conversation and sends it.

    properties?: Record<string, unknown>

    Extra forwardedProps merged into every run.

    renderToolCalls?: ReactToolCallRenderer<unknown>[]

    Extra CopilotKit tool-call renderers (the kit renders reserved HITL natively).

    runUrl?: string

    Full run-endpoint override — point at ANY AG-UI-compliant agent. Wins over baseUrl+agentId for the agent transport; Cavell-profile capabilities default OFF when set (ADR 0006 D3/D4).

    threadId?: string

    Open a specific existing conversation instead of running the boot policy.

    timezone?: string
    toolCallbacks?: ToolCallback[]

    Tool-call callbacks: auto (fires when a live call completes) or user-triggered card actions like "Send to EHR" (ADR 0006 D6); label names the action button.

    Settings
    Member Visibility

    On This Page
    Properties