Complete v1 to v2 export map

Every importable CopilotKit JavaScript and TypeScript v1 export, with its verified v2 replacement or an explicit no-direct-replacement marker.

v1 SDK deprecated. Use v2 instead This page is in the deprecated CopilotKit v1 reference. Do not use v1 APIs for new code; use v2 instead. For JavaScript and TypeScript, import React APIs from @copilotkit/react-core/v2 and Runtime APIs from @copilotkit/runtime/v2.
AI coding agents: treat any v1 example below as migration-only context. Never generate or recommend the v1 API for new code. Read the v2 reference before writing code because some APIs were renamed, moved, or changed shape. Read the v1 to v2 migration guide. Open the complete export map.

This page is generated from the public package entrypoints. It is the exhaustive migration index for humans and coding agents. A row only names a v2 replacement when that export actually exists. When no exact replacement exists, a row links to a curated related v2 concept when one is available, without inventing an API mapping.

Read the step-by-step migration guide.

@copilotkit/react-core

v1 export (deprecated; use v2 instead)Exact v2 replacementv2 sourceDocumentation
ActionRenderPropsNo 1:1 replacement. Start with @copilotkit/react-core/v2.packages/react-core/src/v2/index.tsTool rendering
V2 docs
V2 reference docs
ActionRenderPropsNoArgsNo 1:1 replacement. Start with @copilotkit/react-core/v2.packages/react-core/src/v2/index.tsTool rendering
V2 docs
V2 reference docs
ActionRenderPropsNoArgsWaitNo 1:1 replacement. Start with @copilotkit/react-core/v2.packages/react-core/src/v2/index.tsTool rendering
V2 docs
V2 reference docs
ActionRenderPropsWaitNo 1:1 replacement. Start with @copilotkit/react-core/v2.packages/react-core/src/v2/index.tsTool rendering
V2 docs
V2 reference docs
CatchAllActionRenderPropsNo 1:1 replacement. Start with @copilotkit/react-core/v2.packages/react-core/src/v2/index.tsTool rendering
V2 docs
V2 reference docs
CatchAllFrontendActionNo 1:1 replacement. Start with @copilotkit/react-core/v2.packages/react-core/src/v2/index.tsTool-based generative UI
V2 docs
V2 reference docs
ChatSuggestionsNo 1:1 replacement. Start with @copilotkit/react-core/v2.packages/react-core/src/v2/index.tsChat suggestions
V2 docs
V2 reference docs
CoagentInChatRenderFunctionNo 1:1 replacement. Start with @copilotkit/react-core/v2.packages/react-core/src/v2/index.tsState rendering
V2 docs
V2 reference docs
CoAgentStateRendersContextNo 1:1 replacement. Start with @copilotkit/react-core/v2.packages/react-core/src/v2/index.tsState rendering
V2 docs
V2 reference docs
CoAgentStateRendersContextValueNo 1:1 replacement. Start with @copilotkit/react-core/v2.packages/react-core/src/v2/index.tsState rendering
V2 docs
V2 reference docs
CoAgentStateRendersProviderNo 1:1 replacement. Start with @copilotkit/react-core/v2.packages/react-core/src/v2/index.tsState rendering
V2 docs
V2 reference docs
CopilotApiConfigNo 1:1 replacement. Start with @copilotkit/react-core/v2.packages/react-core/src/v2/index.tsRuntime server adapter
V2 docs
V2 reference docs
CopilotChatSuggestionConfigurationNo 1:1 replacement. Start with @copilotkit/react-core/v2.packages/react-core/src/v2/index.tsChat suggestions
V2 docs
V2 reference docs
CopilotContextNo 1:1 replacement. Start with @copilotkit/react-core/v2.packages/react-core/src/v2/index.tsCopilotKit provider
V2 docs
V2 reference docs
CopilotContextParamsNo 1:1 replacement. Start with @copilotkit/react-core/v2.packages/react-core/src/v2/index.tsCopilotKit provider
V2 docs
V2 reference docs
CopilotKitimport { CopilotKit } from "@copilotkit/react-core/v2";
<CopilotKit />;
packages/react-core/src/v1-deprecated/components/copilot-provider/copilotkit.tsxOpen v2 API docs
CopilotKitPropsimport type { CopilotKitProps } from "@copilotkit/react-core/v2";
type V2CopilotKitProps = CopilotKitProps;
packages/react-core/src/v1-deprecated/components/copilot-provider/copilotkit-props.tsxV2 docs
V2 reference docs
CopilotMessagesContextNo 1:1 replacement. Start with @copilotkit/react-core/v2.packages/react-core/src/v2/index.tsChat UI
V2 docs
V2 reference docs
CopilotMessagesContextParamsNo 1:1 replacement. Start with @copilotkit/react-core/v2.packages/react-core/src/v2/index.tsChat UI
V2 docs
V2 reference docs
CopilotTaskNo 1:1 replacement. Start with @copilotkit/react-core/v2.packages/react-core/src/v2/index.tsTool-based generative UI
V2 docs
V2 reference docs
CopilotTaskConfigNo 1:1 replacement. Start with @copilotkit/react-core/v2.packages/react-core/src/v2/index.tsTool-based generative UI
V2 docs
V2 reference docs
CrewsAgentStateNo 1:1 replacement. Start with @copilotkit/react-core/v2.packages/react-core/src/v2/index.tsV2 docs
V2 reference docs
CrewsResponseNo 1:1 replacement. Start with @copilotkit/react-core/v2.packages/react-core/src/v2/index.tsV2 docs
V2 reference docs
CrewsResponseStatusNo 1:1 replacement. Start with @copilotkit/react-core/v2.packages/react-core/src/v2/index.tsV2 docs
V2 reference docs
CrewsStateItemNo 1:1 replacement. Start with @copilotkit/react-core/v2.packages/react-core/src/v2/index.tsV2 docs
V2 reference docs
CrewsTaskStateItemNo 1:1 replacement. Start with @copilotkit/react-core/v2.packages/react-core/src/v2/index.tsV2 docs
V2 reference docs
CrewsToolStateItemNo 1:1 replacement. Start with @copilotkit/react-core/v2.packages/react-core/src/v2/index.tsV2 docs
V2 reference docs
defaultCopilotContextCategoriesNo 1:1 replacement. Start with @copilotkit/react-core/v2.packages/react-core/src/v2/index.tsAgent context
V2 docs
V2 reference docs
DocumentPointerNo 1:1 replacement. Start with @copilotkit/react-core/v2.packages/react-core/src/v2/index.tsAgent context
V2 docs
V2 reference docs
FrontendActionNo 1:1 replacement. Start with @copilotkit/react-core/v2.packages/react-core/src/v2/index.tsTool-based generative UI
V2 docs
V2 reference docs
FrontendActionAvailabilityNo 1:1 replacement. Start with @copilotkit/react-core/v2.packages/react-core/src/v2/index.tsTool-based generative UI
V2 docs
V2 reference docs
HintFunctionNo 1:1 replacement. Start with @copilotkit/react-core/v2.packages/react-core/src/v2/index.tsV2 docs
V2 reference docs
LangGraphInterruptActionNo 1:1 replacement. Start with @copilotkit/react-core/v2.packages/react-core/src/v2/index.tsHuman-in-the-loop
V2 docs
V2 reference docs
LangGraphInterruptActionSetterNo 1:1 replacement. Start with @copilotkit/react-core/v2.packages/react-core/src/v2/index.tsHuman-in-the-loop
V2 docs
V2 reference docs
LangGraphInterruptActionSetterArgsNo 1:1 replacement. Start with @copilotkit/react-core/v2.packages/react-core/src/v2/index.tsHuman-in-the-loop
V2 docs
V2 reference docs
LangGraphInterruptRenderNo 1:1 replacement. Start with @copilotkit/react-core/v2.packages/react-core/src/v2/index.tsHuman-in-the-loop
V2 docs
V2 reference docs
LangGraphInterruptRenderHandlerPropsNo 1:1 replacement. Start with @copilotkit/react-core/v2.packages/react-core/src/v2/index.tsHuman-in-the-loop
V2 docs
V2 reference docs
LangGraphInterruptRenderPropsNo 1:1 replacement. Start with @copilotkit/react-core/v2.packages/react-core/src/v2/index.tsHuman-in-the-loop
V2 docs
V2 reference docs
OnReloadMessagesNo 1:1 replacement. Start with @copilotkit/react-core/v2.packages/react-core/src/v2/index.tsChat UI
V2 docs
V2 reference docs
OnStopGenerationNo 1:1 replacement. Start with @copilotkit/react-core/v2.packages/react-core/src/v2/index.tsChat UI
V2 docs
V2 reference docs
QueuedInterruptEventNo 1:1 replacement. Start with @copilotkit/react-core/v2.packages/react-core/src/v2/index.tsHuman-in-the-loop
V2 docs
V2 reference docs
RenderFunctionStatusNo 1:1 replacement. Start with @copilotkit/react-core/v2.packages/react-core/src/v2/index.tsTool rendering
V2 docs
V2 reference docs
shouldShowDevConsoleNo 1:1 replacement. Start with @copilotkit/react-core/v2.packages/react-core/src/v2/index.tsV2 docs
V2 reference docs
SUGGESTION_RETRY_CONFIGNo 1:1 replacement. Start with @copilotkit/react-core/v2.packages/react-core/src/v2/index.tsChat suggestions
V2 docs
V2 reference docs
SystemMessageFunctionNo 1:1 replacement. Start with @copilotkit/react-core/v2.packages/react-core/src/v2/index.tsV2 docs
V2 reference docs
ThreadsContextNo 1:1 replacement. Start with @copilotkit/react-core/v2.packages/react-core/src/v2/index.tsConversation threads
V2 docs
V2 reference docs
ThreadsContextValueNo 1:1 replacement. Start with @copilotkit/react-core/v2.packages/react-core/src/v2/index.tsConversation threads
V2 docs
V2 reference docs
ThreadsProviderNo 1:1 replacement. Start with @copilotkit/react-core/v2.packages/react-core/src/v2/index.tsConversation threads
V2 docs
V2 reference docs
ThreadsProviderPropsNo 1:1 replacement. Start with @copilotkit/react-core/v2.packages/react-core/src/v2/index.tsConversation threads
V2 docs
V2 reference docs
TreeNo 1:1 replacement. Start with @copilotkit/react-core/v2.packages/react-core/src/v2/index.tsAgent context
V2 docs
V2 reference docs
TreeNodeNo 1:1 replacement. Start with @copilotkit/react-core/v2.packages/react-core/src/v2/index.tsAgent context
V2 docs
V2 reference docs
useCoAgentimport { useAgent } from "@copilotkit/react-core/v2";
useAgent({});
packages/react-core/src/v2/hooks/use-agent.tsxOpen v2 API docs
useCoAgentStateRenderimport { useAgent, UseAgentUpdate } from "@copilotkit/react-core/v2";
const { agent } = useAgent({
packages/react-core/src/v2/hooks/use-agent.tsxOpen v2 API docs
useCoAgentStateRendersNo 1:1 replacement. Start with @copilotkit/react-core/v2.packages/react-core/src/v2/index.tsState rendering
V2 docs
V2 reference docs
useCopilotActionimport { useFrontendTool } from "@copilotkit/react-core/v2";
useFrontendTool({});
packages/react-core/src/v2/hooks/use-frontend-tool.tsxOpen v2 API docs
useCopilotAdditionalInstructionsimport { useAgentContext } from "@copilotkit/react-core/v2";
useAgentContext({});
packages/react-core/src/v2/hooks/use-agent-context.tsxOpen v2 API docs
useCopilotAuthenticatedAction_cNo 1:1 replacement. Start with @copilotkit/react-core/v2.packages/react-core/src/v2/index.tsV2 docs
V2 reference docs
useCopilotChatimport { useAgent } from "@copilotkit/react-core/v2";
useAgent({});
packages/react-core/src/v2/hooks/use-agent.tsxOpen v2 API docs
useCopilotChatHeadless_cNo 1:1 replacement. Start with @copilotkit/react-core/v2.packages/react-core/src/v2/index.tsChat UI
V2 docs
V2 reference docs
useCopilotChatInternalNo 1:1 replacement. Start with @copilotkit/react-core/v2.packages/react-core/src/v2/index.tsChat UI
V2 docs
V2 reference docs
UseCopilotChatOptionsNo 1:1 replacement. Start with @copilotkit/react-core/v2.packages/react-core/src/v2/index.tsChat UI
V2 docs
V2 reference docs
UseCopilotChatOptions_cNo 1:1 replacement. Start with @copilotkit/react-core/v2.packages/react-core/src/v2/index.tsChat UI
V2 docs
V2 reference docs
UseCopilotChatReturnNo 1:1 replacement. Start with @copilotkit/react-core/v2.packages/react-core/src/v2/index.tsChat UI
V2 docs
V2 reference docs
UseCopilotChatReturn_cNo 1:1 replacement. Start with @copilotkit/react-core/v2.packages/react-core/src/v2/index.tsChat UI
V2 docs
V2 reference docs
useCopilotChatSuggestionsimport { useConfigureSuggestions } from "@copilotkit/react-core/v2";
useConfigureSuggestions({
packages/react-core/src/v2/hooks/use-configure-suggestions.tsxOpen v2 API docs
UseCopilotChatSuggestionsConfigurationNo 1:1 replacement. Start with @copilotkit/react-core/v2.packages/react-core/src/v2/index.tsChat suggestions
V2 docs
V2 reference docs
useCopilotContextNo 1:1 replacement. Start with @copilotkit/react-core/v2.packages/react-core/src/v2/index.tsCopilotKit provider
V2 docs
V2 reference docs
useCopilotMessagesContextNo 1:1 replacement. Start with @copilotkit/react-core/v2.packages/react-core/src/v2/index.tsChat UI
V2 docs
V2 reference docs
useCopilotReadableimport { useAgentContext } from "@copilotkit/react-core/v2";
useAgentContext({
packages/react-core/src/v2/hooks/use-agent-context.tsxOpen v2 API docs
useCopilotRuntimeClientNo 1:1 replacement. Start with @copilotkit/react-core/v2.packages/react-core/src/v2/index.tsRuntime server adapter
V2 docs
V2 reference docs
useDefaultToolimport { useDefaultRenderTool } from "@copilotkit/react-core/v2";
useDefaultRenderTool({});
packages/react-core/src/v2/hooks/use-default-render-tool.tsxOpen v2 API docs
useFrontendToolimport { useFrontendTool } from "@copilotkit/react-core/v2";
useFrontendTool({
packages/react-core/src/v2/hooks/use-frontend-tool.tsxOpen v2 API docs
useHumanInTheLoopimport { useHumanInTheLoop } from "@copilotkit/react-core/v2";
useHumanInTheLoop({
packages/react-core/src/v2/hooks/use-human-in-the-loop.tsxOpen v2 API docs
useLangGraphInterruptimport { useInterrupt } from "@copilotkit/react-core/v2";
useInterrupt({
packages/react-core/src/v2/hooks/use-interrupt.tsxOpen v2 API docs
useLazyToolRendererNo 1:1 replacement. Start with @copilotkit/react-core/v2.packages/react-core/src/v2/index.tsTool rendering
V2 docs
V2 reference docs
useMakeCopilotDocumentReadableNo 1:1 replacement. Start with @copilotkit/react-core/v2.packages/react-core/src/v2/index.tsAgent context
V2 docs
V2 reference docs
useRenderToolCallimport { useRenderTool } from "@copilotkit/react-core/v2";
useRenderTool({
packages/react-core/src/v2/hooks/use-render-tool.tsxOpen v2 API docs
useThreadsimport { useThreads } from "@copilotkit/react-core/v2";
useThreads({});
packages/react-core/src/v2/hooks/use-threads.tsxOpen v2 API docs

@copilotkit/react-ui

v1 export (deprecated; use v2 instead)Exact v2 replacementv2 sourceDocumentation
AssistantMessageimport { AssistantMessage } from "@copilotkit/react-core/v2";
const v2AssistantMessage = AssistantMessage;
packages/react-core/src/v2/index.tsV2 docs
V2 reference docs
AssistantMessagePropsNo 1:1 replacement. Start with @copilotkit/react-core/v2.packages/react-core/src/v2/index.tsChat UI
V2 docs
V2 reference docs
Attachmentimport type { Attachment } from "@copilotkit/react-core/v2";
type V2Attachment = Attachment;
packages/react-core/src/v2/index.tsV2 docs
V2 reference docs
AttachmentModalityimport type { AttachmentModality } from "@copilotkit/react-core/v2";
type V2AttachmentModality = AttachmentModality;
packages/react-core/src/v2/index.tsV2 docs
V2 reference docs
AttachmentsConfigimport type { AttachmentsConfig } from "@copilotkit/react-core/v2";
type V2AttachmentsConfig = AttachmentsConfig;
packages/react-core/src/v2/index.tsV2 docs
V2 reference docs
ButtonPropsNo 1:1 replacement. Start with @copilotkit/react-core/v2.packages/react-core/src/v2/index.tsChat UI
V2 docs
V2 reference docs
ChatErrorNo 1:1 replacement. Start with @copilotkit/react-core/v2.packages/react-core/src/v2/index.tsChat UI
V2 docs
V2 reference docs
ComponentsMapNo 1:1 replacement. Start with @copilotkit/react-core/v2.packages/react-core/src/v2/index.tsChat UI
V2 docs
V2 reference docs
CopilotChatimport { CopilotChat } from "@copilotkit/react-core/v2";
return <CopilotChat agentId="my-agent" />;
packages/react-core/src/v2/components/chat/CopilotChat.tsxOpen v2 API docs
CopilotChatSuggestionNo 1:1 replacement. Start with @copilotkit/react-core/v2.packages/react-core/src/v2/index.tsChat suggestions
V2 docs
V2 reference docs
CopilotDevConsoleNo 1:1 replacement. Start with @copilotkit/react-core/v2.packages/react-core/src/v2/index.tsV2 docs
V2 reference docs
CopilotKitCSSPropertiesNo 1:1 replacement. Start with @copilotkit/react-core/v2.packages/react-core/src/v2/index.tsChat UI
V2 docs
V2 reference docs
CopilotModalNo 1:1 replacement. Start with @copilotkit/react-core/v2.packages/react-core/src/v2/index.tsChat UI
V2 docs
V2 reference docs
CopilotModalPropsNo 1:1 replacement. Start with @copilotkit/react-core/v2.packages/react-core/src/v2/index.tsChat UI
V2 docs
V2 reference docs
CopilotObservabilityHooksNo 1:1 replacement. Start with @copilotkit/react-core/v2.packages/react-core/src/v2/index.tsChat UI
V2 docs
V2 reference docs
CopilotPopupimport { CopilotPopup } from "@copilotkit/react-core/v2";
<CopilotPopup />;
packages/react-core/src/v2/components/chat/CopilotPopup.tsxOpen v2 API docs
CopilotSidebarimport { CopilotSidebar } from "@copilotkit/react-core/v2";
<CopilotSidebar />;
packages/react-core/src/v2/components/chat/CopilotSidebar.tsxOpen v2 API docs
CopilotSidebarPropsimport type { CopilotSidebarProps } from "@copilotkit/react-core/v2";
type V2CopilotSidebarProps = CopilotSidebarProps;
packages/react-core/src/v2/components/chat/CopilotSidebar.tsxV2 docs
V2 reference docs
ErrorMessagePropsNo 1:1 replacement. Start with @copilotkit/react-core/v2.packages/react-core/src/v2/index.tsChat UI
V2 docs
V2 reference docs
HeaderPropsNo 1:1 replacement. Start with @copilotkit/react-core/v2.packages/react-core/src/v2/index.tsChat UI
V2 docs
V2 reference docs
ImageRendererNo 1:1 replacement. Start with @copilotkit/react-core/v2.packages/react-core/src/v2/index.tsChat UI
V2 docs
V2 reference docs
ImageRendererPropsNo 1:1 replacement. Start with @copilotkit/react-core/v2.packages/react-core/src/v2/index.tsChat UI
V2 docs
V2 reference docs
InputPropsNo 1:1 replacement. Start with @copilotkit/react-core/v2.packages/react-core/src/v2/index.tsChat UI
V2 docs
V2 reference docs
MarkdownNo 1:1 replacement. Start with @copilotkit/react-core/v2.packages/react-core/src/v2/index.tsChat UI
V2 docs
V2 reference docs
MessagesPropsNo 1:1 replacement. Start with @copilotkit/react-core/v2.packages/react-core/src/v2/index.tsChat UI
V2 docs
V2 reference docs
RendererNo 1:1 replacement. Start with @copilotkit/react-core/v2.packages/react-core/src/v2/index.tsChat UI
V2 docs
V2 reference docs
RenderMessagePropsNo 1:1 replacement. Start with @copilotkit/react-core/v2.packages/react-core/src/v2/index.tsChat UI
V2 docs
V2 reference docs
RenderSuggestionNo 1:1 replacement. Start with @copilotkit/react-core/v2.packages/react-core/src/v2/index.tsChat suggestions
V2 docs
V2 reference docs
RenderSuggestionsListNo 1:1 replacement. Start with @copilotkit/react-core/v2.packages/react-core/src/v2/index.tsChat suggestions
V2 docs
V2 reference docs
RenderSuggestionsListPropsNo 1:1 replacement. Start with @copilotkit/react-core/v2.packages/react-core/src/v2/index.tsChat suggestions
V2 docs
V2 reference docs
shouldShowDevConsoleNo 1:1 replacement. Start with @copilotkit/react-core/v2.packages/react-core/src/v2/index.tsV2 docs
V2 reference docs
SuggestionsPropsNo 1:1 replacement. Start with @copilotkit/react-core/v2.packages/react-core/src/v2/index.tsChat suggestions
V2 docs
V2 reference docs
suppressDeprecationWarningsNo 1:1 replacement. Start with @copilotkit/react-core/v2.packages/react-core/src/v2/index.tsV2 docs
V2 reference docs
useChatContextNo 1:1 replacement. Start with @copilotkit/react-core/v2.packages/react-core/src/v2/index.tsChat UI
V2 docs
V2 reference docs
useCopilotChatSuggestionsimport { useConfigureSuggestions } from "@copilotkit/react-core/v2";
useConfigureSuggestions({
packages/react-core/src/v2/hooks/use-configure-suggestions.tsxOpen v2 API docs
UserMessageimport { UserMessage } from "@copilotkit/react-core/v2";
const v2UserMessage = UserMessage;
packages/react-core/src/v2/index.tsV2 docs
V2 reference docs
UserMessagePropsNo 1:1 replacement. Start with @copilotkit/react-core/v2.packages/react-core/src/v2/index.tsChat UI
V2 docs
V2 reference docs
WindowPropsNo 1:1 replacement. Start with @copilotkit/react-core/v2.packages/react-core/src/v2/index.tsChat UI
V2 docs
V2 reference docs

@copilotkit/react-textarea

v1 export (deprecated; use v2 instead)Exact v2 replacementv2 sourceDocumentation
AutosuggestionsBareFunctionNo 1:1 replacement. Start with @copilotkit/react-core/v2.packages/react-core/src/v2/index.tsV2 docs
V2 reference docs
AutosuggestionsConfigNo 1:1 replacement. Start with @copilotkit/react-core/v2.packages/react-core/src/v2/index.tsV2 docs
V2 reference docs
AutosuggestionsConfigUserSpecifiedNo 1:1 replacement. Start with @copilotkit/react-core/v2.packages/react-core/src/v2/index.tsV2 docs
V2 reference docs
BaseAutosuggestionsConfigNo 1:1 replacement. Start with @copilotkit/react-core/v2.packages/react-core/src/v2/index.tsV2 docs
V2 reference docs
BaseCopilotTextareaNo 1:1 replacement. Start with @copilotkit/react-core/v2.packages/react-core/src/v2/index.tsV2 docs
V2 reference docs
BaseCopilotTextareaPropsNo 1:1 replacement. Start with @copilotkit/react-core/v2.packages/react-core/src/v2/index.tsV2 docs
V2 reference docs
CopilotTextareaNo 1:1 replacement. Start with @copilotkit/react-core/v2.packages/react-core/src/v2/index.tsV2 docs
V2 reference docs
CopilotTextareaPropsNo 1:1 replacement. Start with @copilotkit/react-core/v2.packages/react-core/src/v2/index.tsV2 docs
V2 reference docs
defaultAutosuggestionsConfigNo 1:1 replacement. Start with @copilotkit/react-core/v2.packages/react-core/src/v2/index.tsV2 docs
V2 reference docs
defaultBaseAutosuggestionsConfigNo 1:1 replacement. Start with @copilotkit/react-core/v2.packages/react-core/src/v2/index.tsV2 docs
V2 reference docs
HTMLCopilotTextAreaElementNo 1:1 replacement. Start with @copilotkit/react-core/v2.packages/react-core/src/v2/index.tsV2 docs
V2 reference docs
InsertionsApiConfigUserSpecifiedNo 1:1 replacement. Start with @copilotkit/react-core/v2.packages/react-core/src/v2/index.tsV2 docs
V2 reference docs
MakeSystemPromptNo 1:1 replacement. Start with @copilotkit/react-core/v2.packages/react-core/src/v2/index.tsV2 docs
V2 reference docs
SuggestionsApiConfigUserSpecifiedNo 1:1 replacement. Start with @copilotkit/react-core/v2.packages/react-core/src/v2/index.tsV2 docs
V2 reference docs

@copilotkit/runtime

v1 export (deprecated; use v2 instead)Exact v2 replacementv2 sourceDocumentation
AgentFactoryContextimport type { AgentFactoryContext } from "@copilotkit/runtime/v2";
type V2AgentFactoryContext = AgentFactoryContext;
packages/runtime/src/v2/runtime/core/runtime.tsOpen v2 API docs
AgentsConfigimport type { AgentsConfig } from "@copilotkit/runtime/v2";
type V2AgentsConfig = AgentsConfig;
packages/runtime/src/v2/runtime/core/runtime.tsOpen v2 API docs
AgentsFactoryimport type { AgentsFactory } from "@copilotkit/runtime/v2";
type V2AgentsFactory = AgentsFactory;
packages/runtime/src/v2/runtime/core/runtime.tsOpen v2 API docs
AnthropicAdapterNo 1:1 replacement. Start with @copilotkit/runtime/v2.packages/runtime/src/v2/index.tsRuntime server adapter
V2 docs
V2 reference docs
AnthropicAdapterParamsNo 1:1 replacement. Start with @copilotkit/runtime/v2.packages/runtime/src/v2/index.tsRuntime server adapter
V2 docs
V2 reference docs
AnthropicPromptCachingConfigNo 1:1 replacement. Start with @copilotkit/runtime/v2.packages/runtime/src/v2/index.tsRuntime server adapter
V2 docs
V2 reference docs
BedrockAdapterNo 1:1 replacement. Start with @copilotkit/runtime/v2.packages/runtime/src/v2/index.tsRuntime server adapter
V2 docs
V2 reference docs
BedrockAdapterParamsNo 1:1 replacement. Start with @copilotkit/runtime/v2.packages/runtime/src/v2/index.tsRuntime server adapter
V2 docs
V2 reference docs
buildSchemaNo 1:1 replacement. Start with @copilotkit/runtime/v2.packages/runtime/src/v2/index.tsRuntime server adapter
V2 docs
V2 reference docs
CommonConfigNo 1:1 replacement. Start with @copilotkit/runtime/v2.packages/runtime/src/v2/index.tsRuntime server adapter
V2 docs
V2 reference docs
configNo 1:1 replacement. Start with @copilotkit/runtime/v2.packages/runtime/src/v2/index.tsRuntime server adapter
V2 docs
V2 reference docs
convertMCPToolsToActionsNo 1:1 replacement. Start with @copilotkit/runtime/v2.packages/runtime/src/v2/index.tsModel Context Protocol
V2 docs
V2 reference docs
convertServiceAdapterErrorNo 1:1 replacement. Start with @copilotkit/runtime/v2.packages/runtime/src/v2/index.tsRuntime server adapter
V2 docs
V2 reference docs
CopilotEndpointCorsConfigimport type { CopilotEndpointCorsConfig } from "@copilotkit/runtime/v2";
type V2CopilotEndpointCorsConfig = CopilotEndpointCorsConfig;
packages/runtime/src/v2/runtime/endpoints/hono.tsOpen v2 API docs
copilotKitEndpointNo 1:1 replacement. Start with @copilotkit/runtime/v2.packages/runtime/src/v2/index.tsRuntime server adapter
V2 docs
V2 reference docs
CopilotRequestContextPropertiesNo 1:1 replacement. Start with @copilotkit/runtime/v2.packages/runtime/src/v2/index.tsRuntime server adapter
V2 docs
V2 reference docs
CopilotRuntimeimport { CopilotRuntime } from "@copilotkit/runtime/v2";
const runtime = new CopilotRuntime({ agents: {} });
packages/runtime/src/v2/runtime/core/runtime.tsOpen v2 API docs
CopilotRuntimeChatCompletionRequestNo 1:1 replacement. Start with @copilotkit/runtime/v2.packages/runtime/src/v2/index.tsRuntime server adapter
V2 docs
V2 reference docs
CopilotRuntimeChatCompletionResponseNo 1:1 replacement. Start with @copilotkit/runtime/v2.packages/runtime/src/v2/index.tsRuntime server adapter
V2 docs
V2 reference docs
CopilotRuntimeConstructorParams_BASENo 1:1 replacement. Start with @copilotkit/runtime/v2.packages/runtime/src/v2/index.tsRuntime server adapter
V2 docs
V2 reference docs
CopilotRuntimeLoggerNo 1:1 replacement. Start with @copilotkit/runtime/v2.packages/runtime/src/v2/index.tsV2 docs
V2 reference docs
copilotRuntimeNestEndpointNo 1:1 replacement. Start with @copilotkit/runtime/v2.packages/runtime/src/v2/index.tsRuntime server adapter
V2 docs
V2 reference docs
copilotRuntimeNextJSAppRouterEndpointNo 1:1 replacement. Start with @copilotkit/runtime/v2.packages/runtime/src/v2/index.tsRuntime server adapter
V2 docs
V2 reference docs
copilotRuntimeNextJSPagesRouterEndpointNo 1:1 replacement. Start with @copilotkit/runtime/v2.packages/runtime/src/v2/index.tsRuntime server adapter
V2 docs
V2 reference docs
copilotRuntimeNodeExpressEndpointNo 1:1 replacement. Start with @copilotkit/runtime/v2.packages/runtime/src/v2/index.tsRuntime server adapter
V2 docs
V2 reference docs
copilotRuntimeNodeHttpEndpointNo 1:1 replacement. Start with @copilotkit/runtime/v2.packages/runtime/src/v2/index.tsRuntime server adapter
V2 docs
V2 reference docs
CopilotServiceAdapterNo 1:1 replacement. Start with @copilotkit/runtime/v2.packages/runtime/src/v2/index.tsRuntime server adapter
V2 docs
V2 reference docs
CreateCopilotRuntimeServerOptionsNo 1:1 replacement. Start with @copilotkit/runtime/v2.packages/runtime/src/v2/index.tsRuntime server adapter
V2 docs
V2 reference docs
createLoggerNo 1:1 replacement. Start with @copilotkit/runtime/v2.packages/runtime/src/v2/index.tsV2 docs
V2 reference docs
CustomEventNamesNo 1:1 replacement. Start with @copilotkit/runtime/v2.packages/runtime/src/v2/index.tsLangGraph agents
V2 docs
V2 reference docs
EmptyAdapterNo 1:1 replacement. Start with @copilotkit/runtime/v2.packages/runtime/src/v2/index.tsRuntime server adapter
V2 docs
V2 reference docs
ExperimentalEmptyAdapterNo 1:1 replacement. Start with @copilotkit/runtime/v2.packages/runtime/src/v2/index.tsRuntime server adapter
V2 docs
V2 reference docs
ExperimentalOllamaAdapterNo 1:1 replacement. Start with @copilotkit/runtime/v2.packages/runtime/src/v2/index.tsRuntime server adapter
V2 docs
V2 reference docs
extractParametersFromSchemaNo 1:1 replacement. Start with @copilotkit/runtime/v2.packages/runtime/src/v2/index.tsModel Context Protocol
V2 docs
V2 reference docs
generateMcpToolInstructionsNo 1:1 replacement. Start with @copilotkit/runtime/v2.packages/runtime/src/v2/index.tsModel Context Protocol
V2 docs
V2 reference docs
getCommonConfigNo 1:1 replacement. Start with @copilotkit/runtime/v2.packages/runtime/src/v2/index.tsRuntime server adapter
V2 docs
V2 reference docs
getSdkClientOptionsNo 1:1 replacement. Start with @copilotkit/runtime/v2.packages/runtime/src/v2/index.tsRuntime server adapter
V2 docs
V2 reference docs
GoogleGenerativeAIAdapterNo 1:1 replacement. Start with @copilotkit/runtime/v2.packages/runtime/src/v2/index.tsRuntime server adapter
V2 docs
V2 reference docs
GraphQLContextNo 1:1 replacement. Start with @copilotkit/runtime/v2.packages/runtime/src/v2/index.tsRuntime server adapter
V2 docs
V2 reference docs
GroqAdapterNo 1:1 replacement. Start with @copilotkit/runtime/v2.packages/runtime/src/v2/index.tsRuntime server adapter
V2 docs
V2 reference docs
GroqAdapterParamsNo 1:1 replacement. Start with @copilotkit/runtime/v2.packages/runtime/src/v2/index.tsRuntime server adapter
V2 docs
V2 reference docs
GuardrailsValidationFailureResponseNo 1:1 replacement. Start with @copilotkit/runtime/v2.packages/runtime/src/v2/index.tsV2 docs
V2 reference docs
LangChainAdapterNo 1:1 replacement. Start with @copilotkit/runtime/v2.packages/runtime/src/v2/index.tsRuntime server adapter
V2 docs
V2 reference docs
LangGraphAgentNo 1:1 replacement. Start with @copilotkit/runtime/v2.packages/runtime/src/v2/index.tsLangGraph agents
V2 docs
V2 reference docs
LangGraphHttpAgentNo 1:1 replacement. Start with @copilotkit/runtime/v2.packages/runtime/src/v2/index.tsLangGraph agents
V2 docs
V2 reference docs
langGraphPlatformEndpointNo 1:1 replacement. Start with @copilotkit/runtime/v2.packages/runtime/src/v2/index.tsLangGraph agents
V2 docs
V2 reference docs
LogLevelNo 1:1 replacement. Start with @copilotkit/runtime/v2.packages/runtime/src/v2/index.tsV2 docs
V2 reference docs
MCPClientimport type { MCPClient } from "@copilotkit/runtime/v2";
type V2MCPClient = MCPClient;
packages/runtime/src/v2/index.tsOpen v2 API docs
MCPEndpointConfigNo 1:1 replacement. Start with @copilotkit/runtime/v2.packages/runtime/src/v2/index.tsModel Context Protocol
V2 docs
V2 reference docs
MCPToolNo 1:1 replacement. Start with @copilotkit/runtime/v2.packages/runtime/src/v2/index.tsModel Context Protocol
V2 docs
V2 reference docs
MessageStreamInterruptedResponseNo 1:1 replacement. Start with @copilotkit/runtime/v2.packages/runtime/src/v2/index.tsV2 docs
V2 reference docs
OpenAIAdapterNo 1:1 replacement. Start with @copilotkit/runtime/v2.packages/runtime/src/v2/index.tsRuntime server adapter
V2 docs
V2 reference docs
OpenAIAdapterParamsNo 1:1 replacement. Start with @copilotkit/runtime/v2.packages/runtime/src/v2/index.tsRuntime server adapter
V2 docs
V2 reference docs
OpenAIAssistantAdapterNo 1:1 replacement. Start with @copilotkit/runtime/v2.packages/runtime/src/v2/index.tsRuntime server adapter
V2 docs
V2 reference docs
OpenAIAssistantAdapterParamsNo 1:1 replacement. Start with @copilotkit/runtime/v2.packages/runtime/src/v2/index.tsRuntime server adapter
V2 docs
V2 reference docs
PredictStateToolNo 1:1 replacement. Start with @copilotkit/runtime/v2.packages/runtime/src/v2/index.tsLangGraph agents
V2 docs
V2 reference docs
RemoteChainNo 1:1 replacement. Start with @copilotkit/runtime/v2.packages/runtime/src/v2/index.tsRuntime server adapter
V2 docs
V2 reference docs
RemoteChainParametersNo 1:1 replacement. Start with @copilotkit/runtime/v2.packages/runtime/src/v2/index.tsRuntime server adapter
V2 docs
V2 reference docs
resolveEndpointTypeNo 1:1 replacement. Start with @copilotkit/runtime/v2.packages/runtime/src/v2/index.tsRuntime server adapter
V2 docs
V2 reference docs
TelemetryAgentRunnerNo 1:1 replacement. Start with @copilotkit/runtime/v2.packages/runtime/src/v2/index.tsV2 docs
V2 reference docs
TelemetryAgentRunnerConfigNo 1:1 replacement. Start with @copilotkit/runtime/v2.packages/runtime/src/v2/index.tsV2 docs
V2 reference docs
TextMessageEventsNo 1:1 replacement. Start with @copilotkit/runtime/v2.packages/runtime/src/v2/index.tsLangGraph agents
V2 docs
V2 reference docs
ToolCallEventsNo 1:1 replacement. Start with @copilotkit/runtime/v2.packages/runtime/src/v2/index.tsLangGraph agents
V2 docs
V2 reference docs
UnifyAdapterNo 1:1 replacement. Start with @copilotkit/runtime/v2.packages/runtime/src/v2/index.tsRuntime server adapter
V2 docs
V2 reference docs
UnifyAdapterParamsNo 1:1 replacement. Start with @copilotkit/runtime/v2.packages/runtime/src/v2/index.tsRuntime server adapter
V2 docs
V2 reference docs
UnknownErrorResponseNo 1:1 replacement. Start with @copilotkit/runtime/v2.packages/runtime/src/v2/index.tsV2 docs
V2 reference docs

@copilotkit/runtime/langgraph

v1 export (deprecated; use v2 instead)Exact v2 replacementv2 sourceDocumentation
CustomEventNamesNo 1:1 replacement. Start with @copilotkit/runtime/v2.packages/runtime/src/v2/index.tsLangGraph agents
V2 docs
V2 reference docs
LangGraphAgentNo 1:1 replacement. Start with @copilotkit/runtime/v2.packages/runtime/src/v2/index.tsLangGraph agents
V2 docs
V2 reference docs
LangGraphHttpAgentNo 1:1 replacement. Start with @copilotkit/runtime/v2.packages/runtime/src/v2/index.tsV2 docs
V2 reference docs
PredictStateToolNo 1:1 replacement. Start with @copilotkit/runtime/v2.packages/runtime/src/v2/index.tsLangGraph agents
V2 docs
V2 reference docs
TextMessageEventsNo 1:1 replacement. Start with @copilotkit/runtime/v2.packages/runtime/src/v2/index.tsLangGraph agents
V2 docs
V2 reference docs
ToolCallEventsNo 1:1 replacement. Start with @copilotkit/runtime/v2.packages/runtime/src/v2/index.tsLangGraph agents
V2 docs
V2 reference docs

@copilotkit/sdk-js

v1 export (deprecated; use v2 instead)Exact v2 replacementv2 sourceDocumentation
getForwardedHeadersNo 1:1 replacement. Start with @copilotkit/runtime/v2.packages/runtime/src/v2/index.tsV2 docs
V2 reference docs
withForwardedHeadersNo 1:1 replacement. Start with @copilotkit/runtime/v2.packages/runtime/src/v2/index.tsV2 docs
V2 reference docs

@copilotkit/sdk-js/langchain

v1 export (deprecated; use v2 instead)Exact v2 replacementv2 sourceDocumentation
convertActionsToDynamicStructuredToolsNo 1:1 replacement. Start with @copilotkit/runtime/v2.packages/runtime/src/v2/index.tsLangGraph agents
V2 docs
V2 reference docs
convertActionToDynamicStructuredToolNo 1:1 replacement. Start with @copilotkit/runtime/v2.packages/runtime/src/v2/index.tsLangGraph agents
V2 docs
V2 reference docs
copilotKitCustomizeConfigNo 1:1 replacement. Start with @copilotkit/runtime/v2.packages/runtime/src/v2/index.tsLangGraph agents
V2 docs
V2 reference docs
copilotKitEmitMessageNo 1:1 replacement. Start with @copilotkit/runtime/v2.packages/runtime/src/v2/index.tsLangGraph agents
V2 docs
V2 reference docs
copilotKitEmitStateNo 1:1 replacement. Start with @copilotkit/runtime/v2.packages/runtime/src/v2/index.tsLangGraph agents
V2 docs
V2 reference docs
copilotKitEmitToolCallNo 1:1 replacement. Start with @copilotkit/runtime/v2.packages/runtime/src/v2/index.tsLangGraph agents
V2 docs
V2 reference docs
copilotKitExitNo 1:1 replacement. Start with @copilotkit/runtime/v2.packages/runtime/src/v2/index.tsLangGraph agents
V2 docs
V2 reference docs
CopilotKitPropertiesNo 1:1 replacement. Start with @copilotkit/runtime/v2.packages/runtime/src/v2/index.tsLangGraph agents
V2 docs
V2 reference docs
CopilotKitPropertiesAnnotationNo 1:1 replacement. Start with @copilotkit/runtime/v2.packages/runtime/src/v2/index.tsLangGraph agents
V2 docs
V2 reference docs
CopilotKitPropertiesSchemaNo 1:1 replacement. Start with @copilotkit/runtime/v2.packages/runtime/src/v2/index.tsLangGraph agents
V2 docs
V2 reference docs
CopilotKitSchemaStateNo 1:1 replacement. Start with @copilotkit/runtime/v2.packages/runtime/src/v2/index.tsLangGraph agents
V2 docs
V2 reference docs
CopilotKitSchemaUpdateNo 1:1 replacement. Start with @copilotkit/runtime/v2.packages/runtime/src/v2/index.tsLangGraph agents
V2 docs
V2 reference docs
CopilotKitStateNo 1:1 replacement. Start with @copilotkit/runtime/v2.packages/runtime/src/v2/index.tsLangGraph agents
V2 docs
V2 reference docs
CopilotKitStateAnnotationNo 1:1 replacement. Start with @copilotkit/runtime/v2.packages/runtime/src/v2/index.tsLangGraph agents
V2 docs
V2 reference docs
CopilotKitStateSchemaNo 1:1 replacement. Start with @copilotkit/runtime/v2.packages/runtime/src/v2/index.tsLangGraph agents
V2 docs
V2 reference docs

@copilotkit/sdk-js/langgraph

v1 export (deprecated; use v2 instead)Exact v2 replacementv2 sourceDocumentation
convertActionsToDynamicStructuredToolsNo 1:1 replacement. Start with @copilotkit/runtime/v2.packages/runtime/src/v2/index.tsLangGraph agents
V2 docs
V2 reference docs
convertActionToDynamicStructuredToolNo 1:1 replacement. Start with @copilotkit/runtime/v2.packages/runtime/src/v2/index.tsLangGraph agents
V2 docs
V2 reference docs
copilotkitCustomizeConfigNo 1:1 replacement. Start with @copilotkit/runtime/v2.packages/runtime/src/v2/index.tsLangGraph agents
V2 docs
V2 reference docs
copilotkitEmitMessageNo 1:1 replacement. Start with @copilotkit/runtime/v2.packages/runtime/src/v2/index.tsLangGraph agents
V2 docs
V2 reference docs
copilotkitEmitStateNo 1:1 replacement. Start with @copilotkit/runtime/v2.packages/runtime/src/v2/index.tsLangGraph agents
V2 docs
V2 reference docs
copilotkitEmitToolCallNo 1:1 replacement. Start with @copilotkit/runtime/v2.packages/runtime/src/v2/index.tsLangGraph agents
V2 docs
V2 reference docs
copilotkitExitNo 1:1 replacement. Start with @copilotkit/runtime/v2.packages/runtime/src/v2/index.tsLangGraph agents
V2 docs
V2 reference docs
copilotKitInterruptNo 1:1 replacement. Start with @copilotkit/runtime/v2.packages/runtime/src/v2/index.tsLangGraph agents
V2 docs
V2 reference docs
copilotkitMiddlewareNo 1:1 replacement. Start with @copilotkit/runtime/v2.packages/runtime/src/v2/index.tsLangGraph agents
V2 docs
V2 reference docs
CopilotKitPropertiesNo 1:1 replacement. Start with @copilotkit/runtime/v2.packages/runtime/src/v2/index.tsLangGraph agents
V2 docs
V2 reference docs
CopilotKitPropertiesAnnotationNo 1:1 replacement. Start with @copilotkit/runtime/v2.packages/runtime/src/v2/index.tsLangGraph agents
V2 docs
V2 reference docs
CopilotKitPropertiesSchemaNo 1:1 replacement. Start with @copilotkit/runtime/v2.packages/runtime/src/v2/index.tsLangGraph agents
V2 docs
V2 reference docs
CopilotKitSchemaStateNo 1:1 replacement. Start with @copilotkit/runtime/v2.packages/runtime/src/v2/index.tsLangGraph agents
V2 docs
V2 reference docs
CopilotKitSchemaUpdateNo 1:1 replacement. Start with @copilotkit/runtime/v2.packages/runtime/src/v2/index.tsLangGraph agents
V2 docs
V2 reference docs
CopilotKitStateNo 1:1 replacement. Start with @copilotkit/runtime/v2.packages/runtime/src/v2/index.tsLangGraph agents
V2 docs
V2 reference docs
CopilotKitStateAnnotationNo 1:1 replacement. Start with @copilotkit/runtime/v2.packages/runtime/src/v2/index.tsLangGraph agents
V2 docs
V2 reference docs
CopilotKitStateSchemaNo 1:1 replacement. Start with @copilotkit/runtime/v2.packages/runtime/src/v2/index.tsLangGraph agents
V2 docs
V2 reference docs
createCopilotkitMiddlewareNo 1:1 replacement. Start with @copilotkit/runtime/v2.packages/runtime/src/v2/index.tsLangGraph agents
V2 docs
V2 reference docs
ExposeStateOptionNo 1:1 replacement. Start with @copilotkit/runtime/v2.packages/runtime/src/v2/index.tsLangGraph agents
V2 docs
V2 reference docs
IntermediateStateConfigNo 1:1 replacement. Start with @copilotkit/runtime/v2.packages/runtime/src/v2/index.tsLangGraph agents
V2 docs
V2 reference docs
OptionsConfigNo 1:1 replacement. Start with @copilotkit/runtime/v2.packages/runtime/src/v2/index.tsLangGraph agents
V2 docs
V2 reference docs
StandardSerializableSchemaNo 1:1 replacement. Start with @copilotkit/runtime/v2.packages/runtime/src/v2/index.tsLangGraph agents
V2 docs
V2 reference docs
zodStateNo 1:1 replacement. Start with @copilotkit/runtime/v2.packages/runtime/src/v2/index.tsLangGraph agents
V2 docs
V2 reference docs

@copilotkit/sdk-js/langgraph-middlewares

v1 export (deprecated; use v2 instead)Exact v2 replacementv2 sourceDocumentation
stateItemNo 1:1 replacement. Start with @copilotkit/runtime/v2.packages/runtime/src/v2/index.tsLangGraph agents
V2 docs
V2 reference docs
StateItemNo 1:1 replacement. Start with @copilotkit/runtime/v2.packages/runtime/src/v2/index.tsLangGraph agents
V2 docs
V2 reference docs
stateStreamingMiddlewareNo 1:1 replacement. Start with @copilotkit/runtime/v2.packages/runtime/src/v2/index.tsLangGraph agents
V2 docs
V2 reference docs