ContextQMD
Back to Copilotkit

CopilotKit v1 Deprecation Map

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

1.58.014.5 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/reactRenamed + new parameter format (Zod)
useCopilotReadable@copilotkit/react-coreuseAgentContext@copilotkit/reactRenamed, parentId removed
useCopilotChat@copilotkit/react-coreuseAgent@copilotkit/reactReplaced (different API)
useCoAgent@copilotkit/react-coreuseAgent@copilotkit/reactRenamed, different return type
useCoAgentStateRender@copilotkit/react-coreuseRenderToolCall / useRenderActivityMessage@copilotkit/reactSplit into two hooks
useLangGraphInterrupt@copilotkit/react-coreuseInterrupt@copilotkit/reactRenamed + new API
useCopilotChatSuggestions@copilotkit/react-coreuseConfigureSuggestions + useSuggestions@copilotkit/reactSplit into two hooks
useCopilotAdditionalInstructions@copilotkit/react-coreuseAgentContext@copilotkit/reactUse description/value context
useMakeCopilotDocumentReadable@copilotkit/react-coreuseAgentContext@copilotkit/reactPass content directly
useCopilotRuntimeClient@copilotkit/react-coreuseCopilotKit@copilotkit/reactAccess core via provider context
useCopilotContext@copilotkit/react-coreuseCopilotKit@copilotkit/reactReturns { copilotkit }
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/reactSame name, import path changes
useHumanInTheLoop@copilotkit/react-coreuseHumanInTheLoop@copilotkit/reactSame name, import path changes
useRenderToolCall@copilotkit/react-coreuseRenderToolCall@copilotkit/reactSame name, import path changes
useDefaultTool@copilotkit/react-coreuseDefaultRenderTool@copilotkit/reactRenamed
useLazyToolRenderer@copilotkit/react-core----Removed
useChatContext (react-ui)@copilotkit/react-uiuseCopilotChatConfiguration@copilotkit/reactRenamed

Components

v1 Componentv1 Packagev2 Replacementv2 PackageStatus
CopilotKit@copilotkit/react-coreCopilotKitProvider@copilotkit/reactRenamed
CopilotChat@copilotkit/react-uiCopilotChat@copilotkit/reactSame name, new package
CopilotPopup@copilotkit/react-uiCopilotPopup@copilotkit/reactSame name, new package
CopilotSidebar@copilotkit/react-uiCopilotSidebar@copilotkit/reactSame name, new package
CopilotTextarea@copilotkit/react-textarea----Removed
CopilotDevConsole@copilotkit/react-uiCopilotKitInspector@copilotkit/reactRenamed
Markdown@copilotkit/react-ui----Removed (use A2UI renderer)
AssistantMessage@copilotkit/react-uiCopilotChatAssistantMessage@copilotkit/reactRenamed
UserMessage@copilotkit/react-uiCopilotChatUserMessage@copilotkit/reactRenamed
ImageRenderer@copilotkit/react-ui----Removed
RenderSuggestionsList@copilotkit/react-uiCopilotChatSuggestionView@copilotkit/reactRenamed
RenderSuggestion@copilotkit/react-uiCopilotChatSuggestionPill@copilotkit/reactRenamed
CoAgentStateRendersProvider@copilotkit/react-core----Removed (no v2 equivalent)
ThreadsProvider@copilotkit/react-core----Removed (threads managed by runtime)

Runtime Classes

v1 Class/Functionv1 Packagev2 Replacementv2 PackageStatus
CopilotRuntime@copilotkit/runtimeCopilotRuntime@copilotkit/runtimeSame name, different constructor API
OpenAIAdapter@copilotkit/runtimeBuiltInAgent({ model: "openai:..." })@copilotkit/agentRemoved
AnthropicAdapter@copilotkit/runtimeBuiltInAgent({ model: "anthropic:..." })@copilotkit/agentRemoved
GoogleGenerativeAIAdapter@copilotkit/runtimeBuiltInAgent({ model: "google:..." })@copilotkit/agentRemoved
LangChainAdapter@copilotkit/runtimeCustom AbstractAgent--Removed
GroqAdapter@copilotkit/runtimeBuiltInAgent with Groq model@copilotkit/agentRemoved
UnifyAdapter@copilotkit/runtimeCustom AbstractAgent--Removed
OpenAIAssistantAdapter@copilotkit/runtimeCustom AbstractAgent--Removed
BedrockAdapter@copilotkit/runtimeBuiltInAgent({ model: "vertex:..." })@copilotkit/agentRemoved
OllamaAdapter (experimental)@copilotkit/runtimeCustom AbstractAgent--Removed
EmptyAdapter@copilotkit/runtime----Removed
RemoteChain@copilotkit/runtime----Removed
LangGraphAgent@copilotkit/runtimeLangGraphAgent@ag-ui/langgraphMoved to AG-UI package
LangGraphHttpAgent@copilotkit/runtimeLangGraphAgent@ag-ui/langgraphMoved + renamed

Runtime Framework Integrations

v1 Functionv1 Packagev2 Replacementv2 PackageStatus
copilotRuntimeNextJSAppRouterEndpoint@copilotkit/runtimecreateCopilotEndpoint@copilotkit/runtimeRemoved (use Hono)
copilotRuntimeNextJSPagesRouterEndpoint@copilotkit/runtimecreateCopilotEndpoint@copilotkit/runtimeRemoved (use Hono)
CopilotRuntimeNodeExpressEndpoint@copilotkit/runtimecreateCopilotEndpointExpress@copilotkit/runtimeRenamed
CopilotRuntimeNestEndpoint@copilotkit/runtimecreateCopilotEndpoint@copilotkit/runtimeRemoved (use Hono)
CopilotRuntimeNodeHttpEndpoint@copilotkit/runtimecreateCopilotEndpoint@copilotkit/runtimeRemoved (use Hono)

Types

v1 Typev1 Packagev2 Replacementv2 PackageStatus
CopilotKitProps@copilotkit/react-coreCopilotKitProviderProps@copilotkit/reactRenamed
CopilotContextParams@copilotkit/react-coreCopilotKitContextValue@copilotkit/reactRenamed
FrontendAction@copilotkit/react-coreReactFrontendTool@copilotkit/reactRenamed + restructured
ActionRenderProps@copilotkit/react-coreReactToolCallRenderer@copilotkit/reactRenamed + 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: "disabled"
ActionRenderPropsrespond()Use respond (same, just documented differently)
CopilotKitPropsguardrails_cRemoved in v2
CopilotRuntimeonBeforeRequest / onAfterRequestbeforeRequestMiddleware / afterRequestMiddleware
useCopilotChatvisibleMessagesUse AG-UI message stream
useCopilotChatappendMessageUse sendMessage or agent API
Chat component propsAssistantMessage / UserMessage / Messages render propsRenderMessage
useA2UIStoreuseA2UIStoreuseA2UIContext
useA2UIStoreSelectoruseA2UIStoreSelectoruseA2UIContext