Agents UI components | LiveKit Documentation
Key Points
- 1Agents UI is a component library built on Shadcn and AI Elements designed to accelerate the creation of agentic applications powered by LiveKit's real-time platform.
- 2Installed via the Shadcn CLI, it provides pre-built, customizable components categorized for media controls, audio visualization, and chat, enhancing real-time agent interactions.
- 3This library complements LiveKit's broader ecosystem, which also offers component SDKs for React, Swift, Android, and Flutter to support diverse real-time audio and video applications.
Agents UI is a component library designed to expedite the development of agentic applications leveraging LiveKit's real-time platform. Built upon Shadcn and AI Elements, it offers pre-constructed user interface components for common functionalities required in agent-driven systems.
The library provides components for granular control over input/output (IO), comprehensive session management, rendering real-time conversation transcripts, and visualizing audio streams. Specific component functionalities include:
- Media controls: Components such as
AgentControlBar,AgentTrackControl,AgentTrackToggle,AgentDisconnectButton, andStartAudioButtonare included to provide users with direct control over microphone access, camera feeds, session disconnection, and browser audio playback. - Audio visualizer: This category encompasses components like
AgentAudioVisualizerBar,Grid,Radial,Wave, andAura. These enable the creation of animated visual representations for voice agents, dynamically driven by audio data and the agent's current state. - Chat components: Components such as
AgentChatTranscriptandAgentChatIndicatorfacilitate the display of real-time conversation transcripts, text messages, and typing indicators within the application.
Installation of Agents UI components is managed via the Shadcn CLI. The process involves first initializing Shadcn within a project using npx shadcn@latest init, followed by adding the Agents UI registry using npx shadcn@latest registry add @agents-ui. Individual components are then installed by specifying their names, for example, npx shadcn@latest add @agents-ui/{component-name}. Upon installation, the full source code for each component becomes available within the project's components/agents-ui directory, allowing for extensive customization.
A complete reference documentation for Agents UI components is available, and the open-source component code is hosted on GitHub. Beyond Agents UI, LiveKit also offers other component SDKs for various frameworks, though these are not agent-specific. These include low-level React components and hooks for real-time audio/video, SwiftUI components for iOS, macOS, visionOS, and tvOS, Jetpack Compose components for Android with Material Design, and Flutter widgets for cross-platform mobile and desktop applications.