copilotkit-develop

Wrap your app in CopilotKitProvider with a runtimeUrl, then render CopilotChat, CopilotPopup, or CopilotSidebar with an agentId. The provider connects to your CopilotRuntime endpoint and the chat component handles message submission and streaming.

Use the useFrontendTool hook with a name, description, Zod parameters schema, and a handler function. The agent invokes the tool in the browser, and the handler receives the validated arguments plus a context with the tool call and agent instance.

Create a route file that instantiates CopilotRuntime with your agents, then call createCopilotEndpoint with a basePath and export app.fetch as the GET and POST handlers. The endpoint exposes agent run, stop, transcribe, and thread routes.

Yes, useHumanInTheLoop registers a tool that pauses agent execution until the user responds. Its render component receives a respond callback during the executing phase, letting you show approve and reject options before the agent continues.

Use the useInterrupt hook with a render function that receives the interrupt event and a resolve callback. Call resolve with the user's response to resume the agent, and optionally filter interrupts with the enabled option.

Yes, pass a labels prop to CopilotChat with values like chatInputPlaceholder, welcomeMessageText, and modalHeaderTitle. Layout slots such as input, messageView, and welcomeScreen can also be replaced with custom components.