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/Docs/API Reference

PlaygroundPricing

LearnExamples Showcase Changelog

CompanyBlog Traction Careers Brand

Open sourceGitHub Packages React Native Ink

Adapters

Suggestion Adapters

Suggestion adapters for providing starter prompts, contextual actions, and guided composer options to assistant-ui runtimes.

API Reference

SuggestionAdapter

SuggestionAdapter

generate : ( options: SuggestionAdapterGenerateOptions, ) => | Promise<readonly ThreadSuggestion[]> | AsyncGenerator<readonly ThreadSuggestion[], void>

Runtime Adapter Context Runtime State API Reference

On this page

API Reference
SuggestionAdapter

View as Markdown Edit on GitHub

We are hiring

Build the future of agentic UI with us →

Tools

Tools API Reference Toolkits Component Tools Tool Rendering Tool Status Interactables Interactables (legacy)

Model Context

Model Context API Reference Model Context Model Context Registry

Transport

Transport API Reference Assistant Transport Assistant Frame

External Store

External Store API Reference Message Conversion External Store Runtime

Voice

Voice API Reference Voice Sessions Speech and Dictation

Generative UI

Generative UI API Reference Generative UI Spec Generative UI Rendering

Primitives

Primitives API Reference ActionBarPrimitive ActionBarMorePrimitive AuiIf AssistantModalPrimitive AttachmentPrimitive BranchPickerPrimitive ChainOfThoughtPrimitive ComposerPrimitive ErrorPrimitive MessagePrimitive MessagePartPrimitive QueueItemPrimitive SelectionToolbarPrimitive SuggestionPrimitive ThreadPrimitive ThreadListPrimitive ThreadListItemPrimitive ThreadListItemMorePrimitive

Hooks

Hooks API Reference Composer Trigger Hooks Model Context Hooks Primitive Hooks Runtime Hooks State Hooks

Adapters

Adapters API Reference Attachment Adapters Feedback Adapter Model Adapters Persistence Adapters Runtime Adapter Context Suggestion Adapters

Runtimes

Runtime State API Reference AssistantRuntime AttachmentRuntime ComposerRuntime MessagePartRuntime MessageRuntime QueueItemState ThreadListItemRuntime ThreadListRuntime ThreadRuntime

Context Providers

Context Providers API Reference AssistantRuntimeProvider Scoped Providers

Integrations

Integrations API Reference @assistant-ui/react-ai-sdk @assistant-ui/cloud-ai-sdk @assistant-ui/eve

Utilities

Utilities API Reference Utilities