API 参考
HTTP API 基于 REST 资源接口 + SSE 事件流。接口定义以 openapi.yaml 为准。
统一约束
- 对外 API:
/api/v1
- 内部模型网关:
/internal/v1/models/*(仅 loopback,无需 Authorization)
- 宿主应用可注入 caller context resolver 接管认证;未注入时使用最小 caller context
- 异步入口(发消息、触发 action)返回
202
- 流式输出走 SSE
- 最终执行状态以 run 资源为准
关键边界:session = 上下文边界,run = 执行边界,同 session 内 run 串行。
端点速查
Workspaces
| 方法 |
路径 |
说明 |
| GET |
/workspace-templates |
列出模板 |
| GET |
/workspaces |
列出 workspace |
| POST |
/workspaces |
创建 workspace |
| POST |
/workspaces/import |
导入 workspace |
| GET |
/workspaces/{id} |
获取详情 |
| DELETE |
/workspaces/{id} |
删除 |
| GET |
/workspaces/{id}/catalog |
获取能力目录 |
| GET |
/workspaces/{id}/history-mirror |
镜像状态 |
| POST |
/workspaces/{id}/history-mirror/rebuild |
重建镜像 |
Files
| 方法 |
路径 |
说明 |
| GET |
/workspaces/{id}/entries |
列出目录条目 |
| DELETE |
/workspaces/{id}/entries |
删除条目 |
| PATCH |
/workspaces/{id}/entries/move |
移动/重命名 |
| GET |
/workspaces/{id}/files/content |
读取文件 |
| PUT |
/workspaces/{id}/files/content |
写入文件 |
| PUT |
/workspaces/{id}/files/upload |
上传二进制 |
| GET |
/workspaces/{id}/files/download |
下载文件 |
| POST |
/workspaces/{id}/directories |
创建目录 |
Sessions & Messages
| 方法 |
路径 |
说明 |
| GET |
/workspaces/{id}/sessions |
列出 session |
| POST |
/workspaces/{id}/sessions |
创建 session |
| GET |
/sessions/{id} |
获取详情 |
| GET |
/sessions/{id}/messages |
列出消息 |
| POST |
/sessions/{id}/messages |
发送消息(202) |
| GET |
/sessions/{id}/events |
SSE 事件流 |
Runs
| 方法 |
路径 |
说明 |
| GET |
/runs/{id} |
获取详情 |
| GET |
/runs/{id}/steps |
列出步骤 |
| POST |
/runs/{id}/cancel |
取消(202) |
Actions
| 方法 |
路径 |
说明 |
| POST |
/workspaces/{id}/actions/{name}/runs |
触发 action(202) |
Models (Internal)
| 方法 |
路径 |
说明 |
| GET |
/model-providers |
列出 provider |
| POST |
/internal/v1/models/generate |
同步生成 |
| POST |
/internal/v1/models/stream |
流式生成 |
模块文档
接口定义以 openapi.yaml 为准。发消息 + 消费流式结果建议配合看 sessions、runs、streaming。