README.md
A2UI is an open-source project, complete with a format optimized for representing updatable agent-generated UIs and an initial set of renderers, that allows agents to generate or populate rich user interfaces.
A gallery of A2UI rendered cards, showing a variety of UI compositions that A2UI can achieve.
Note: A2UI is currently in v0.8 (Public Preview). The specification and implementations are functional but are still evolving. We are opening the project to foster collaboration, gather feedback, and solicit contributions (e.g., on client renderers). Expect changes.
Generative AI excels at creating text and code, but agents can struggle to present rich, interactive interfaces to users, especially when those agents are remote or running across trust boundaries.
A2UI is an open standard and set of libraries that allows agents to "speak UI." Agents send a declarative JSON format describing the intent of the UI. The client application then renders this using its own native component library (Flutter, Angular, Lit, etc.).
This approach ensures that agent-generated UIs are safe like data, but expressive like code.
A2UI was designed to address the specific challenges of interoperable, cross-platform, generative or template-based UI responses from agents.
The project's core philosophies:
Some of the use cases include:
The A2UI flow disconnects the generation of UI from the execution of UI:
A2UI Response, a JSON payload describing the composition
of UI components and their properties.type: 'text-field') to the concrete implementation in the client's codebase.A2UI is designed to be a lightweight format, but it fits into a larger ecosystem:
The best way to understand A2UI is to run the samples.
Clone the repository:
git clone https://github.com/google/A2UI.git
cd A2UI
Set your API key:
export GEMINI_API_KEY="your_gemini_api_key"
Run the Agent (Backend):
cd samples/agent/adk/restaurant_finder
uv run .
Run the Client (Frontend): Open a new terminal window:
# Install and build the Markdown renderer
cd renderers/markdown/markdown-it
npm install
npm run build
# Install and build the Web Core library
cd ../../web_core
npm install
npm run build
# Install and build the Lit renderer
cd ../lit
npm install
npm run build
# Install and run the shell client
cd ../../samples/client/lit/shell
npm install
npm run dev
For Flutter developers, check out the GenUI SDK, which uses A2UI under the hood.
CopilotKit has a public A2UI Widget Builder to try out as well.
We hope to work with the community on the following:
A2UI is an Apache 2.0 licensed project. We believe the future of UI is agentic, and we want to work with you to help build it.
See CONTRIBUTING.md for details on how to get started.