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

Adapters API Reference

Adapter interfaces for connecting chat models, persistence, file attachments, feedback, and suggestions to assistant-ui React runtimes.

Adapters define the boundaries between assistant-ui and the systems around it. Use them when you need custom model execution, attachment handling, persistence, feedback collection, or prompt suggestions.

Pages

Attachment AdaptersAttachment adapters for uploading files, handling lifecycle events, and bringing app-owned content into assistant-ui composers and messages.Feedback AdapterCapture and respond to message feedback submitted through action primitives or runtime actions.Model AdaptersAdapter interfaces for connecting chat models, streaming responses, and model execution to assistant-ui runtimes.Persistence AdaptersPersistence adapters for saving assistant-ui message history, remote thread lists, and long-running chat sessions across browser reloads.Runtime Adapter ContextProvide assistant-ui runtime adapters through React context for model, attachment, speech, and feedback behavior.Suggestion AdaptersSuggestion adapters for providing starter prompts, contextual actions, and guided composer options to assistant-ui runtimes.
State HooksAttachment Adapters

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