llms.txt
Compare with other sites' llms.txt files →# OpenUI
> Full-stack, framework-agnostic Generative UI built on OpenUI Lang, a streaming-first language with first-party runtimes for React, Vue, Svelte, and Angular, and up to 67% fewer tokens than JSON.
## Project
- [OpenUI website](https://www.openui.com/): Canonical OpenUI website.
- [OpenUI source repository](https://github.com/thesysdev/openui): Source code and releases.
## Documentation
- [Autofix API](https://www.openui.com/docs/autofix.mdx): Fix invalid OpenUI Lang from any model with one API call. Canonical source: https://www.openui.com/docs/autofix
- [Deploy your app](https://www.openui.com/docs/deploy.mdx): Deploy an OpenUI app to Vercel with the OpenUI CLI. Canonical source: https://www.openui.com/docs/deploy
- [Getting Started](https://www.openui.com/docs/getting-started.mdx): Create a new OpenUI application or add OpenUI to an existing agent. Canonical source: https://www.openui.com/docs/getting-started
- [Introduction](https://www.openui.com/docs.mdx): Learn to build Generative UI with OpenUI. Define your components, generate OpenUI Lang with any model, and render it as it streams. Canonical source: https://www.openui.com/docs
- [OpenUI in production](https://www.openui.com/docs/production.mdx): Track generation failures, fix invalid OpenUI Lang, and keep model requests working in production. Canonical source: https://www.openui.com/docs/production
- [@openuidev/a2ui](https://www.openui.com/docs/api-reference/a2ui.mdx): A2UI v1.0 protocol support with OpenUI Lang component updates and an optional React renderer. Canonical source: https://www.openui.com/docs/api-reference/a2ui
- [@openuidev/angular-lang](https://www.openui.com/docs/api-reference/angular-lang.mdx): API reference for Angular component libraries, streaming rendering, actions, state, and validation. Canonical source: https://www.openui.com/docs/api-reference/angular-lang
- [@openuidev/assistant-ui](https://www.openui.com/docs/api-reference/assistant-ui.mdx): API reference for rendering OpenUI Lang tool calls in assistant-ui applications. Canonical source: https://www.openui.com/docs/api-reference/assistant-ui
- [@openuidev/cli](https://www.openui.com/docs/api-reference/cli.mdx): API reference for the OpenUI CLI to scaffold apps, mint Gateway API keys, generate system prompts or library specs, and deploy projects. Canonical source: https://www.openui.com/docs/api-reference/cli
- [@openuidev/devtools](https://www.openui.com/docs/api-reference/devtools.mdx): API reference for the development-only devtools widget. Canonical source: https://www.openui.com/docs/api-reference/devtools
- [API Reference](https://www.openui.com/docs/api-reference.mdx): Reference for every OpenUI package, grouped by what it does. Canonical source: https://www.openui.com/docs/api-reference
- [@openuidev/langchain](https://www.openui.com/docs/api-reference/langchain.mdx): API reference for streaming LangChain and LangGraph agents to OpenUI over AG-UI. Canonical source: https://www.openui.com/docs/api-reference/langchain
- [@openuidev/react-email](https://www.openui.com/docs/api-reference/react-email.mdx): API reference for the pre-built email templates library and prompt options. Canonical source: https://www.openui.com/docs/api-reference/react-email
- [@openuidev/react-headless](https://www.openui.com/docs/api-reference/react-headless.mdx): API reference for chat state, hooks, streaming adapters, and message types. Canonical source: https://www.openui.com/docs/api-reference/react-headless
- [@openuidev/react-lang](https://www.openui.com/docs/api-reference/react-lang.mdx): API reference for the OpenUI Lang runtime, library, parser, and renderer. Canonical source: https://www.openui.com/docs/api-reference/react-lang
- [@openuidev/react-ui](https://www.openui.com/docs/api-reference/react-ui.mdx): API reference for the AgentInterface chat surface and default component library exports. Canonical source: https://www.openui.com/docs/api-reference/react-ui
- [@openuidev/server](https://www.openui.com/docs/api-reference/server.mdx): API reference for Autofix helpers and conversation history persistence on the OpenUI Gateway. Canonical source: https://www.openui.com/docs/api-reference/server
- [@openuidev/svelte-lang](https://www.openui.com/docs/api-reference/svelte-lang.mdx): API reference for Svelte 5 component libraries, streaming rendering, actions, form state, and validation. Canonical source: https://www.openui.com/docs/api-reference/svelte-lang
- [@openuidev/vue-lang](https://www.openui.com/docs/api-reference/vue-lang.mdx): API reference for Vue 3 component libraries, streaming rendering, actions, state, queries, and validation. Canonical source: https://www.openui.com/docs/api-reference/vue-lang
- [assistant-ui](https://www.openui.com/docs/build-agents/assistant-ui.mdx): Render OpenUI Lang in an existing assistant-ui chat. Canonical source: https://www.openui.com/docs/build-agents/assistant-ui
- [Choose a chat UI](https://www.openui.com/docs/build-agents/chat-ui.mdx): Compare the chat UIs that can render OpenUI Lang and pick one for your agent. Canonical source: https://www.openui.com/docs/build-agents/chat-ui
- [Conversation history](https://www.openui.com/docs/build-agents/conversation-history.mdx): Send earlier turns, tool results, and user actions back to the model. Canonical source: https://www.openui.com/docs/build-agents/conversation-history
- [CopilotKit](https://www.openui.com/docs/build-agents/copilotkit.mdx): Render OpenUI Lang in an existing CopilotKit chat. Canonical source: https://www.openui.com/docs/build-agents/copilotkit
- [Custom chat UI](https://www.openui.com/docs/build-agents/custom-chat-ui.mdx): Render OpenUI Lang in a chat interface you built yourself. Canonical source: https://www.openui.com/docs/build-agents/custom-chat-ui
- [How it works](https://www.openui.com/docs/build-agents/how-it-works.mdx): What happens in one turn of an agent that responds with OpenUI Lang. Canonical source: https://www.openui.com/docs/build-agents/how-it-works
- [Overview](https://www.openui.com/docs/build-agents.mdx): Build agents that respond with interactive interfaces made from your components. Canonical source: https://www.openui.com/docs/build-agents
- [Tools: agent-side vs. UI-side](https://www.openui.com/docs/build-agents/tools.mdx): Fetch data in the agent before it responds, or let the generated UI fetch it live. Canonical source: https://www.openui.com/docs/build-agents/tools
- [Set up UI generation](https://www.openui.com/docs/build-agents/ui-generation.mdx): Configure an agent backend to respond with OpenUI Lang built from your components. Canonical source: https://www.openui.com/docs/build-agents/ui-generation
- [Booking assistant](https://www.openui.com/cookbooks/booking-assistant.mdx): Build a chat assistant that turns a request for a stay into a prefilled form, searches live hotel prices through trivago's MCP server, and reviews the stay before booking. Canonical source: https://www.openui.com/cookbooks/booking-assistant
- [Conversational analytics](https://www.openui.com/cookbooks/conversational-analytics.mdx): Build a chat assistant that answers questions about Formula 1 lap times with live charts and tables. Canonical source: https://www.openui.com/cookbooks/conversational-analytics
- [Document comparison](https://www.openui.com/cookbooks/document-comparison.mdx): Build a chat assistant that compares stocks (NVIDIA, AMD, and Intel) annual reports with page-cited tables and charts. Canonical source: https://www.openui.com/cookbooks/document-comparison
- [Demos](https://www.openui.com/demos.mdx): OpenUI Playgrounds, featured projects & contributions from the community. Canonical source: https://www.openui.com/demos
- [Add to your agent](https://www.openui.com/docs/dashboards/add-to-your-agent.mdx): Give an agent create_dashboard and edit_dashboard tools, and render their results in the chat. Canonical source: https://www.openui.com/docs/dashboards/add-to-your-agent
- [Authentication](https://www.openui.com/docs/dashboards/authentication.mdx): Set up the API key on the server and a per-user frontend token in the browser. Canonical source: https://www.openui.com/docs/dashboards/authentication
- [Connect data](https://www.openui.com/docs/dashboards/connect-data.mdx): Define the data tools dashboards call, connect MCP servers, and run queries through an interpreter route. Canonical source: https://www.openui.com/docs/dashboards/connect-data
- [Define dashboards](https://www.openui.com/docs/dashboards/define-dashboards.mdx): Choose the component library, the model, and the data tools that every dashboard is built from. Canonical source: https://www.openui.com/docs/dashboards/define-dashboards
- [Edit a dashboard](https://www.openui.com/docs/dashboards/edit.mdx): Change a saved dashboard in place with dashboards.edit. Canonical source: https://www.openui.com/docs/dashboards/edit
- [Generate a dashboard](https://www.openui.com/docs/dashboards/generate.mdx): Create a dashboard from a title and a prompt with dashboards.create. Canonical source: https://www.openui.com/docs/dashboards/generate
- [How it works](https://www.openui.com/docs/dashboards/how-it-works.mdx): How a dashboard is generated, loads its data, and changes with an edit. Canonical source: https://www.openui.com/docs/dashboards/how-it-works
- [Overview](https://www.openui.com/docs/dashboards.mdx): Live dashboards that an agent generates from a prompt and that load fresh data every time they open. Canonical source: https://www.openui.com/docs/dashboards
- [List dashboards](https://www.openui.com/docs/dashboards/list.mdx): Show the user's saved dashboards with useArtifactList, and pin, unpin, rename, delete, and open them. Canonical source: https://www.openui.com/docs/dashboards/list
- [Quick Start](https://www.openui.com/docs/dashboards/quickstart.mdx): Run a chat app that builds live dashboards about npm packages and GitHub repositories. Canonical source: https://www.openui.com/docs/dashboards/quickstart
- [Render a dashboard](https://www.openui.com/docs/dashboards/render.mdx): Show a dashboard with LiveArtifactRenderer, from a tool response or an id. Canonical source: https://www.openui.com/docs/dashboards/render
- [Authentication](https://www.openui.com/docs/gateway/authentication.mdx): Authenticate server-side generation and scoped browser access to Gateway conversations. Canonical source: https://www.openui.com/docs/gateway/authentication
- [BYOK](https://www.openui.com/docs/gateway/byok.mdx): Route Gateway requests through your own OpenAI, Anthropic, or Google provider key. Canonical source: https://www.openui.com/docs/gateway/byok
- [Generative UI Quickstart](https://www.openui.com/docs/gateway/generate-openui-lang.mdx): Generate validated OpenUI Lang through OpenUI Gateway. Canonical source: https://www.openui.com/docs/gateway/generate-openui-lang
- [Introduction](https://www.openui.com/docs/gateway.mdx): Access models across providers with automatic failover and correction for generated interfaces. Canonical source: https://www.openui.com/docs/gateway
- [Migrate to OpenUI Gateway](https://www.openui.com/docs/gateway/migrate-to-openui-gateway.mdx): Move an existing OpenAI-compatible application to Gateway with minimal changes. Canonical source: https://www.openui.com/docs/gateway/migrate-to-openui-gateway
- [Models](https://www.openui.com/docs/gateway/models.mdx): Find and use model identifiers supported by OpenUI Gateway. Canonical source: https://www.openui.com/docs/gateway/models
- [Pricing](https://www.openui.com/docs/gateway/pricing-credits.mdx): Understand Gateway plans, API call charges, model usage, and BYOK. Canonical source: https://www.openui.com/docs/gateway/pricing-credits
- [Prompt Caching](https://www.openui.com/docs/gateway/prompt-caching.mdx): Reuse stable prompt prefixes to reduce model costs and response latency. Canonical source: https://www.openui.com/docs/gateway/prompt-caching
- [Reliability](https://www.openui.com/docs/gateway/reliability.mdx): Keep model requests working when providers are unavailable or models return invalid OpenUI Lang. Canonical source: https://www.openui.com/docs/gateway/reliability
- [Integrations](https://www.openui.com/docs/integrations.mdx): Examples and libraries that connect OpenUI to the frameworks and tools you already use. Canonical source: https://www.openui.com/docs/integrations
- [Coding Agent Setup](https://www.openui.com/docs/mcp.mdx): Connect OpenUI documentation to your AI coding tools via MCP, agent skills, or LLM-friendly doc formats. Canonical source: https://www.openui.com/docs/mcp
- [Dashboard](https://www.openui.com/docs/reliability/dashboard.mdx): Find recurring OpenUI errors and inspect affected generations in Reliability Monitoring. Canonical source: https://www.openui.com/docs/reliability/dashboard
- [Reliability Monitoring](https://www.openui.com/docs/reliability.mdx): Find and understand OpenUI generation and rendering errors across production traffic. Canonical source: https://www.openui.com/docs/reliability
- [Setup](https://www.openui.com/docs/reliability/installation.mdx): Enable reliability tracking through Gateway, Autofix, or the Observability SDK. Canonical source: https://www.openui.com/docs/reliability/installation
- [Improve reliability](https://www.openui.com/docs/reliability/optimizing.mdx): Turn recurring runtime errors into focused improvements to components, prompts, and model selection. Canonical source: https://www.openui.com/docs/reliability/optimizing
- [Actions](https://www.openui.com/docs/openui-lang/actions.mdx): Write one action or several in Action([...]), define custom actions, and handle them in your app. Canonical source: https://www.openui.com/docs/openui-lang/actions
- [Architecture](https://www.openui.com/docs/openui-lang/architecture.mdx): Build dashboards, CRUD interfaces, and monitoring tools. The LLM generates the UI once, then your app runs independently. Canonical source: https://www.openui.com/docs/openui-lang/architecture
- [Benchmarks](https://www.openui.com/docs/openui-lang/benchmarks.mdx): Token efficiency and latency comparison of OpenUI Lang vs YAML, Vercel JSON-Render, and Thesys C1 JSON. Canonical source: https://www.openui.com/docs/openui-lang/benchmarks
- [OpenUI vs A2UI vs json-render vs OpenGenerativeUI](https://www.openui.com/docs/openui-lang/comparison.mdx): OpenUI vs json-render (Vercel), A2UI (Google), and CopilotKit OpenGenerativeUI. Canonical source: https://www.openui.com/docs/openui-lang/comparison
- [Defining Components](https://www.openui.com/docs/openui-lang/defining-components.mdx): Define OpenUI components with Zod and React renderers. Canonical source: https://www.openui.com/docs/openui-lang/defining-components
- [Developer Tools](https://www.openui.com/docs/openui-lang/developer-tools.mdx): Use Inspect and Debug in development to watch streams, catch errors, and try OpenUI Lang against your own components. Canonical source: https://www.openui.com/docs/openui-lang/developer-tools
- [Evolution Guide](https://www.openui.com/docs/openui-lang/evolution-guide.mdx): How OpenUI Lang evolved from static UI generation to interactive, data-driven apps. Canonical source: https://www.openui.com/docs/openui-lang/evolution-guide
- [Functions](https://www.openui.com/docs/openui-lang/functions.mdx): Call built-in and custom @ functions, and define your own with defineFunction. Canonical source: https://www.openui.com/docs/openui-lang/functions
- [Incremental Editing](https://www.openui.com/docs/openui-lang/incremental-editing.mdx): Edit an existing UI by sending only what changed. The model writes a patch, mergeStatements merges it by name. Canonical source: https://www.openui.com/docs/openui-lang/incremental-editing
- [Introduction](https://www.openui.com/docs/openui-lang.mdx): A streaming-first language that models use to build interfaces from your components, in up to 67% fewer tokens than JSON. Canonical source: https://www.openui.com/docs/openui-lang
- [Interactivity](https://www.openui.com/docs/openui-lang/interactivity.mdx): Handle actions, forms, and state in OpenUI components. Canonical source: https://www.openui.com/docs/openui-lang/interactivity
- [Message Protocol](https://www.openui.com/docs/openui-lang/message-protocol.mdx): Store a response and show it again later, with form values kept, using buildMessage and parseMessage. Canonical source: https://www.openui.com/docs/openui-lang/message-protocol
- [Overview](https://www.openui.com/docs/openui-lang/overview.mdx): Understand the language, prompt, parser, and renderer that turn model output into application UI. Canonical source: https://www.openui.com/docs/openui-lang/overview
- [Patterns](https://www.openui.com/docs/openui-lang/patterns.mdx): Complete examples showing how Query, $variables, @builtins, and actions compose together. Canonical source: https://www.openui.com/docs/openui-lang/patterns
- [Prompts](https://www.openui.com/docs/openui-lang/prompts.mdx): Legacy prompt page kept for compatibility; use System Prompts. Canonical source: https://www.openui.com/docs/openui-lang/prompts
- [Queries & Mutations](https://www.openui.com/docs/openui-lang/queries-mutations.mdx): Fetch and write data from your tools. The model writes the wiring, the runtime runs it. Canonical source: https://www.openui.com/docs/openui-lang/queries-mutations
- [Quick Start](https://www.openui.com/docs/openui-lang/quickstart.mdx): Build a Recipe Remix agent with OpenUI Gateway in about 10 minutes. Canonical source: https://www.openui.com/docs/openui-lang/quickstart
- [Reactive State](https://www.openui.com/docs/openui-lang/reactive-state.mdx): Keep UI state in $variables so the generated UI updates without another model call when the user changes something. Canonical source: https://www.openui.com/docs/openui-lang/reactive-state
- [Reliability](https://www.openui.com/docs/openui-lang/reliability.mdx): Build reliable LLM-generated interfaces by measuring, reducing, and correcting generation errors. Canonical source: https://www.openui.com/docs/openui-lang/reliability
- [The Renderer](https://www.openui.com/docs/openui-lang/renderer.mdx): Parse and render OpenUI Lang streams in React. Canonical source: https://www.openui.com/docs/openui-lang/renderer
- [OpenUI Lang Syntax](https://www.openui.com/docs/openui-lang/syntax.mdx): Expression grammar and common component signatures. Canonical source: https://www.openui.com/docs/openui-lang/syntax
- [System Prompts](https://www.openui.com/docs/openui-lang/system-prompts.mdx): Generate and customize prompt instructions from your OpenUI library. Canonical source: https://www.openui.com/docs/openui-lang/system-prompts
- [Telemetry](https://www.openui.com/docs/openui-lang/telemetry.mdx): What OpenUI Lang collects, why it is collected, and how to control installation and runtime telemetry. Canonical source: https://www.openui.com/docs/openui-lang/telemetry
- [Troubleshooting](https://www.openui.com/docs/openui-lang/troubleshooting.mdx): Common issues and fixes when working with OpenUI Lang and the Renderer. Canonical source: https://www.openui.com/docs/openui-lang/troubleshooting
- [What's New in 1.0](https://www.openui.com/docs/openui-lang/whats-new.mdx): Custom functions and actions, actions without a wrapper, library.extend, and the message format. Canonical source: https://www.openui.com/docs/openui-lang/whats-new
- [Artifacts](https://www.openui.com/docs/agent/core-concepts/artifacts.mdx): Durable, first-class conversation outputs like slides, reports, and apps that the user can open and return to. Canonical source: https://www.openui.com/docs/agent/core-concepts/artifacts
- [Conversations](https://www.openui.com/docs/agent/core-concepts/conversations.mdx): How to persist conversations and make them accessible to Agent Interface. Canonical source: https://www.openui.com/docs/agent/core-concepts/conversations
- [Generative UI](https://www.openui.com/docs/agent/core-concepts/gene