Caspian SDK 是一个开源的AI代理(Agent)通信SDK。它的核心目标是让开发者能用一套统一的、声明式的代码,轻松为AI代理集成各种人类常用的通信渠道(如邮件、Slack、Telegram等),而无需为每个平台单独处理复杂的底层API和基础设施。
核心理念与解决的问题
Caspian SDK解决了一个普遍但耗时的工程问题:每个AI代理项目都需要重复地为不同通信平台编写集成代码(处理认证、消息格式、Webhook验证、重连逻辑等)。它将这些复杂的“管道”工作抽象化,让开发者能专注于代理的核心逻辑。
✨ 主要特性
- 统一API,多渠道支持:通过简单的
cx.channels.add()方法,即可添加 Slack、Discord、Telegram、邮件、WhatsApp、X (Twitter)、短信等渠道。你的消息处理函数 (@cx.on_message) 对所有渠道通用。 - 灵活的部署模式:支持托管模式 (Hosted),由Caspian网关管理入站消息,你的程序轮询事件;也支持自托管模式 (Self-host),所有令牌和Webhook由你掌控,代码无需修改。
- 丰富的交互能力:支持发送富文本(按钮、卡片、媒体)、流式响应 (
thread.stream())、输入状态指示 (thread.typing()) 以及处理按钮点击等交互动作 (@cx.on_action)。 - 多语言支持:同时提供 Python 和 TypeScript/JavaScript 的SDK,方便不同技术栈的开发者使用。
- 自带CLI工具:提供命令行工具
caspian,可用于初始化项目、管理渠道、发送消息和调试。
快速入门
对于使用AI编程助手(如Claude Code, Cursor)的开发者,最快捷的方式是直接向其发送指令,让它根据官方指南自动完成集成:
"Integrate Caspian so my agent can message people on email, Slack, Discord, Telegram, and more. Read https://api.trycaspianai.com/SKILL.md and follow it end to end."
手动安装与使用示例 (Python):
1. 安装:pip install caspian-sdk
2. 获取API Key。
3. 编写代码:
python
from caspian import Caspian
cx = Caspian(api_key="你的API密钥")
# 添加一个Telegram渠道(托管模式)
cx.channels.add("telegram", bot_token="你的Telegram机器人令牌")
# 定义消息处理规则
@cx.on_message({"overlap": "queue"}) # 使用队列处理并发消息
def handle(thread, msg, ctx):
thread.post(f"你说: {msg.text}")
cx.run() # 开始轮询事件
项目结构
仓库主要包含以下部分:
* packages/python:Python SDK (caspian-sdk)。
* packages/typescript:TypeScript SDK (caspian-sdk)。
* packages/cli:命令行工具。
* examples/:各渠道的示例代码。
* README.zh-CN.md:项目的中文README文档。
总结
总的来说,Caspian SDK 是一个为AI代理设计的通信“中间件”。它极大地简化了将AI连接到各种通信平台的过程,通过提供统一的抽象层,让你能构建一个“一次编写,多渠道响应”的智能代理,从而节省大量开发和维护成本。
如果你正在开发需要与用户在多种渠道交互的AI应用,这个项目非常值得关注。如果想了解特定渠道的详细用法或高级功能(如自托管配置),可以查看其examples目录或各子包的README。