跳到主要内容

Build 端点

信息

/build 端点主要供 SkillFlaw 前端可视化编辑器与仓库开发者工具使用。 它们属于内部编排 API，不是应用集成时推荐使用的运行接口。 如果你要在应用中运行流程，请优先使用流程触发端点。

/build 端点用于支持 SkillFlaw 编辑器构建流程并返回执行事件。 如果你正在参与 SkillFlaw 仓库开发，理解这些端点会很有帮助。

构建流程并获取事件​

典型调用顺序如下：

  1. POST /api/v1/build/{flow_id}/flow 启动构建任务
  2. 拿到 job_id
  3. GET /api/v1/build/{job_id}/events 流式读取或轮询执行事件

已认证的 build 路由要求存在活跃用户会话，或使用其他可接受的认证方式（如 API Key）。

启动构建​


_10
curl -X POST \
_10
"$SKILLFLAW_URL/api/v1/build/$FLOW_ID/flow" \
_10
-H "accept: application/json" \
_10
-H "Content-Type: application/json" \
_10
-H "x-api-key: $SKILLFLAW_API_KEY" \
_10
-d '{
_10
"inputs": {
_10
"input_value": "Tell me a story"
_10
}
_10
}'

获取构建事件​


_10
curl -X GET \
_10
"$SKILLFLAW_URL/api/v1/build/123e4567-e89b-12d3-a456-426614174000/events" \
_10
-H "accept: application/json" \
_10
-H "x-api-key: $SKILLFLAW_API_KEY"

GET /api/v1/build/{job_id}/events 支持 event_delivery 查询参数：

  • streaming：默认值，保持长连接流式输出
  • polling：按 NDJSON 拉取
  • direct：在 POST /build/{flow_id}/flow 时直接返回事件流

例如使用轮询模式：


_10
curl -X GET \
_10
"$SKILLFLAW_URL/api/v1/build/123e4567-e89b-12d3-a456-426614174000/events?event_delivery=polling" \
_10
-H "accept: application/json" \
_10
-H "x-api-key: $SKILLFLAW_API_KEY"

Build 请求头​

Header说明示例
Content-Type必填，JSON 格式application/json
accept可选，期望响应格式application/json
x-api-key自动化场景下可作为认证头sk-...

Build 参数​

参数类型说明
inputsobject可选，传给流程组件的输入值
dataobject可选，直接覆盖数据库里存储的流程配置
filesarray[string]可选，执行时使用的文件路径列表
start_component_idstring可选，从指定组件开始执行
stop_component_idstring可选，在指定组件处停止执行
log_buildsBoolean是否记录构建日志，默认 true
flow_namestring可选，供内部工具覆盖流程名
event_deliverystring可选，polling / streaming / direct

设置开始点与停止点​

start_component_id 与 stop_component_id 可以控制执行区间。 例如，如果设置 stop_component_id，行为类似编辑器中的 Run component：会执行到该组件为止，以及它所依赖的上游组件。


_10
curl -X POST \
_10
"$SKILLFLAW_URL/api/v1/build/$FLOW_ID/flow" \
_10
-H "accept: application/json" \
_10
-H "Content-Type: application/json" \
_10
-H "x-api-key: $SKILLFLAW_API_KEY" \
_10
-d '{"stop_component_id": "OpenAIModel-Uksag"}'

用 data 覆盖流程参数​

/build 也支持直接传入 data，从而覆盖数据库中的流程结构：


_15
curl -X POST \
_15
"$SKILLFLAW_URL/api/v1/build/$FLOW_ID/flow" \
_15
-H "accept: application/json" \
_15
-H "Content-Type: application/json" \
_15
-H "x-api-key: $SKILLFLAW_API_KEY" \
_15
-d '{
_15
"data": {
_15
"nodes": [],
_15
"edges": []
_15
},
_15
"inputs": {
_15
"input_value": "Your custom input here",
_15
"session": "session_id"
_15
}
_15
}'

其他 Build 相关端点​

SkillFlaw 还暴露了与模板构建和公共流程构建相关的端点：

  • POST /api/v1/build/template/{template_id}/flow
  • GET /api/v1/build/template/{build_id}/events
  • POST /api/v1/build/{job_id}/cancel
  • POST /api/v1/build/template/{build_id}/cancel
  • POST /api/v1/build_public_tmp/{flow_id}/flow
  • GET /api/v1/build_public_tmp/{job_id}/events
  • POST /api/v1/build_public_tmp/{job_id}/cancel

其中 build_public_tmp 专门服务于公共流程执行，不使用与认证编辑器路由完全相同的认证要求。

另请参阅​