lifecycle.md 1.4 KB

Lifecycle API

HTTP API: 生命周期管理

文档维护规范

  1. 先改文档,再动代码 - 新功能或重大修改需先完成文档更新、并完成审阅后,再进行代码实现
  2. 文档分层,链接代码 - 关键实现需标注代码文件路径;格式:module/file.py:function_name
  3. 简洁快照,日志分离 - 只记录已确认的 API 设计

概述

生命周期管理 API 供外部 Agent 调用,用于:

  • 注册 Trace
  • 查询 Trace 信息
  • 管理 Workspace

实现位置: gateway/api/lifecycle_api.py

基础路径: /api/lifecycle


API 端点

注册 Trace

端点: POST /api/lifecycle/traces/register

用途: 注册新的 Trace

说明: 具体请求/响应格式待设计

查询 Trace 信息

端点: GET /api/lifecycle/traces/{trace_id}

用途: 查询 Trace 的元数据和状态

说明: 具体请求/响应格式待设计

获取 Workspace 路径

端点: GET /api/lifecycle/traces/{trace_id}/workspace

用途: 获取 Trace 的 Workspace 路径

说明: 具体请求/响应格式待设计


相关文档