@camunda/copilot-chat

React component library for embedding Camunda Copilot chat interface into web applications.

Installation

npm install @camunda/copilot-chat

Peer Dependencies:

npm install react react-dom @carbon/react @carbon/icons-react

Quick Start

import { CopilotChat, useChatStore } from '@camunda/copilot-chat';
import '@camunda/copilot-chat/style.css';

function App() {
  const handleSendMessage = (message: string) => {
    const { addAssistantMessage, appendToMessage, updateMessageStatus } = useChatStore.getState();
    const messageId = `msg-${Date.now()}`;
    addAssistantMessage(messageId);
    appendToMessage(messageId, 'Hello!');
    updateMessageStatus(messageId, 'complete');
  };

  return <CopilotChat onSendMessage={handleSendMessage} />;
}

For full agent orchestration with tool execution, see Writing Adapters.

Props

Full props reference: Integration Guide.

Documentation

• Architecture Overview
• Integration Guide
• Writing Adapters
• Development Guide

License

Camunda License 1.0 - See LICENSE file for details.