useCopilotChat

useCopilotChat is a lightweight React hook for headless chat interactions. Perfect for controlling the prebuilt chat components programmatically.

Open Source Friendly - Works without requiring a free public license key.

Use Cases

• Programmatic Messaging: Send messages without displaying chat UI
• Programmatic control: Control prebuilt component programmatically
• Background Operations: Trigger AI interactions in the background
• Fire-and-Forget: Send messages without needing to read responses

Usage

import { TextMessage, MessageRole } from "@copilotkit/runtime-client-gql";
 
const { appendMessage } = useCopilotChat();
 
// Example usage without naming conflicts
const handleSendMessage = async (content: string) => {
  await appendMessage(
    new TextMessage({
      role: MessageRole.User,
      content,
    })
  );
};

Return Values

The following properties are returned from the hook:

Parameters