API参考
API参考
构建自定义集成、自动化工作流并通过编程方式管理助手。
注意: CollowAI 应用 API 运行在 Railway 上。REST 端点可用于小组件聊天、Webhook 和程序化访问。详情请参阅以下章节。
HTTP端点
以下HTTP端点可用于小组件嵌入和Webhook处理:
POST
/api/chat向助手发送消息并接收AI生成的回复。由可嵌入小组件使用。接受助手ID、用户消息和可选的对话上下文。
POST
/api/webhooks/polar用于Polar.sh支付事件(订阅、发票等)的Webhook接收器。在您的Polar.sh组织设置中配置。
后端API
CollowAI 应用 API 运行在 Railway 上。所有端点均可通过 REST API 访问。常见资源组包括:
助手
创建、更新、删除和查询助手。管理其配置、模型和状态。
对话
列出对话、发送消息并检索任何助手的消息历史。
知识源
上传文档、管理数据库连接并为每个助手配置知识库。
集成
连接和管理第三方集成、查看同步状态并触发手动同步。
小组件配置
配置和检索小组件设置,包括嵌入式聊天的品牌、定位和自定义CSS。
第二大脑
查询结构化知识:从您的文档中提取的实体、事实、主题、关系和冲突。
计费与订阅
查询订阅状态、列出发票并管理账单信息。
客户端SDK使用
对于自定义集成,请直接使用REST API:
# List assistants
curl -H "Authorization: Bearer assai_*" \
https://api.collowai.com/api/v1/assistants
# Create an assistant
curl -X POST \
-H "Authorization: Bearer assai_*" \
-H "Content-Type: application/json" \
-d '{"name": "My Assistant"}' \
https://api.collowai.com/api/v1/assistants
# Get Second Brain stats
curl -H "Authorization: Bearer assai_*" \
https://api.collowai.com/api/v1/assistants/{assistantId}/brain/stats
# List brain entities
curl -H "Authorization: Bearer assai_*" \
https://api.collowai.com/api/v1/assistants/{assistantId}/brain/entities
# List brain facts
curl -H "Authorization: Bearer assai_*" \
https://api.collowai.com/api/v1/assistants/{assistantId}/brain/facts
# List brain topics
curl -H "Authorization: Bearer assai_*" \
https://api.collowai.com/api/v1/assistants/{assistantId}/brain/topics
# List brain relationships
curl -H "Authorization: Bearer assai_*" \
https://api.collowai.com/api/v1/assistants/{assistantId}/brain/relationships
# List brain conflicts
curl -H "Authorization: Bearer assai_*" \
https://api.collowai.com/api/v1/assistants/{assistantId}/brain/conflicts
# Get brain extractions history
curl -H "Authorization: Bearer assai_*" \
https://api.collowai.com/api/v1/assistants/{assistantId}/brain/extractions身份验证
API请求使用从控制面板生成的API密钥进行身份验证(设置 > API密钥)。在Authorization头中包含您的密钥:
Authorization: Bearer YOUR_API_KEY