Back to Copilotkit

CopilotKit Architecture Guide

dev-docs/architecture/ARCHITECTURE.md

1.57.013.7 KB
Original Source

CopilotKit Architecture Guide

CopilotKit lets you add AI agents to your app. You write hooks (React/Angular) or use the core API (vanilla JS), CopilotKit handles the rest — connecting your UI to any AI agent framework.


The 30-Second Version

mermaid
graph TB
    subgraph Your App
        A[React / Angular / Vanilla JS]
    end

    subgraph Your Server
        B[CopilotKit Runtime]
    end

    subgraph Any Agent Framework
        C[LangGraph / CrewAI / Mastra / Custom]
    end

    A -->|HTTP POST| B
    B -->|AG-UI Events| C
    C -->|AG-UI Events| B
    B -->|SSE Stream| A

That's it. Your app talks to a runtime on your server. The runtime talks to an AI agent. They communicate using AG-UI — an event-based protocol (think: "text is streaming", "agent wants to call a tool", "state changed").


The Three Layers

Layer 1: Frontend (your app)

You use hooks/services to wire up your app — registering tools agents can call, providing context, and getting agent instances.

Layer 2: Runtime (your server)

A few lines create the backend that receives requests from the frontend, runs agents, and streams events back.

Layer 3: Agent (any framework)

The agent is anything that speaks AG-UI protocol. CopilotKit has integrations for 13+ frameworks, or you build your own.


How a Message Flows Through the System

mermaid
sequenceDiagram
    participant User
    participant App as Your App
    participant Core as CopilotKitCore
    participant Runtime as CopilotRuntime
    participant Agent as AI Agent

    Note over App: Setup (on mount)
    App->>Core: Provider creates Core
    Core->>Runtime: GET /info (fetch agent list)
    Runtime-->>Core: [{ name, description }]
    App->>Core: Hooks register tools + context

    Note over User: User sends message
    User->>App: Types message, hits send
    App->>Core: Gets agent instance
    Core->>Runtime: POST /agent/{id}/run
    Runtime->>Agent: AgentRunner.run()

    Note over Agent: Events stream back
    Agent-->>Runtime: TEXT_MESSAGE_START
    Agent-->>Runtime: TEXT_MESSAGE_CONTENT (streaming)
    Agent-->>Runtime: TEXT_MESSAGE_END
    Runtime-->>Core: SSE event stream
    Core-->>App: Subscribers fire, UI re-renders
    App-->>User: Chat shows streaming response

    Note over Agent: Tool call (optional)
    Agent-->>Runtime: TOOL_CALL_START + ARGS
    Runtime-->>Core: SSE events
    Core->>Core: Execute frontend tool
    Core-->>Runtime: TOOL_CALL_RESULT
    Runtime->>Agent: Agent continues
    Agent-->>Runtime: RUN_FINISHED

Guides

GuideWhat you'll learn
React SetupProvider, hooks, chat UI — full React integration
Angular SetupDI tokens, services, signals — full Angular integration
Vanilla JS SetupCopilotKitCore API without any framework
Runtime / BackendExpress/Hono endpoints, agents, runners, middleware
Multi-Agent PatternsMultiple agents, routing, agent-specific tools
Pluggable ArchitectureEvery optional extension point with diagrams

Package Dependency Map

mermaid
graph BT
    subgraph AG-UI Protocol
        core["@ag-ui/core
<i>Types + Event schemas</i>"]
        client["@ag-ui/client
<i>AbstractAgent, HttpAgent, Middleware</i>"]
        encoder["@ag-ui/encoder
<i>SSE / Binary / Protobuf encoding</i>"]
        client --> core
        encoder --> core
    end

    subgraph CopilotKit Packages
        shared["@copilotkit/shared
<i>Utils, types, constants</i>"]
        core["@copilotkit/core
<i>CopilotKitCore orchestrator</i>"]
        reactcore["@copilotkit/react-core
<i>Provider + hooks</i>"]
        reactui["@copilotkit/react-ui
<i>Chat, Popup, Sidebar</i>"]
        reacttextarea["@copilotkit/react-textarea
<i>AI text editing</i>"]
        gql["@copilotkit/runtime-client-gql
<i>urql GraphQL client</i>"]
        runtime["@copilotkit/runtime
<i>Express/Hono server + AgentRunner + Built-in agent</i>"]

        core --> shared
        reactcore --> core
        reactcore --> gql
        reactui --> reactcore
        reacttextarea --> reactcore
        runtime --> shared
        reactcore -.-> client
        gql --> shared
    end

AG-UI Protocol at a Glance

AG-UI is the communication contract between agents and UIs. Everything is an event streamed over SSE.

mermaid
graph LR
    subgraph Lifecycle
        RS[RUN_STARTED] --> SS[STEP_STARTED]
        SF[STEP_FINISHED] --> RF[RUN_FINISHED]
    end

    subgraph Text
        TMS[TEXT_MESSAGE_START] --> TMC[TEXT_MESSAGE_CONTENT]
        TMC --> TME[TEXT_MESSAGE_END]
    end

    subgraph Tools
        TCS[TOOL_CALL_START] --> TCA[TOOL_CALL_ARGS]
        TCA --> TCE[TOOL_CALL_END]
        TCE --> TCR[TOOL_CALL_RESULT]
    end

    subgraph State
        SNP[STATE_SNAPSHOT]
        SD[STATE_DELTA]
    end

    SS --> TMS
    TME --> TCS
    TCR --> SF
PackageRoleKey exports
@ag-ui/coreThe contract — event types + data shapesEventType enum, Zod schemas, RunAgentInput, Message, Tool
@ag-ui/clientClient-side agent abstractionAbstractAgent, HttpAgent, Middleware, re-exports core
@ag-ui/encoderSerializes events for transportEventEncoder (SSE, binary, protobuf)
@ag-ui/protoProtobuf binary transportencode(), decode()

13+ framework integrations at ag-ui/integrations/: LangGraph, CrewAI, Mastra, Vercel AI SDK, Agno, AWS Strands, LlamaIndex, and more.


Quick Reference

"I want to..." — here's where to look:

Setup & Configuration

GoalPackageKey file / API
Set up a React app@copilotkit/react-core<CopilotKit runtimeUrl="..."> provider
Set up an Angular app@copilotkit/angularprovideCopilotKit({ runtimeUrl }) DI token
Set up vanilla JS@copilotkit/corenew CopilotKitCore({ runtimeUrl })
Set up the backend (Express)@copilotkit/runtimecreateCopilotEndpointExpress({ runtime })
Set up the backend (Hono)@copilotkit/runtimecreateCopilotEndpointHono({ runtime })
Configure authentication headersProvider / Core configheaders: { Authorization: "Bearer ..." }
Forward cookies to runtimeProvider / Core configcredentials: "include"

Agent Communication

GoalPackageKey file / API
Get an agent instance (React)@copilotkit/react-coreuseAgent({ agentId })
Get an agent instance (Angular)@copilotkit/angularAgentStore with signals
Get an agent instance (vanilla)@copilotkit/corecopilotkit.getAgent(id)
Run an agentCore / hookscopilotkit.runAgent({ agent })
Use multiple agentsRuntime configagents: { research: agent1, coding: agent2 }
Agent-specific toolsuseFrontendTool{ name, agentId: "specific-agent", handler }
Shared context for all agentsuseAgentContextuseAgentContext("desc", value)

Tools & Interactivity

GoalPackageKey file / API
Register a tool agents can callreact-core or reactuseFrontendTool({ name, parameters, handler })
Give agents context datareact-core or reactuseCopilotReadable() / useAgentContext()
Share state with an agent (V1)@copilotkit/react-coreuseCoAgent({ name, initialState })
Custom UI for tool executionProvider or hookrenderToolCalls / useRenderToolCall()
Require human approvalProvider or hookhumanInTheLoop / useHumanInTheLoop()
Auto-generate suggestionsHookuseConfigureSuggestions({ instructions })
Inject system instructions (V1)@copilotkit/react-coreuseCopilotAdditionalInstructions()

UI Components

GoalPackageComponent
Full chat interface@copilotkit/react-ui<CopilotChat>
Floating popup chat@copilotkit/react-ui<CopilotPopup>
Side panel chat@copilotkit/react-ui<CopilotSidebar>
Inline panel chat@copilotkit/react-ui<CopilotPanel>
AI text autocompletion@copilotkit/react-textarea<CopilotTextarea>

Backend & Runtime

GoalPackageKey file / API
Custom agent runner@copilotkit/runtimeExtend AgentRunner abstract class
Persistent agent state@copilotkit/sqlite-runnerSQLiteAgentRunner
Request/response middlewareCopilotRuntime optionsbeforeRequestMiddleware / afterRequestMiddleware
Audio transcriptionCopilotRuntime optionstranscriptionService
Voice (speech-to-text / TTS)@copilotkit/voiceVoice services
Build a custom agent@copilotkit/sdk-jsLangGraph / LangChain helpers

Debugging & Internals

GoalPackageKey file / API
Understand event types@ag-ui/coresrc/events.tsEventType enum
Understand the agent abstraction@ag-ui/clientsrc/agent/agent.tsAbstractAgent
See how an integration worksag-ui/integrations/{framework}/Each extends AbstractAgent
Understand the core orchestrator@copilotkit/coresrc/core/core.tsCopilotKitCore
Debug agent interactions@copilotkit/web-inspectorLit web component, enabled via showDevConsole
Subscribe to lifecycle eventsCore APIcopilotkit.subscribe({ onError, onToolExecutionStart, ... })

Monorepo Structure

cpk/
├── ag-ui/                          # AG-UI Protocol (open standard)
│   ├── sdks/typescript/packages/
│   │   ├── core/                   # @ag-ui/core — types + events
│   │   ├── client/                 # @ag-ui/client — AbstractAgent, HttpAgent
│   │   ├── encoder/                # @ag-ui/encoder — SSE/binary encoding
│   │   └── proto/                  # @ag-ui/proto — protobuf
│   └── integrations/               # 13+ framework adapters
│       ├── langgraph/
│       ├── crewai/
│       ├── mastra/
│       └── ...
│
└── CopilotKit/                     # CopilotKit Product
    └── packages/                   # All packages flat under @copilotkit/ scope
        ├── shared/                 # @copilotkit/shared — utils, types, constants
        ├── core/                   # @copilotkit/core — CopilotKitCore orchestrator
        ├── react-core/             # @copilotkit/react-core — provider + hooks
        ├── react-ui/               # @copilotkit/react-ui — chat components
        ├── react-textarea/         # @copilotkit/react-textarea — AI text editing
        ├── runtime/                # @copilotkit/runtime — Express/Hono server + AgentRunner + Built-in agent
        ├── runtime-client-gql/     # @copilotkit/runtime-client-gql — urql GraphQL client
        ├── angular/                # @copilotkit/angular — Angular integration
        ├── voice/                  # @copilotkit/voice — voice support
        ├── web-inspector/          # @copilotkit/web-inspector — debug console
        ├── sqlite-runner/          # @copilotkit/sqlite-runner — persistent AgentRunner
        └── sdk-js/                 # @copilotkit/sdk-js — LangGraph/LangChain helpers