llms.txt
Compare with other sites' llms.txt files →# assistant-ui
> React components for AI chat interfaces
## LLM Documentation Files
- [Full documentation](https://www.assistant-ui.com/llms-full.txt): every documentation page rendered into one large text file.
- Per-page markdown: append `.md` to any docs page URL. `.mdx` is kept as a backwards-compatible alias for agents that request source-style URLs. For example, `/docs/installation.md` and `/docs/installation.mdx` both return markdown for `/docs/installation`.
- Markdown by Accept header: requesting a docs, examples, design or elements page with `Accept: text/markdown` also returns that page's markdown.
- Use the index below to choose a specific page. Remove the `.md` or `.mdx` suffix to open the human-readable docs page.
## Agent Discovery
- [Agent instructions](https://www.assistant-ui.com/AGENTS.md)
- [Site skill](https://www.assistant-ui.com/skill.md)
- [API catalog](https://www.assistant-ui.com/.well-known/api-catalog)
- [Agent Skills index](https://www.assistant-ui.com/.well-known/agent-skills/index.json)
- Agent skills: task-shaped SKILL.md guides listed in the Agent Skills index, one per area (assistant-ui, cloud, copilots, elements, generative-ui, ink, markdown, observability, primitives, react-mcp, react-native, runtime, setup, streaming, thread-list, tools, update).
- [Markdown sitemap](https://www.assistant-ui.com/sitemap.md)
- [Documentation MCP endpoint](https://www.assistant-ui.com/mcp)
## Table of Contents
### architecture
- [Architecture](https://www.assistant-ui.com/docs/architecture.md): How components, runtimes, and cloud services fit together.
### root
- [Overview](https://www.assistant-ui.com/docs.md): Components, runtimes, and primitives for building AI chat interfaces in React, Vue, React Native, and the terminal.
### llm
- [Agent Skills](https://www.assistant-ui.com/docs/llm.md): Use AI tools to build with assistant-ui faster. AI-accessible documentation, Claude Code skills, and MCP integration.
### base-ui
- [Radix UI and Base UI](https://www.assistant-ui.com/docs/base-ui.md): How the assistant-ui component registry serves Radix UI and Base UI flavored components for every shadcn style.
### cli
- [CLI](https://www.assistant-ui.com/docs/cli.md): Scaffold projects, add components, and manage updates from the command line.
### devtools
- [DevTools](https://www.assistant-ui.com/docs/devtools.md): Inspect runtime state, context, and events in the browser.
### installation
- [Installation](https://www.assistant-ui.com/docs/installation.md): Get assistant-ui running in 5 minutes with npm and your first chat component.
### rtl
- [RTL Support](https://www.assistant-ui.com/docs/rtl.md): Use assistant-ui with right-to-left languages like Arabic, Hebrew, and Persian.
### api-reference
- [Attachment Adapters](https://www.assistant-ui.com/docs/api-reference/adapters/attachments.md): Attachment adapters for uploading files, handling lifecycle events, and bringing app-owned content into assistant-ui com
- [Feedback Adapter](https://www.assistant-ui.com/docs/api-reference/adapters/feedback.md): Capture and respond to message feedback submitted through action primitives or runtime actions.
- [Adapters API Reference](https://www.assistant-ui.com/docs/api-reference/adapters.md): Adapter interfaces for connecting chat models, persistence, file attachments, feedback, and suggestions to assistant-ui
- [Model Adapters](https://www.assistant-ui.com/docs/api-reference/adapters/model.md): Adapter interfaces for connecting chat models, streaming responses, and model execution to assistant-ui runtimes.
- [Persistence Adapters](https://www.assistant-ui.com/docs/api-reference/adapters/persistence.md): Persistence adapters for saving assistant-ui message history, remote thread lists, and long-running chat sessions across
- [Runtime Adapter Context](https://www.assistant-ui.com/docs/api-reference/adapters/runtime.md): Provide assistant-ui runtime adapters through React context for model, attachment, speech, and feedback behavior.
- [Suggestion Adapters](https://www.assistant-ui.com/docs/api-reference/adapters/suggestions.md): Suggestion adapters for providing starter prompts, contextual actions, and guided composer options to assistant-ui runti
- [AssistantRuntimeProvider](https://www.assistant-ui.com/docs/api-reference/context-providers/assistant-runtime-provider.md): Root React provider that connects an assistant-ui runtime to primitives, hooks, threads, and composer state.
- [Context Providers API Reference](https://www.assistant-ui.com/docs/api-reference/context-providers.md): React context providers including AssistantRuntimeProvider that scope assistant-ui runtime, thread, message part, and at
- [Scoped Providers](https://www.assistant-ui.com/docs/api-reference/context-providers/scoped-providers.md): Lower-level assistant-ui providers for custom renderers, scoped message parts, attachments, and advanced composition.
- [External Store API Reference](https://www.assistant-ui.com/docs/api-reference/external-store.md): External store runtime, message conversion helpers, and adapters for assistant-ui React apps that own their chat state o
- [Message Conversion](https://www.assistant-ui.com/docs/api-reference/external-store/message-conversion.md): Convert external message formats into assistant-ui's message and thread state for the external store runtime.
- [External Store Runtime](https://www.assistant-ui.com/docs/api-reference/external-store/runtime.md): Runtime components, options, and adapters for using assistant-ui with externally owned chat state.
- [A2UI](https://www.assistant-ui.com/docs/api-reference/generative-ui/a2ui.md): Convert A2UI surface operations into generative UI specs.
- [Generative UI Actions](https://www.assistant-ui.com/docs/api-reference/generative-ui/actions.md): Register handlers for model-emitted actions and dispatch them from interactive generative UI components.
- [Generative UI Components](https://www.assistant-ui.com/docs/api-reference/generative-ui/components.md): Define the component library JSONGenerativeUI can render, including schemas, render functions, and the default vocabular
- [Generative UI API Reference](https://www.assistant-ui.com/docs/api-reference/generative-ui.md): Spec-driven generative UI for assistant-ui. The data format an assistant streams, the component registry that resolves i
- [JSONGenerativeUI](https://www.assistant-ui.com/docs/api-reference/generative-ui/json-generative-ui.md): Create present and prompt_user tools from a generative UI component library, with options for display mode and action di
- [Generative UI Rendering](https://www.assistant-ui.com/docs/api-reference/generative-ui/rendering.md): Render generative UI trees, build present-tool schemas, and inspect or serialize model-produced UI nodes.
- [Slack Block Kit](https://www.assistant-ui.com/docs/api-reference/generative-ui/slack.md): Convert generative UI trees to Slack Block Kit payloads and decode block_actions interactions back into $action payloads
- [Generative UI Spec](https://www.assistant-ui.com/docs/api-reference/generative-ui/spec.md): The serializable node tree an assistant emits to describe generative UI. Covers the GenerativeUISpec format, its nodes,
- [Microsoft Teams](https://www.assistant-ui.com/docs/api-reference/generative-ui/teams.md): Convert generative UI trees to Teams Adaptive Cards and decode Action.Submit payloads back into $action payloads.
- [Generative UI Tokens](https://www.assistant-ui.com/docs/api-reference/generative-ui/tokens.md): Shared token arrays used by the default generative UI vocabulary for sizing, color, alignment, and component variants.
- [Composer Trigger Hooks](https://www.assistant-ui.com/docs/api-reference/hooks/composer-triggers.md): Unstable assistant-ui hooks for mention menus, slash commands, and custom composer trigger popovers.
- [Hooks API Reference](https://www.assistant-ui.com/docs/api-reference/hooks.md): React hooks for assistant-ui: useAui, useAuiState, runtime creation, model context registration, and helpers for buildin
- [Model Context Hooks](https://www.assistant-ui.com/docs/api-reference/hooks/model-context.md): React hooks for registering assistant-ui tools, data renderers, instructions, and model context providers.
- [Primitive Hooks](https://www.assistant-ui.com/docs/api-reference/hooks/primitives.md): Primitive hooks for reading scoped assistant-ui runtime state, viewport behavior, timing, and message part data inside R
- [Runtime Hooks](https://www.assistant-ui.com/docs/api-reference/hooks/runtimes.md): Runtime creation hooks for local, remote, cloud, external-store, and AI SDK powered assistant-ui chat experiences.
- [State Hooks](https://www.assistant-ui.com/docs/api-reference/hooks/state.md): State selector and action hooks for reading assistant-ui runtime state and controlling threads, composers, messages, and
- [@assistant-ui/ai-sdk](https://www.assistant-ui.com/docs/api-reference/integrations/ai-sdk.md): Vercel AI SDK runtime hooks, chat transports, and message conversion utilities for assistant-ui applications.
- [assistant-cloud/ai-sdk](https://www.assistant-ui.com/docs/api-reference/integrations/assistant-cloud-ai-sdk.md): The AI SDK message format adapter and run telemetry extraction that the assistant-ui runtime uses, typed against UIMessa
- [assistant-cloud/telemetry](https://www.assistant-ui.com/docs/api-reference/integrations/assistant-cloud-telemetry.md): OpenTelemetry exporter, span processor and stream metadata helpers that send a server's GenAI spans to Assistant Cloud a
- [assistant-cloud](https://www.assistant-ui.com/docs/api-reference/integrations/assistant-cloud.md): The assistant-cloud client for threads, messages, runs, events, scores and files, with the reporters, persistence and ru
- [@assistant-ui/eve](https://www.assistant-ui.com/docs/api-reference/integrations/eve.md): Eve runtime hook and message conversion utilities for assistant-ui React applications.
- [Integrations API Reference](https://www.assistant-ui.com/docs/api-reference/integrations.md): Package-level APIs for connecting assistant-ui React to the Vercel AI SDK, Assistant Cloud, and adjacent chat ecosystem
- [@assistant-ui/react-data-stream](https://www.assistant-ui.com/docs/api-reference/integrations/react-data-stream.md): Data stream runtime hook and message conversion utilities for custom assistant-ui streaming backends.
- [Model Context](https://www.assistant-ui.com/docs/api-reference/model-context/context.md): Provide model instructions, contextual state, and inline renderers to assistant-ui runtimes.
- [Model Context API Reference](https://www.assistant-ui.com/docs/api-reference/model-context.md): Model instructions, contextual state, provider registries, and renderers for giving assistant-ui runtimes app-aware cont
- [Model Context Registry](https://www.assistant-ui.com/docs/api-reference/model-context/registry.md): Register and manage assistant-ui model context providers that contribute instructions and app state.
- [API Reference](https://www.assistant-ui.com/docs/api-reference/overview.md): Complete assistant-ui React API reference for building AI chat UIs with primitives, hooks, runtimes, adapters, tools, tr
- [ActionBarMorePrimitive](https://www.assistant-ui.com/docs/api-reference/primitives/action-bar-more.md): Overflow menu primitives for grouping secondary assistant message actions in a custom React UI.
- [ActionBarPrimitive](https://www.assistant-ui.com/docs/api-reference/primitives/action-bar.md): Composable message action controls for copy, edit, reload, speech, and feedback in assistant-ui chat interfaces.
- [AuiIf](https://www.assistant-ui.com/docs/api-reference/primitives/assistant-if.md): Conditional rendering primitive for showing React UI from assistant-ui thread, message, composer, and runtime state.
- [AssistantModalPrimitive](https://www.assistant-ui.com/docs/api-reference/primitives/assistant-modal.md): Floating assistant modal primitives for building support chat, copilot, and embedded assistant experiences.
- [AttachmentPrimitive](https://www.assistant-ui.com/docs/api-reference/primitives/attachment.md): Attachment primitives for rendering file previews, names, thumbnails, and remove controls in assistant-ui messages and c
- [BranchPickerPrimitive](https://www.assistant-ui.com/docs/api-reference/primitives/branch-picker.md): Branch picker primitives for navigating regenerated assistant responses and alternate message paths inside a chat thread
- [ChainOfThoughtPrimitive](https://www.assistant-ui.com/docs/api-reference/primitives/chain-of-thought.md): Chain of thought primitives for rendering assistant reasoning, step lists, and collapsible disclosure UI in message cont
- [ComposerPrimitive](https://www.assistant-ui.com/docs/api-reference/primitives/composer.md): Composable input primitives for assistant-ui prompts, send controls, cancellation, attachments, and composer state.
- [Composition](https://www.assistant-ui.com/docs/api-reference/primitives/composition.md): How to compose primitives with custom components using asChild.
- [ErrorPrimitive](https://www.assistant-ui.com/docs/api-reference/primitives/error.md): Error primitives for rendering assistant-ui runtime, thread, and message failures inside custom chat interfaces.
- [Primitives API Reference](https://www.assistant-ui.com/docs/api-reference/primitives.md): Composable React primitives for assistant-ui chat UIs: Thread, Composer, Message, BranchPicker, ActionBar, and the parts
- [MessagePartPrimitive](https://www.assistant-ui.com/docs/api-reference/primitives/message-part.md): Message part primitives for rendering text, tool calls, data parts, reasoning, source content, and custom assistant outp
- [MessagePrimitive](https://www.assistant-ui.com/docs/api-reference/primitives/message.md): Message primitives for rendering assistant and user turns, message parts, attachments, actions, editing, and branch cont
- [QueueItemPrimitive](https://www.assistant-ui.com/docs/api-reference/primitives/queue-item.md): Queue item primitives for rendering pending assistant-ui thread operations, optimistic work, and runtime queue state.
- [SelectionToolbarPrimitive](https://www.assistant-ui.com/docs/api-reference/primitives/selection-toolbar.md): Selection toolbar primitives for quote, copy, and contextual actions on selected chat text.
- [SuggestionPrimitive](https://www.assistant-ui.com/docs/api-reference/primitives/suggestion.md): Suggestion primitives for rendering starter prompts, follow-up actions, and composer suggestions in assistant-ui threads
- [ThreadListItemMorePrimitive](https://www.assistant-ui.com/docs/api-reference/primitives/thread-list-item-more.md): Overflow menu primitives for secondary thread list item actions in custom assistant-ui sidebars.
- [ThreadListItemPrimitive](https://www.assistant-ui.com/docs/api-reference/primitives/thread-list-item.md): Thread list item primitives for rendering selectable conversation rows with titles, archive controls, delete actions, an
- [ThreadListPrimitive](https://www.assistant-ui.com/docs/api-reference/primitives/thread-list.md): Thread list primitives for rendering conversation navigation, new thread actions, and custom assistant sidebars.
- [ThreadPrimitive](https://www.assistant-ui.com/docs/api-reference/primitives/thread.md): Thread primitives for rendering chat transcripts, message lists, viewport state, suggestions, and composers in assistant
- [AssistantRuntime](https://www.assistant-ui.com/docs/api-reference/runtimes/assistant-runtime.md): Top-level assistant-ui runtime actions and state for tools, threads, composers, messages, and assistant behavior.
- [AttachmentRuntime](https://www.assistant-ui.com/docs/api-reference/runtimes/attachment-runtime.md): AttachmentRuntime state and actions for reading attachment data and controlling files inside assistant-ui messages and c
- [ComposerRuntime](https://www.assistant-ui.com/docs/api-reference/runtimes/composer-runtime.md): ComposerRuntime state and actions for controlling assistant-ui composer text, attachments, submission, cancellation, and
- [Runtime State API Reference](https://www.assistant-ui.com/docs/api-reference/runtimes.md): Runtime state and actions exposed through useAui and useAuiState, covering AssistantRuntime, ThreadRuntime, ThreadListRu
- [MessagePartRuntime](https://www.assistant-ui.com/docs/api-reference/runtimes/message-part-runtime.md): MessagePartRuntime state and helpers for inspecting assistant-ui text, tool calls, data parts, reasoning, and custom mes
- [MessageRuntime](https://www.assistant-ui.com/docs/api-reference/runtimes/message-runtime.md): MessageRuntime state and actions for editing, reloading, copying, rating, speaking, and branching assistant-ui messages.
- [QueueItemState](https://www.assistant-ui.com/docs/api-reference/runtimes/queue-state.md): State shape for queued assistant-ui thread operations and pending runtime work.
- [ThreadListItemRuntime](https://www.assistant-ui.com/docs/api-reference/runtimes/thread-list-item-runtime.md): ThreadListItemRuntime state and actions for selecting, archiving, unarchiving, deleting, and renaming assistant-ui conve
- [ThreadListRuntime](https://www.assistant-ui.com/docs/api-reference/runtimes/thread-list-runtime.md): ThreadListRuntime state and actions for managing remote assistant-ui conversations, active thread selection, and new thr
- [ThreadRuntime](https://www.assistant-ui.com/docs/api-reference/runtimes/thread-runtime.md): ThreadRuntime state and actions for controlling assistant-ui messages, composers, suggestions, model context, and the fu
- [Component Tools](https://www.assistant-ui.com/docs/api-reference/tools/component-tools.md): Register assistant tools from mounted React components, scoped to the lifetime of part of the UI tree.
- [Tools API Reference](https://www.assistant-ui.com/docs/api-reference/tools.md): Tool definitions, React renderers, status helpers, and toolkits for exposing callable app capabilities to assistant-ui c
- [Interactables (legacy)](https://www.assistant-ui.com/docs/api-reference/tools/interactables-legacy.md): Deprecated legacy interactables APIs for registering model-editable components with per-instance update tools.
- [Interactables](https://www.assistant-ui.com/docs/api-reference/tools/interactables.md): Unstable interactables APIs for model-editable app and message state, including hooks, resources, toolkit helpers, and s
- [Tool Rendering](https://www.assistant-ui.com/docs/api-reference/tools/rendering.md): Register React renderers for assistant-ui tool calls, tool results, and model data parts.
- [Tool Status](https://www.assistant-ui.com/docs/api-reference/tools/status.md): Read tool arguments, execution status, and result state inside assistant-ui tool UI components.
- [Toolkits](https://www.assistant-ui.com/docs/api-reference/tools/toolkits.md): Define model-facing tools and compose them into named toolkits registered with an assistant-ui runtime scope.
- [Assistant Transport](https://www.assistant-ui.com/docs/api-reference/transport/assistant-transport.md): Command, protocol, and transport types for connecting assistant-ui runtimes across execution boundaries.
- [Assistant Frame](https://www.assistant-ui.com/docs/api-reference/transport/frame.md): Frame bridge APIs and serialized message types for embedding assistant-ui runtimes in external contexts.
- [Transport API Reference](https://www.assistant-ui.com/docs/api-reference/transport.md): Transport commands, frame messages, and protocol types for synchronizing assistant-ui runtimes across process or iframe
- [Utilities API Reference](https://www.assistant-ui.com/docs/api-reference/utilities.md): Utility exports for custom rendering, composition, and advanced assistant-ui behavior that does not fit a larger API fam
- [Utilities](https://www.assistant-ui.com/docs/api-reference/utilities/miscellaneous.md): Miscellaneous @assistant-ui/react utilities for custom re