跳到主要内容

Linker 工作流编排 API

网关前缀:${API_BASE}/linker/...

后端服务:ai-link-service

核心控制器:

  • WorkflowController/api/workflows
  • TriggerController/api/triggers
  • TaskReportController/api/task

定位与典型场景

AI-Link 提供一个可视化可编排的工作流引擎,用于把

  • AI 能力(LLM、函数调用)
  • 数据能力(查询、写库)
  • 外部系统(HTTP API、消息、Webhook)

串联成可观测、可追踪的业务流程,例如:

  • 审批流(自动判断 + 人工审批)
  • CRM 线索分发、跟进提醒
  • ETL 预处理、AI 质检

核心概念

  • 工作流(Workflow)
    • 节点图,由 Start/End/HTTP/条件/循环/代码/审批/LLM 等节点组成
    • 每个工作流有唯一 apiKey,用于对外执行
  • 触发器(Trigger)
    • 和工作流解耦,可以为同一工作流配置多个触发方式
    • 类型:WEBHOOKCRONMQ
  • 执行(Execution)
    • 每次运行产生一个 executionId,用于追踪日志和审批
  • 人工任务(HumanTask)
    • 工作流中的审批节点会生成待办任务,需要人工操作后再继续流程

工作流管理与执行(/api/workflows)

创建工作流

  • POST /linker/workflows
  • 请求体:Workflow 对象

关键字段:

  • name:工作流名称
  • description:工作流说明
  • nodes:节点数组(包含 start、end、http、approval、llm 等)
  • edges:边数组,描述节点间连线
  • metadata:任意 JSON 元数据

节点的 data/meta 结构会随节点类型变化,推荐通过 Linker 可视化编辑器生成与维护(而不是手写)。

示例:

curl -X POST "${API_BASE}/linker/workflows" \
-H "Authorization: Bearer ${TOKEN}" \
-H "Content-Type: application/json" \
-d '{
"name": "Order Approval Workflow",
"apiKey": "order_approval_v1",
"description": "订单审批流",
"nodes": [],
"edges": []
}'

常用接口清单

  • 创建:POST /linker/workflows
  • 更新:PUT /linker/workflows/<id>
  • 获取详情:GET /linker/workflows/<id>
  • 分页查询:GET /linker/workflows?name=&status=&page=&size=
  • 发布:POST /linker/workflows/<id>/publish
  • 启用:POST /linker/workflows/<id>/activate
  • 停用:POST /linker/workflows/<id>/deactivate
  • 复制:POST /linker/workflows/<id>/copy?newName=<newName>
  • 校验:POST /linker/workflows/validate
  • 执行:POST /linker/workflows/<apiKey>/execute

触发器相关

Linker 的触发器(Triggers)负责把外部事件(Webhook、Cron、MQ 等)接入工作流,引擎会将事件写入触发器的事件收件箱,并按配置启动对应的工作流执行。

详细的触发器接口与事件收件箱说明请参考:

任务运行与人工审批(/api/task)

  • 运行:POST /linker/task/run
  • 恢复:POST /linker/task/resume
  • 查看待办:GET /linker/task/human/pending
  • 完成审批:POST /linker/task/human/<taskId>/complete
  • 报告:GET /linker/task/report?taskID=<executionId>
  • 执行列表:GET /linker/task/executions?tenantId=&workflowId=&status=&userId=&startTime=&endTime=&page=&size=

端到端执行链路

  1. Linker 管理台(可视化)创建并发布工作流
  2. 为工作流配置 Trigger(Webhook / Cron / MQ)
  3. 外部系统调用网关 /linker/... 接口触发工作流
  4. 通过 /linker/task/human/... 系列接口驱动审批节点
  5. 通过 /linker/task/report/linker/task/executions 做运行监控与排错