For AI agents: a documentation index is available at llms.txt. Use .md for canonical markdown pages; .mdx is kept as a backwards-compatible alias on supported URL paths.
assistant-ui logoassistant-ui/docsfor/API Reference
Cloud
  • Pricing
Cloud
Products
PlatformsReactReact NativeInk
HostedCloudPlayground
Primitivestw-shimmerHeat GraphSafe Content Framereact-o11y
Resources
LearnInteractive courseChangelogShowcaseOpen sourcePackages
CompanyBlogCareersBrandTractionStatus
Pricing
Cloud

Hooks API Reference

React hooks for assistant-ui: useAui, useAuiState, runtime creation, model context registration, and helpers for building custom AI chat behavior.

Hooks are the escape hatch and integration layer for React applications. Use them to read assistant state, call runtime actions, create runtimes, register model context, and connect custom components to assistant-ui behavior.

Pages

Composer Trigger HooksUnstable assistant-ui hooks for mention menus, slash commands, and custom composer trigger popovers.Model Context HooksReact hooks for registering assistant-ui tools, data renderers, instructions, and model context providers.Primitive HooksPrimitive hooks for reading scoped assistant-ui runtime state, viewport behavior, timing, and message part data inside React components.Runtime HooksRuntime creation hooks for local, remote, cloud, external-store, and AI SDK powered assistant-ui chat experiences.State HooksState selector and action hooks for reading assistant-ui runtime state and controlling threads, composers, messages, and attachments.
ThreadListItemMorePrimitiveComposer Trigger Hooks

On this page

  • Pages
View as MarkdownEdit on GitHub
© 2026 AgentbaseAI Inc.
Privacy·Terms·
API Reference

Tools

Tools API ReferenceToolkitsComponent ToolsTool RenderingTool StatusInteractablesInteractables (legacy)

Model Context

Model Context API ReferenceModel ContextModel Context Registry

Transport

Transport API ReferenceAssistant TransportAssistant Frame

External Store

External Store API ReferenceMessage ConversionExternal Store Runtime

Voice

Voice API ReferenceVoice SessionsSpeech and Dictation

Generative UI

Generative UI API ReferenceJSONGenerativeUIGenerative UI ComponentsGenerative UI ActionsGenerative UI SpecGenerative UI RenderingSlack Block KitMicrosoft TeamsA2UIGenerative UI Tokens

Primitives

Primitives API ReferenceActionBarPrimitiveActionBarMorePrimitiveAuiIfAssistantModalPrimitiveAttachmentPrimitiveBranchPickerPrimitiveChainOfThoughtPrimitiveComposerPrimitiveCompositionErrorPrimitiveMessagePrimitiveMessagePartPrimitiveQueueItemPrimitiveSelectionToolbarPrimitiveSuggestionPrimitiveThreadPrimitiveThreadListPrimitiveThreadListItemPrimitiveThreadListItemMorePrimitive

Hooks

Hooks API ReferenceComposer Trigger HooksModel Context HooksPrimitive HooksRuntime HooksState Hooks

Adapters

Adapters API ReferenceAttachment AdaptersFeedback AdapterModel AdaptersPersistence AdaptersRuntime Adapter ContextSuggestion Adapters

Runtimes

Runtime State API ReferenceAssistantRuntimeAttachmentRuntimeComposerRuntimeMessagePartRuntimeMessageRuntimeQueueItemStateThreadListItemRuntimeThreadListRuntimeThreadRuntime

Context Providers

Context Providers API ReferenceAssistantRuntimeProviderScoped Providers

Integrations

Integrations API Reference@assistant-ui/ai-sdk@assistant-ui/react-data-stream@assistant-ui/eveassistant-cloudassistant-cloud/ai-sdkassistant-cloud/telemetry

Utilities

Utilities API ReferenceUtilities