ContextQMD
Back to Copilotkit

CopilotKit v1 Deprecation Map

skills/copilotkit-upgrade/references/deprecation-map.md

1.62.120.4 KB
Original Source

CopilotKit v1 Deprecation Map

Complete mapping of every deprecated v1 API to its v2 replacement.

Hooks

v1 Hookv1 Packagev2 Replacementv2 PackageStatus
useCopilotAction@copilotkit/react-coreuseFrontendTool@copilotkit/react-core/v2Renamed + new parameter format (Zod)
useCopilotReadable@copilotkit/react-coreuseAgentContext@copilotkit/react-core/v2Renamed, parentId removed
useCopilotChat@copilotkit/react-coreuseAgent@copilotkit/react-core/v2Replaced (different API)
useCoAgent@copilotkit/react-coreuseAgent@copilotkit/react-core/v2Renamed, different return type
useCoAgentStateRender@copilotkit/react-coreuseRenderTool / useRenderActivityMessage@copilotkit/react-core/v2Split: render-by-name + activity rendering
useLangGraphInterrupt@copilotkit/react-coreuseInterrupt@copilotkit/react-core/v2Renamed + new API
useCopilotChatSuggestions@copilotkit/react-coreuseConfigureSuggestions + useSuggestions@copilotkit/react-core/v2Split into two hooks
useCopilotAdditionalInstructions@copilotkit/react-coreuseAgentContext@copilotkit/react-core/v2Use description/value context
useMakeCopilotDocumentReadable@copilotkit/react-coreuseAgentContext@copilotkit/react-core/v2Pass content directly
useCopilotRuntimeClient@copilotkit/react-coreuseCopilotKit@copilotkit/react-core/v2/contextAccess core via provider context
useCopilotContext@copilotkit/react-coreuseCopilotKit@copilotkit/react-core/v2/contextReturns { copilotkit, executingToolCallIds }
useCopilotMessagesContext@copilotkit/react-core----Removed (use agent event stream)
useCoAgentStateRenders@copilotkit/react-core----Removed (context no longer needed)
useCopilotChatInternal@copilotkit/react-core----Internal, removed
useCopilotChatHeadless_c@copilotkit/react-core----Internal, removed
useCopilotAuthenticatedAction_c@copilotkit/react-core----Internal, removed
useFrontendTool@copilotkit/react-coreuseFrontendTool@copilotkit/react-core/v2Same name, import path changes
useHumanInTheLoop@copilotkit/react-coreuseHumanInTheLoop@copilotkit/react-core/v2Same name, import path changes
useRenderToolCall@copilotkit/react-coreuseRenderToolCall@copilotkit/react-core/v2Same name, import path changes
useDefaultTool@copilotkit/react-coreuseDefaultRenderTool (render) / useFrontendTool (handler)@copilotkit/react-core/v2Split: v1's catch-all had a handler; v2 useDefaultRenderTool is render-only
useLazyToolRenderer@copilotkit/react-core----Removed
useChatContext (react-ui)@copilotkit/react-uiuseCopilotChatConfiguration@copilotkit/react-core/v2Renamed

Components

v1 Componentv1 Packagev2 Replacementv2 PackageStatus
CopilotKit@copilotkit/react-coreCopilotKit@copilotkit/react-core/v2Same name, new import path
CopilotChat@copilotkit/react-uiCopilotChat@copilotkit/react-core/v2Same name, new package
CopilotPopup@copilotkit/react-uiCopilotPopup@copilotkit/react-core/v2Same name, new package
CopilotSidebar@copilotkit/react-uiCopilotSidebar@copilotkit/react-core/v2Same name, new package
CopilotTextarea@copilotkit/react-textarea----Removed
CopilotDevConsole@copilotkit/react-uiCopilotKitInspector@copilotkit/react-core/v2Renamed
Markdown@copilotkit/react-ui----Removed -- v2 chat components render markdown internally
AssistantMessage@copilotkit/react-uiCopilotChatAssistantMessage@copilotkit/react-core/v2Renamed
UserMessage@copilotkit/react-uiCopilotChatUserMessage@copilotkit/react-core/v2Renamed
ImageRenderer@copilotkit/react-ui----Removed
RenderSuggestionsList@copilotkit/react-uiCopilotChatSuggestionView@copilotkit/react-core/v2Renamed
RenderSuggestion@copilotkit/react-uiCopilotChatSuggestionPill@copilotkit/react-core/v2Renamed
CoAgentStateRendersProvider@copilotkit/react-core----Removed (no v2 equivalent)
ThreadsProvider@copilotkit/react-coreuseThreads@copilotkit/react-core/v2Provider removed; use the useThreads hook for client-side thread management

Note: @copilotkit/react-core/v2 also exports a CopilotKitProvider component. Do not migrate to it -- it is a functionality subset of CopilotKit (from /v2), which is the compatibility bridge across v1 and v2.

Runtime Classes

v1 Class/Functionv1 Packagev2 Replacementv2 PackageStatus
CopilotRuntime@copilotkit/runtimeCopilotRuntime@copilotkit/runtime/v2Same name, different constructor API
OpenAIAdapter@copilotkit/runtimeBuiltInAgent({ model: "openai/..." })@copilotkit/runtime/v2Removed
AnthropicAdapter@copilotkit/runtimeBuiltInAgent({ model: "anthropic/..." })@copilotkit/runtime/v2Removed
GoogleGenerativeAIAdapter@copilotkit/runtimeBuiltInAgent({ model: "google/..." })@copilotkit/runtime/v2Removed
LangChainAdapter@copilotkit/runtimeCustom AbstractAgent--Removed
GroqAdapter@copilotkit/runtimeCustom AbstractAgent (Groq LanguageModel)--Removed
UnifyAdapter@copilotkit/runtimeCustom AbstractAgent--Removed
OpenAIAssistantAdapter@copilotkit/runtimeCustom AbstractAgent--Removed
BedrockAdapter@copilotkit/runtimeCustom AbstractAgent--Removed
OllamaAdapter (experimental)@copilotkit/runtimeCustom AbstractAgent--Removed
EmptyAdapter@copilotkit/runtime----Removed
RemoteChain@copilotkit/runtime----Removed
LangGraphAgent@copilotkit/runtimeLangGraphAgent@copilotkit/runtime/langgraphMoved to the /langgraph subpath
LangGraphHttpAgent@copilotkit/runtimeLangGraphHttpAgent@copilotkit/runtime/langgraphDistinct class (not merged into LangGraphAgent); moved to the /langgraph subpath

Runtime Framework Integrations

v1 Functionv1 Packagev2 Replacementv2 PackageStatus
copilotRuntimeNextJSAppRouterEndpoint@copilotkit/runtimecreateCopilotHonoHandler@copilotkit/runtime/v2Removed (use Hono; createCopilotEndpoint is a deprecated alias)
copilotRuntimeNextJSPagesRouterEndpoint@copilotkit/runtimecreateCopilotHonoHandler@copilotkit/runtime/v2Removed (use Hono; createCopilotEndpoint is a deprecated alias)
CopilotRuntimeNodeExpressEndpoint@copilotkit/runtimecreateCopilotExpressHandler@copilotkit/runtime/v2/expressRenamed
CopilotRuntimeNestEndpoint@copilotkit/runtimecreateCopilotHonoHandler@copilotkit/runtime/v2Removed (use Hono)
CopilotRuntimeNodeHttpEndpoint@copilotkit/runtimecreateCopilotHonoHandler@copilotkit/runtime/v2Removed (use Hono)

Types

v1 Typev1 Packagev2 Replacementv2 PackageStatus
CopilotKitProps@copilotkit/react-coreCopilotKitProps@copilotkit/react-core/v2Same name, new import path (extends Omit<CopilotKitProviderProps, "children">)
CopilotContextParams@copilotkit/react-coreCopilotKitContextValue@copilotkit/react-core/v2Renamed
FrontendAction@copilotkit/react-coreReactFrontendTool@copilotkit/react-core/v2Renamed + restructured
ActionRenderProps@copilotkit/react-coreReactToolCallRenderer@copilotkit/react-core/v2Renamed + restructured
DocumentPointer@copilotkit/react-core----Removed
SystemMessageFunction@copilotkit/react-core----Removed
CopilotChatSuggestionConfiguration@copilotkit/react-coreSuggestion@copilotkit/coreRenamed
Parameter@copilotkit/sharedZod schemas / StandardSchemaV1zod / @copilotkit/sharedReplaced with schema-based
CopilotServiceAdapter@copilotkit/runtimeAbstractAgent@ag-ui/clientReplaced
TextMessageEvents@copilotkit/runtime----Removed (@deprecated)
ToolCallEvents@copilotkit/runtime----Removed (@deprecated)
CustomEventNames@copilotkit/runtime----Removed (@deprecated)
PredictStateTool@copilotkit/runtime----Removed (@deprecated)

v1 Props Marked @deprecated Within v1

These were already deprecated within v1 itself:

LocationDeprecated APIReplacement
FrontendActiondisabledavailable: false (boolean; defaults to true)
ActionRenderPropsrespond()Use respond (same, just documented differently)
CopilotKitPropsguardrails_c@internal/defunct in source but still populates the legacy CopilotCloud restrictToTopic config when a cloud key is set; no effect on the v2 AG-UI runtime
CopilotRuntimeonBeforeRequest / onAfterRequestbeforeRequestMiddleware / afterRequestMiddleware
useCopilotChatvisibleMessagesUse AG-UI message stream
useCopilotChatappendMessageUse sendMessage or agent API
Chat component propsAssistantMessage / UserMessage / Messages render propsRenderMessage
useA2UIStoreuseA2UIStoreuseA2UIContext
useA2UIStoreSelectoruseA2UIStoreSelectoruseA2UIContext