Overview
Reference documentation for the CopilotKit SDKs. Pick the SDK you're building with, then browse its components, hooks, classes, and types.
Choose your SDK
UI Components
<CopilotChat />
High-level chat component that connects an agent to a chat view
<CopilotChatAssistantMessage />
Component for displaying assistant messages with Markdown, tool calls, and an action toolbar
<CopilotChatInput />
Primary text input and control surface for chat interactions
<CopilotChatMessageView />
Component for rendering a list of chat messages
<CopilotChatUserMessage />
Component for displaying user-authored messages with branch navigation
<CopilotChatView />
Layout component that combines a scrollable transcript with the input area
<CopilotKit />
The CopilotKit provider component, wrapping your application.
<CopilotPopup />
Popup variant of CopilotChat that renders in a floating panel with a toggle button
<CopilotSidebar />
Sidebar variant of CopilotChat that renders in a fixed side panel
Hooks
useAgent()
React hook for accessing AG-UI agent instances
useAgentContext()
React hook for providing dynamic context to agents
useCapabilities()
React hook for reading an agent's declared capabilities
useComponent()
Register a React component as a frontend tool renderer in chat
useConfigureSuggestions()
React hook for configuring chat suggestions
useCopilotChatConfiguration()
React hook and provider for chat UI configuration and labels
useCopilotKit()
Low-level React hook for accessing the CopilotKit context
useDefaultRenderTool()
Register a wildcard default renderer for unhandled tool calls
useFrontendTool()
React hook for registering client-side tool handlers with optional UI rendering
useHumanInTheLoop()
React hook for interactive tools that pause agent execution and wait for user input
useInterrupt()
React hook for handling agent interrupt events and resuming execution with user input
useRenderTool()
Register typed renderers for tool calls, by tool name or wildcard
useRenderToolCall()
React hook that returns a renderer function for tool calls in the chat interface
useSuggestions()
React hook for accessing chat suggestions
useThreads()
React hook for listing, managing, and syncing conversation threads with useThreads — rename, archive, delete, and paginate threads with realtime updates via WebSocket.
SDKs
LangGraph SDK
The CopilotKit LangGraph SDK for JavaScript allows you to build and run LangGraph workflows with CopilotKit.
CrewAI SDK
The CopilotKit CrewAI SDK for Python allows you to build and run CrewAI agents with CopilotKit.
CrewAIAgent
CrewAIAgent lets you define your agent for use with CopilotKit.
LangGraph SDK
The CopilotKit LangGraph SDK for Python allows you to build and run LangGraph workflows with CopilotKit.
LangGraphAGUIAgent
LangGraphAGUIAgent lets you define your agent for use with CopilotKit.
Remote Endpoints
CopilotKit Remote Endpoints allow you to connect actions and agents written in Python to your CopilotKit application.