Visit the adapters directory to see other available official and vendor-official adapters.
Usage
createRedisState() auto-detects the REDIS_URL environment variable, so you can call it with no arguments:
import { Chat } from "chat";import { createRedisState } from "@chat-adapter/state-redis";const bot = new Chat({ userName: "mybot", adapters: { /* ... */ }, state: createRedisState(),});
To provide a URL explicitly:
const state = createRedisState({ url: "redis://localhost:6379" });
Using an existing client
If you already have a connected Redis client, pass it directly:
import { createClient } from "redis";const client = createClient({ url: "redis://localhost:6379" });await client.connect();const state = createRedisState({ client });
Key prefix
All keys are namespaced under a configurable prefix (default: "chat-sdk"):
const state = createRedisState({ url: process.env.REDIS_URL!, keyPrefix: "my-bot",});
Configuration
Option
Required
Description
url
No*
Redis connection URL (auto-detected from REDIS_URL)
client
No
Existing redis client instance
keyPrefix
No
Prefix for all keys (default: "chat-sdk")
logger
No
Logger instance (defaults to ConsoleLogger("info"))
*Either url, REDIS_URL env var, or client is required.
Environment variables
REDIS_URL=redis://localhost:6379
For serverless deployments (Vercel, AWS Lambda), use a serverless-compatible Redis provider like Upstash.
Key structure
{keyPrefix}:subscriptions - SET of subscribed thread IDs{keyPrefix}:lock:{threadId} - Lock key with TTL
Production recommendations
Use Redis 6.0+ for best performance
Enable Redis persistence (RDB or AOF)
For Redis Sentinel, use @chat-adapter/state-ioredis. Neither adapter supports Redis Cluster
Set appropriate memory limits
Features
Feature
Supported
Persistence
Yes
Multi-instance
Yes
Subscriptions
Yes
Distributed locking
Yes
Key-value caching
Yes
Automatic reconnection
Yes
Key prefix namespacing
Yes
AI Coding Agents
If you use an AI coding agent such as OpenAI Codex, Claude Code, or Cursor, install the Chat SDK skill so it knows the SDK APIs, adapter patterns, and project conventions before writing code.
npx skills add vercel/chat
The skill references bundled documentation in node_modules/chat/docs, plus adapter guides and starter templates in the published package.
You can also install the Vercel Plugin for a broader agent toolkit — it includes the Chat SDK skill alongside specialist agents, agent slash commands, and more:
npx plugins add vercel/vercel-plugin
The plugin is optional; the skill alone is enough to build with Chat SDK.