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

Elements
Playground

Elements
Playground
Pricing

Resources

LearnInteractive course Examples Showcase Changelog

CompanyBlog Traction Careers Brand

Open sourceAll projects Packages

CommunityGitHub Discord X

Playground Pricing

Runtimes

QueueItemState

State shape for queued assistant-ui thread operations and pending runtime work.

API Reference

QueueItemState

QueueItemState

id : string

promptdeprecated : string

Deprecated: Derive from the text parts of `parts` instead. Removal after 2026-11-05.

parts : readonly (FileMessagePart | TextMessagePart)[]

MessageRuntime ThreadListItemRuntime

On this page

API Reference
QueueItemState

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 JSONGenerativeUI Generative UI Components Generative UI Actions Generative UI Spec Generative UI Rendering Slack Block Kit Microsoft Teams A2UI Generative UI Tokens

Primitives

Primitives API Reference ActionBarPrimitive ActionBarMorePrimitive AuiIf AssistantModalPrimitive AttachmentPrimitive BranchPickerPrimitive ChainOfThoughtPrimitive ComposerPrimitive Composition 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/react-data-stream @assistant-ui/cloud-ai-sdk @assistant-ui/eve

Utilities

Utilities API Reference Utilities

Ask AI