n8n工作流API

技能简介

该技能通过n8n公开REST API实现程序化操作，支持工作流的创建、发布、激活、触发及执行记录查询，兼容自托管实例与n8n Cloud服务。

业务背景

该技能让业务团队无需登录n8n后台，即可通过程序化管理自动化工作流。适合需要批量监控、定时巡检或集成到现有运维体系的场景，例如自动发现异常工作流、按需触发数据处理任务，降低人工操作成本。

落地案例：运营团队每日需确认核心数据同步工作流是否正常运行。通过调用API获取活跃工作流列表及24小时失败统计，快速定位问题；发现某订单同步流程失败后，直接查询错误执行记录并发起重试，无需登录多个系统排查。Webhook触发能力也支持外部系统在特定事件时主动唤起n8n处理。

能做什么

• 列出、查看、激活或停用工作流
• 触发Webhook（生产环境与测试环境）
• 查询执行记录并按状态筛选
• 重试失败的执行实例
• 汇总健康状态（活跃工作流数、24小时失败数）

使用说明

安装配置

1. 确保n8n账户已升级至付费计划（免费试用期间API不可用）
2. 在n8n后台创建API密钥：Settings → n8n API → Create an API key
3. 设置环境变量：

   export N8N_API_BASE_URL="https://your-instance.app.n8n.cloud/api/v1"
   export N8N_API_KEY="your-api-key-here"

   或写入.n8n-api-config文件

基本调用

所有请求需携带请求头：X-N8N-API-KEY: $N8N_API_KEY

示例：列出工作流

curl -s -H "X-N8N-API-KEY: $N8N_API_KEY" "$N8N_API_BASE_URL/workflows" | jq '.data[] | {id, name, active}'

示例：激活工作流

curl -s -X POST -H "X-N8N-API-KEY: $N8N_API_KEY" -H "Content-Type: application/json" -d '{"versionId":"","name":"","description":""}' "$N8N_API_BASE_URL/workflows/{id}/activate"

示例：查询失败执行

curl -s -H "X-N8N-API-KEY: $N8N_API_KEY" "$N8N_API_BASE_URL/executions?status=error&limit=5"

输入与输出

见下方输入与输出表格。

风险提示

• API playground仅在自托管实例可用，且操作真实数据，建议先用测试工作流验证
• 执行记录可能因实例保留策略被自动清理
• Webhook URL与API URL不同，无需API密钥头部
• 免费试用账户无法调用公共API

来源信息

原始链接：https://github.com/openclaw/skills/tree/main/skills/codedao12/n8n-api/SKILL.md
来源类型：GitHub仓库