跳到主要内容

流程管理端点

使用 /flows 端点来创建、查询、更新和删除流程。

如果你要运行流程，请参阅流程触发端点。

创建流程​


_20
curl -X POST \
_20
"$SKILLFLAW_URL/api/v1/flows/" \
_20
-H "accept: application/json" \
_20
-H "Content-Type: application/json" \
_20
-H "x-api-key: $SKILLFLAW_API_KEY" \
_20
-d '{
_20
"name": "string2",
_20
"description": "string",
_20
"icon": "string",
_20
"icon_bg_color": "#FF0000",
_20
"gradient": "string",
_20
"data": {},
_20
"is_component": false,
_20
"updated_at": "2024-12-30T15:48:01.519Z",
_20
"webhook": false,
_20
"endpoint_name": "string",
_20
"tags": [
_20
"string"
_20
]
_20
}'

批量创建流程​


_10
curl -X POST \
_10
"$SKILLFLAW_URL/api/v1/flows/batch/" \
_10
-H "accept: application/json" \
_10
-H "Content-Type: application/json" \
_10
-H "x-api-key: $SKILLFLAW_API_KEY" \
_10
-d '{"flows": [...]}'

读取单个流程​


_10
curl -X GET \
_10
"$SKILLFLAW_URL/api/v1/flows/$FLOW_ID" \
_10
-H "accept: application/json" \
_10
-H "x-api-key: $SKILLFLAW_API_KEY"

读取流程列表​

获取流程列表时可以结合分页与筛选参数：


_10
curl -X GET \
_10
"$SKILLFLAW_URL/api/v1/flows/?remove_example_flows=false&components_only=false&get_all=true&header_flows=false&page=1&size=50" \
_10
-H "accept: application/json" \
_10
-H "x-api-key: $SKILLFLAW_API_KEY"

如果你要按项目筛选，可使用 project_id：


_10
curl -X GET \
_10
"$SKILLFLAW_URL/api/v1/flows/?remove_example_flows=true&components_only=false&get_all=false&project_id=$PROJECT_ID&header_flows=false&page=1&size=1" \
_10
-H "accept: application/json" \
_10
-H "x-api-key: $SKILLFLAW_API_KEY"

读取示例流程​


_10
curl -X GET \
_10
"$SKILLFLAW_URL/api/v1/flows/flow_template/" \
_10
-H "accept: application/json" \
_10
-H "x-api-key: $SKILLFLAW_API_KEY"

更新流程​


_13
curl -X PATCH \
_13
"$SKILLFLAW_URL/api/v1/flows/$FLOW_ID" \
_13
-H "accept: application/json" \
_13
-H "Content-Type: application/json" \
_13
-H "x-api-key: $SKILLFLAW_API_KEY" \
_13
-d '{
_13
"name": "string",
_13
"description": "string",
_13
"data": {},
_13
"project_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
_13
"endpoint_name": "my_new_endpoint_name",
_13
"locked": true
_13
}'

每次 PATCH 只会更新你发送的字段。 即使你反复发送相同值，请求仍会触发更新流程。

删除流程​


_10
curl -X DELETE \
_10
"$SKILLFLAW_URL/api/v1/flows/$FLOW_ID" \
_10
-H "accept: application/json" \
_10
-H "x-api-key: $SKILLFLAW_API_KEY"

导出流程​

该端点会根据请求体中的 Flow ID 列表，打包导出 ZIP。


_10
curl -X POST \
_10
"$SKILLFLAW_URL/api/v1/flows/download/" \
_10
-H "accept: application/json" \
_10
-H "Content-Type: application/json" \
_10
-H "x-api-key: $SKILLFLAW_API_KEY" \
_10
-d '[
_10
"e1e40c77-0541-41a9-88ab-ddb3419398b5",
_10
"92f9a4c5-cfc8-4656-ae63-1f0881163c28"
_10
]' \
_10
--output skillflaw-flows.zip

导入流程​

通过上传兼容 SkillFlaw 的 JSON 文件导入流程：


_10
curl -X POST \
_10
"$SKILLFLAW_URL/api/v1/flows/upload/?folder_id=$FOLDER_ID" \
_10
-H "accept: application/json" \
_10
-H "Content-Type: multipart/form-data" \
_10
-H "x-api-key: $SKILLFLAW_API_KEY" \
_10
-F "file=@agent-with-astra-db-tool.json;type=application/json"

如果要指定目标项目，需要通过 folder_id 查询参数提供现有文件夹 / 项目 ID。

说明​

  • GET /api/v1/flows/flow_template/ 用于读取当前可见的流程模板
  • 导入导出流程时，请确保 JSON 结构与当前 SkillFlaw 版本兼容
  • 如果你需要管理流程绑定的项目上下文，请结合项目端点一起使用