@ag-ui/proto

Agent User Interaction Protocol

Get started with the Agent User Interaction Protocol (AG-UI)

Introduction

Integrations

Understand how AG-UI connects front-end applications to AI agents

Core architecture

Understanding events in the Agent User Interaction Protocol

Events

Learn about agents in the Agent User Interaction Protocol

Agents

Understanding message structure and communication in AG-UI

Messages

Understanding state synchronization between agents and frontends in AG-UI

State Management

Understanding tools and how they enable human-in-the-loop AI workflows

Tools

Use Cursor to build AG-UI implementations faster

Developing with Cursor

A comprehensive guide to debugging Agent User Interaction Protocol (AG-UI) integrations

Debugging

The latest updates and improvements to AG-UI

What's New

Our plans for evolving Agent User Interaction Protocol

Roadmap

How to participate in Agent User Interaction Protocol development

Contributing

@ag-ui/encoder

How to deeply integrate a chatbot into your application

Quickstart: chatbot

How to integrate CopilotTextarea into your application

Quickstart: CopilotTextarea

Quickstart: Copilot Runtime

Give your in-app Copilot skills, via LangChains and LangGraphs

Quickstart In-App Agents (via LangChain and LangGraph)

Customizing the look and feel of CopilotKit

Customize the Look and Feel

Tutorials

Provides the Copilot context to its children.

<CopilotKit />

A context-aware, auto-completing textarea.

<CopilotTextarea />

A chatbot popup component for CopilotKit.

<CopilotPopup />

A chatbot sidebar component for CopilotKit.

<CopilotSidebar />

<CopilotChat />

A hook for providing app-state & other information to the Copilot.

useCopilotReadable

A hook for providing actions the Copilot can call.

useCopilotAction

useCopilotChat

A hook for providing suggestions to the user in the Copilot chat.

useCopilotChatSuggestions

Execute one-off tasks using Copilot intelligence.

CopilotTask

Handles requests from frontend, provides function calling and various LLM backends.

CopilotRuntime

OpenAIAdapter

CopilotKit Adapter for the OpenAI Assistant API.

OpenAIAssistantAdapter

LangChainAdapter

GoogleGenerativeAIAdapter

Learn how open-source anonymous telemetry works in CopilotKit.

Anonymous Telemetry

How To Contribute

Advanced: Package Linking

Documentation Contributions

How to run CopilotKit with Azure OpenAI as a backend

TypeScript

Python

@ag-ui/proto