Skip to content

Bridge REST API

Familiars 后端是单进程 FastAPI bridge(127.0.0.1:18711,默认 HTTPS/HTTP2)。47 个路由文件组成 REST 面,前端与 CLI 都驱动这套端点。本文目录式串联,来源:src/bridge/routes/ + CLAUDE.md。


端点总览(按路由文件)

路由文件前缀覆盖能力
chat.py/api/chat对话流、SSE / 一次问答
tree.py/api/tree对话树节点 CRUD、跳转 / 重放
agents.py/api/agentsAgent 生命周期、设置、内存释放
settings.py/api/settings全局设置读写
cron.py / schedule.py / reminders.py/api/cron /api/schedule /api/reminders定时 / 日程 / 提醒
todo.py/api/todos待办 CRUD
monitor.py / daily.py/api/monitor /api/daily监控 / 主动观察
skills.py/api/skills技能列表 / 执行
tool_skills.py/api/tool-skills工具级技能
digital_human.py/api/digital-human数字人
asr.py/api/asr语音识别
auth.py/api/auth令牌 / 设备认证
usage.py / status.py / health/api/usage /api/status用量 / 运行时状态
reports.py/api/reports日/周/月/年报告
gift.py / cg.py/api/gift /api/cg礼物 / CG 动画
agent_workshop.py/api/agent-workshop导入外部 agent
skill_forge.py / skill_proposals.py / skill_workshop.py/api/skill-*技能锻造 / 审批 / 工坊
recipe(via creative/api/recipe-*配方编译 / 干跑
flows.py / flow_templates.py/api/flows /api/flow-templates流实例 / 流模板
pipeline.py/api/pipeline多 agent 管线
broker.py / broker_workshop.py / broker_app.py/api/broker*交换所 / 市场 / iframe UI
user.py/api/user用户资料
memory_status.py/api/memory-status记忆观测
background.py / phone_call.py / broadcast.py / onboarding.py / responses.py / setup.py各自后台 / 电话 / 广播 / 引导 / 响应生成器 / 初始化
quick_ask.py / draft.py / quick_inputs.py各自快捷问答 / 草稿 / 快捷输入

认证与传输

  • 认证X-Bridge-Token 头(CLI 自动读 workspace/.bridge_token);BridgeTokenMiddleware 全局校验。
  • 传输:默认 HTTPS + HTTP/2(hypercorn + 自签证书)。FAMILIARS_HTTP_INSECURE=1 → HTTP + uvicorn。
  • SSE:对话流是 SSE(text/event-stream),靠 HTTP/2 多路复用避免 6-socket 瓶颈。

典型调用

bash
curl -k -H "X-Bridge-Token: $(cat workspace/.bridge_token)" \
  https://127.0.0.1:18711/api/agents/list

curl -k -N -H "X-Bridge-Token: $(cat workspace/.bridge_token)" \
  -H "Content-Type: application/json" \
  -d '{"type":"chat","content":"你好"}' \
  https://127.0.0.1:18711/api/chat/stream

内省工具src/models/RAG/bridge_api_reflected.py 会用 FastAPI 自动比对「手动目录 vs 实际路由」,无论谁新增路由都应保持诚实。(CLI 覆盖除 UI-only WebSocket 流外的全部 REST。)

✨ Familiars · 多 Agent AI 桌面应用 —— 对话树记忆 · 长期记忆 · 工具系统 · 数字人 · Broker 生态