API 参考
Jarvis API 主要供本地 UI、桌面壳、移动入口和自动化使用。公开文档只描述稳定、用户可依赖的接口边界。
基础信息
标题为“基础信息”的章节- 默认本地来源：
http://127.0.0.1:8888 - API 前缀：
/api/v1 - 健康检查：
GET /api/v1/health - 认证：使用本地生成的
JARVIS_API_KEY
向受保护接口发送请求时，带上 API 密钥。具体请求头以当前后端实现为准；不要把真实密钥写进文档、issue 或截图。
常用资源
标题为“常用资源”的章节| 资源 | 用途 |
|---|---|
| 健康检查 | 判断后端是否运行、版本是否正确 |
| 聊天接口 | 创建消息、流式接收主聊天回复 |
| 编码会话接口 | 列出会话、查看状态、派发后续工作 |
| 设置接口 | 读取或更新本地配置与模型池设置 |
| 远程访问接口 | 管理移动端或隧道相关状态 |
SSE 与流式响应
标题为“SSE 与流式响应”的章节主聊天和部分会话事件通过 SSE 或 WebSocket 等流式通道暴露。需要处理断线、重连和事件顺序，不要假设一次连接永远存在。
错误处理
标题为“错误处理”的章节客户端应区分：
- 未认证或密钥过期；
- 后端不可达；
- 模型提供商不可用；
- 运行时不可用；
- 会话不存在或已结束。
错误信息可以用于 UI 提示，但不要把内部堆栈或私有路径直接展示给外部用户。
版本边界
标题为“版本边界”的章节API 随 Jarvis 版本演进。发布或排障时先确认 /api/v1/health 返回的版本，与当前文档和应用版本一致。