名称： n8n-api
描述： 通过 OpenClaw 操作 n8n 的公共 REST API。用于工作流管理、执行记录查看和自动化任务，例如列出、创建、发布、触发工作流或进行故障排查。支持自托管 n8n 和 n8n Cloud。

n8n 公共 REST API

当您需要通过编程方式驱动 n8n 时，可使用此技能。它涵盖了您在用户界面中使用的核心操作：工作流、执行记录、标签、凭据、项目等。

可用性

• 免费试用期间，公共 API 不可用。
• 请升级您的订阅计划以启用 API 访问。

配置

推荐的环境变量（或存储在 .n8n-api-config 文件中）：

export N8N_API_BASE_URL="https://your-instance.app.n8n.cloud/api/v1"  # 或 http://localhost:5678/api/v1
export N8N_API_KEY="your-api-key-here"

在以下位置创建 API 密钥：n8n 设置 → n8n API → 创建 API 密钥。

认证请求头

所有请求都需要包含此请求头：

X-N8N-API-KEY: $N8N_API_KEY

API 测试平台

API 测试平台仅在自托管的 n8n 实例上可用，并且操作的是真实数据。为了安全地进行实验，请使用测试工作流或单独的测试实例。

快速操作

工作流：列表

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

工作流：详情

curl -s -H "X-N8N-API-KEY: $N8N_API_KEY" "$N8N_API_BASE_URL/workflows/{id}"

工作流：激活或停用

# 激活（发布）
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 -X POST -H "X-N8N-API-KEY: $N8N_API_KEY" \
  "$N8N_API_BASE_URL/workflows/{id}/deactivate"

触发 Webhook

# 生产环境 Webhook
curl -s -X POST "$N8N_API_BASE_URL/../webhook/{webhook-path}" \
  -H "Content-Type: application/json" \
  -d '{"key":"value"}'

# 测试环境 Webhook
curl -s -X POST "$N8N_API_BASE_URL/../webhook-test/{webhook-path}" \
  -H "Content-Type: application/json" \
  -d '{"key":"value"}'

执行记录：列表

# 最近执行记录
curl -s -H "X-N8N-API-KEY: $N8N_API_KEY" \
  "$N8N_API_BASE_URL/executions?limit=10" \
  | jq '.data[] | {id, workflowId, status, startedAt}'

# 仅失败记录
curl -s -H "X-N8N-API-KEY: $N8N_API_KEY" \
  "$N8N_API_BASE_URL/executions?status=error&limit=5"

执行记录：重试

curl -s -X POST -H "X-N8N-API-KEY: $N8N_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"loadWorkflow":true}' \
  "$N8N_API_BASE_URL/executions/{id}/retry"

常用流程

健康检查摘要

统计活跃工作流数量和近期失败次数：

ACTIVE=$(curl -s -H "X-N8N-API-KEY: $N8N_API_KEY" \
  "$N8N_API_BASE_URL/workflows?active=true" | jq '.data | length')

FAILED=$(curl -s -H "X-N8N-API-KEY: $N8N_API_KEY" \
  "$N8N_API_BASE_URL/executions?status=error&limit=100" \
  | jq '[.data[] | select(.startedAt > (now - 86400 | todate))] | length')

echo "活跃工作流: $ACTIVE | 24小时内失败次数: $FAILED"

调试失败运行

1. 列出失败执行记录以获取执行 ID。
2. 获取执行详情并识别失败的节点。
3. 检查节点参数和输入数据。
4. 根据错误信息建议修复方案。

端点索引

完整端点列表请参见 assets/n8n-api.endpoints.md。

REST 基础（可选）

如需回顾基础知识，以下资源常被推荐：
- KnowledgeOwl: working with APIs (intro)
- IBM Cloud Learn Hub: what is an API / REST API
- MDN: overview of HTTP

注意事项与提示

• n8n API 节点可以从工作流内部调用此公共 API。
• Webhook URL 与 API URL 不同，且不使用 API 密钥请求头。
• 执行记录可能会根据实例的保留设置被清理。