IntroductionGetting Started

Usage

Creating a Chat InstanceThreads, Messages, and ChannelsHandling EventsPosting MessagesError HandlingTesting

AI

OverviewAI SDK ToolstoAiMessagesTypes

Adapters

Platform AdaptersState Adapters

Messaging

StreamingDirect MessagesEphemeral MessagesFile UploadsConversation HistoryMessage SubjectOverlapping Messages

Interactivity

CardsModalsActionsSlash CommandsEmoji

API Reference

OverviewChatThreadChannelMessagePostableMessageTranscriptsCardsMarkdownModals

Contributing

Building a community adapterTesting adaptersDocumenting your adapterPublishing your adapter

Resources

Guides, templates, and examples to help you build with Chat SDK.

Guide
How to build an AI agent for Slack with Chat SDK and AI SDK
Build a Slack AI agent using Chat SDK, AI SDK's ToolLoopAgent, and Vercel AI Gateway. Covers project setup, tool definitions, streaming responses, deployment to Vercel, and scaling tool selection with toolpick.
Guide
Human-in-the-Loop with Chat SDK and Workflow SDK
Pause durable workflows on Slack approval cards using Chat SDK and Workflow SDK. Uses createWebhook to suspend workflows until a button click, with patterns for multi-stage approvals, timeouts via durable sleep, and approver validation.
Guide
How to build an agent for Liveblocks
Build an AI agent that replies to @-mentions in Liveblocks comment threads with streamed responses and tool calling. Uses Chat SDK, the Liveblocks adapter, AI SDK's ToolLoopAgent, and Redis for thread subscriptions and distributed locking.
Guide
How to build a Slack bot that manages files in Vercel Blob
Build a Slack bot that lists, reads, uploads, and deletes files in Vercel Blob through tool calls. Uses Chat SDK, AI SDK's ToolLoopAgent, and Files SDK's createFileTools factory with approval-gated write tools and a read-only mode.
Guide
Run and track deploys from Slack
Build a Slack deploy bot with Chat SDK and Vercel Workflow. Dispatch GitHub Actions from a slash command, gate production behind approval, poll for completion, and notify Linear and GitHub when the run finishes.
Guide
Triage form submissions with Chat SDK
Build a Slack bot that triages form submissions with interactive cards. Forward, edit, or mark as spam without leaving Slack. Built with Chat SDK, Hono, and Resend.
Guide
How to build a Slack bot with Next.js and Redis
This guide walks through building a Slack bot with Next.js, covering project setup, Slack app configuration, event handling, interactive features, and deployment.
Guide
Create a Discord support bot with Nuxt and Redis
This guide walks through building a Discord support bot with Nuxt, covering project setup, Discord app configuration, Gateway forwarding, AI-powered responses, and deployment.
Guide
Ship a GitHub code review bot with Hono and Redis
This guide walks through building a GitHub bot that reviews pull requests on demand. When a user @mentions the bot on a PR, Chat SDK picks up the mention, spins up a Vercel Sandbox with the repo cloned, and uses AI SDK to analyze the diff.
Template
Chat SDK Liveblocks Bot
Build a bot that you can engage with inside Liveblocks.
Template
Durable iMessage Agent
Durable iMessage agent powered by the Sendblue adapter.
Template
Knowledge Agent
Open source file-system and knowledge based agent template. Build AI agents that stay up to date with your knowledge base.
Template
Community Agent
Open source AI-powered Slack community management bot with a built-in Next.js admin panel. Uses Chat SDK, AI SDK, and Vercel Workflow.