Skip to content
Agent UI

Documentation

Build agent interfaces with 84 documented pieces.

32 primitives, 4 tool and reasoning surfaces, 6 navigation controls, 14 blocks, 12 compose primitives, and 15 copy-paste provider blocks. Browse examples and API references, then use the source registry for supported primitives. Provider block pages include full source and installation guidance.

Quick start

Install a standalone primitive from the component registry. For full conversation modules, use the monorepo React workspace until package publishing and verification are complete.

1. Set up shadcn

bash
npx shadcn@latest init

2. Add a primitive

bash
npx shadcn@latest add https://agent-ui-27t.pages.dev/r/button.json

3. Render the component

tsx
import { Button } from "@/components/ui/button";
 
export function App() {
return <Button>Start conversation</Button>;
}

Reference

Browse by category. Every entry has a live preview; component pages add an API table, and block pages include the full source.

Primitives

32

The building blocks: chat, streaming, markdown, code, and loading states.

Hooks

1

Headless state for sending, streaming, stopping, and clearing a conversation.

Blocks

14

Pre-composed surfaces that combine primitives into complete UI regions.

Compose primitives

12

The context, shell, and controls behind the 15 provider stage clones.

Provider composes

15

Copy-paste provider blocks, assembled from Agent UI compose primitives.

Frequently asked questions

How do I install Agent UI?

For standalone apps, initialize shadcn/ui and add a component from the Agent UI registry. Within the monorepo, use the @agent-ui/react workspace package with Tailwind CSS v4 source scanning. Package publication is a separate release step.

Does Agent UI work with Tailwind CSS v4?

Yes. All components ship as Tailwind utility classes with no runtime CSS-in-JS. Add @source "../node_modules/@agent-ui/react/src" (or the workspace path) to your global stylesheet so Tailwind emits the classes the library uses.

Does Agent UI support streaming AI responses?

Yes. useChat exposes isStreaming, stop, and error state; ChatShell renders a typing indicator and stop button; StreamingText reveals tokens with a reduced-motion-safe caret; and ToolCallCard tracks tool status from pending to success or error.

Can I use a single component without adopting the whole library?

Each library component has a direct export path. Basic primitives can also be copied individually through the source registry. Verify bundle output in your application before making size claims.

Which AI providers have compose blocks?

Agent UI ships 15 copy-paste provider compose blocks: OpenAI ChatGPT, Google Gemini, Perplexity, Anthropic Claude, xAI Grok, Mistral Le Chat, DeepSeek, Z.ai GLM, Kimi, MiniMax, Xiaomi MiMo, Cohere Coral, Meta AI, Microsoft Copilot, and Alibaba Qwen.

Machine-readable index: /llms.txt · sitemap.xml