mirror of
https://github.com/CopilotKit/CopilotKit.git
synced 2026-09-14 16:26:20 +08:00
Benjamin Taylor
1f6f6c4d34
Channels require an Intelligence connection (API key, free tier); run via
CopilotRuntime({ intelligence, channels }) + handler.channels.ready()/stop();
no channel.start(), no standalone/DIY path. Adapters keep their credentials.
Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
88 lines
2.6 KiB
Markdown
88 lines
2.6 KiB
Markdown
# @copilotkit/channels
|
|
|
|
`@copilotkit/channels` is the batteries-included CopilotKit Channels package. One install
|
|
provides the engine, JSX vocabulary, UI primitives, testing API, and every supported adapter.
|
|
|
|
**Channels require a CopilotKit Intelligence connection** (an API key — a free tier
|
|
is available, so this is "connect your Intelligence account," not "pay for it").
|
|
There is no standalone / DIY way to run a Channel: the `CopilotRuntime` starts and
|
|
owns each Channel's lifecycle once Intelligence is configured.
|
|
|
|
## Install
|
|
|
|
```sh
|
|
pnpm add @copilotkit/channels
|
|
```
|
|
|
|
Configure TypeScript to use the Channels JSX runtime:
|
|
|
|
```json
|
|
{
|
|
"compilerOptions": {
|
|
"jsx": "react-jsx",
|
|
"jsxImportSource": "@copilotkit/channels"
|
|
}
|
|
}
|
|
```
|
|
|
|
```tsx
|
|
import { createChannel, Message, Section } from "@copilotkit/channels";
|
|
import { slack } from "@copilotkit/channels/slack";
|
|
import {
|
|
CopilotRuntime,
|
|
CopilotKitIntelligence,
|
|
createCopilotRuntimeHandler,
|
|
} from "@copilotkit/runtime/v2";
|
|
|
|
const channel = createChannel({
|
|
name: "support-bot", // project-unique Intelligence Channel name
|
|
adapters: [
|
|
slack({
|
|
botToken: process.env.SLACK_BOT_TOKEN!,
|
|
appToken: process.env.SLACK_APP_TOKEN!,
|
|
}),
|
|
],
|
|
});
|
|
|
|
channel.onMessage(({ thread, message }) =>
|
|
thread.post(
|
|
<Message>
|
|
<Section>Echo: {message.text}</Section>
|
|
</Message>,
|
|
),
|
|
);
|
|
|
|
// The runtime owns the Channel's lifecycle — there is no `channel.start()`.
|
|
const runtime = new CopilotRuntime({
|
|
intelligence: new CopilotKitIntelligence({
|
|
apiUrl: "https://api.copilotkit.ai",
|
|
wsUrl: "wss://api.copilotkit.ai",
|
|
apiKey: process.env.COPILOTKIT_INTELLIGENCE_API_KEY!, // free tier available
|
|
}),
|
|
identifyUser: async () => ({ id: "support-bot", name: "Support Bot" }),
|
|
channels: [channel],
|
|
});
|
|
|
|
const handler = createCopilotRuntimeHandler({ runtime });
|
|
await handler.channels.ready(); // starts the channel; handler.channels.stop() tears it down
|
|
```
|
|
|
|
## Adapter entry points
|
|
|
|
- `@copilotkit/channels/slack` (plus `/slack/codec` and `/slack/render`)
|
|
- `@copilotkit/channels/teams` (plus `/teams/render`)
|
|
- `@copilotkit/channels/discord`
|
|
- `@copilotkit/channels/telegram`
|
|
- `@copilotkit/channels/whatsapp`
|
|
- `@copilotkit/channels/intelligence` for the curated `intelligenceAdapter` factory and `IntelligenceAdapterOptions` type
|
|
|
|
One package version gives you a tested snapshot of the core engine, JSX/UI vocabulary,
|
|
testing helpers, and every adapter listed above.
|
|
|
|
For adapter authoring or a selective dependency graph, install
|
|
`@copilotkit/channels-core` plus the direct adapter package you need, for example:
|
|
|
|
```sh
|
|
pnpm add @copilotkit/channels-core @copilotkit/channels-slack
|
|
```
|