ClouisleClouisle

工作流执行 API

运行工作流、调用 Webhook、取消任务并订阅执行流

主要端点

方法路径用途
POST/api/v1/workflows/{workflow_id}/run运行已发布工作流
POST/api/v1/workflows/{workflow_id}/debug使用草稿调试
POST/api/v1/workflows/webhook/{webhook_token}通过 Webhook 异步触发
GET/api/v1/workflows/runs/{run_id}/streamSSE 执行事件
POST/api/v1/workflows/runs/{run_id}/cancel取消运行
GET/api/v1/workflows/{workflow_id}/runs/mine查询当前用户运行
GET/api/v1/workflows/{workflow_id}/runs/mine/{run_id}查看运行详情
GET/api/v1/workflows/{workflow_id}/runs/mine/{run_id}/nodes查看节点执行

运行请求

{"inputs":{"query":"检查订单状态"}}

inputs 默认空对象。Webhook 必须携带 API Key,工作流必须已发布且启用 Webhook。初始响应包含 run_idstatusstream_url

运行流

连接 stream_url 获取节点开始、输出、跳过、完成和错误等事件。断线后使用 from_sequence 从已知序号继续;不要重复执行带外部副作用的节点来“补偿”断线。

发布与范围

运行 API Key 需要 workflow:run,目标工作流需要满足团队和可见性规则。草稿只能通过调试端点运行;公开嵌入页按工作流发布配置渲染结果。

这篇文章对你有帮助吗?

本页目录