Back to Copilotkit

Channels SDK

showcase/shell-docs/src/content/reference/channels/index.mdx

1.64.24.0 KB
Original Source

The Channels SDK connects an agent to chat providers through a long-running @copilotkit/channels process. In the managed Slack and Microsoft Teams path, CopilotKit Intelligence owns the provider connection while your process owns the agent, tools, approvals, state, and deployment. The package also exports developer-operated direct adapters for Slack, Teams, Discord, Telegram, and WhatsApp.

sh
npm install --save-exact @copilotkit/[email protected] @copilotkit/[email protected]

API reference

<Cards> <Card title="createChannel" description="Declare a managed provider or developer-operated direct adapter and attach the Channel to CopilotRuntime." href="/reference/channels/functions/createChannel" icon={<LinkIcon />} /> <Card title="Channel" description="Configure managed or direct delivery, register handlers and tools, configure storage, and inspect the Channel declaration." href="/reference/channels/classes/Channel" icon={<LinkIcon />} /> <Card title="Thread" description="Post and update messages, run or resume the agent, read history, and manage conversation state." href="/reference/channels/classes/Thread" icon={<LinkIcon />} /> <Card title="StateStore" description="Persist workflow state, callback snapshots, transcripts, locks, deduplication, and queues." href="/reference/channels/types/StateStore" icon={<LinkIcon />} /> </Cards>

Classes

Functions

Message components

Interactive components

Types

Provider SDKs

  • Direct provider adapters — public entry points, required options, and the boundary between managed and developer-operated delivery

Provider guides

Start with the provider and agent framework you are deploying:

The provider picker in those guides keeps the same task and selected agent framework when you switch between Slack and Teams.