AskAI
Top-level AskAI preset that wires context, transport, and a default Trigger + Dialog surface
Overview
The top-level component that wires context, transport, and persistence, then renders the default preset (AskAI.Trigger + AskAI.Dialog). Use it as-is for a drop-in chat UI or compose the underlying pieces for custom layouts.
Here is a basic example using the default AskAI.Trigger and AskAI.Dialog:
<AskAI />Anatomy
AskAIprovides state, transport, and context.AskAI.Triggertoggles open state (defaults to the floating Peam button).AskAI.Dialog,AskAI.Chat, orAskAI.Sidepanerender the surface.AskAI.Header,AskAI.Messages,AskAI.Suggestions, andAskAI.Inputare layout primitives.AskAI.Inlinerenders the full inline surface without another wrapper.
<AskAI>
<AskAI.Trigger />
<AskAI.Dialog />
</AskAI>Overview
Props
| Prop | Type | Default | Description |
|---|---|---|---|
endpoint | string | '/api/peam' | API endpoint used by the chat transport. |
open | boolean | undefined | Controlled open state. |
defaultOpen | boolean | false | Uncontrolled initial open state. |
chatTransport | HttpChatTransport<UIMessage> | undefined | Override the default transport. |
persistence | boolean | { key?: string } | true | Configure chat persistence or disable it. |
reuseContext | boolean | true | Reuse an existing AskAIContext if present. |
children | ReactNode | undefined | Custom composition (if omitted, renders Trigger + Dialog). |
className | string | undefined | Class name applied to the root wrapper. |