n8n 中心

此技能融合了两条路径：

1. 设计：规划可靠的工作流，并可选择性地生成workflow.json文件。
2. 操作：通过公共 REST API 处理工作流/执行。

可用性

• 免费试用计划中禁用了公共 API 访问。
• 需要使用升级计划才能使用该 API。

配置

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

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

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

在以下情况下使用此技能

• 您希望构建一个具备幂等性、重试机制、日志记录和审核队列功能的工作流。
• 您需要可导入的workflow.json文件以及一个操作手册模板。
• 您希望通过API列出、发布、停用或调试工作流/执行。

请勿在以下情况下使用：

• 您需要纯代码自动化，无需n8n。
• 您希望绕过安全控制或隐藏审计追踪。

输入

必需项

• 触发器类型 + 计划/时区
• 成功标准和目标（电子邮件/云端硬盘/数据库）

可选项

• 现有工作流JSON
• 示例负载/记录
• 去重键

输出

• 默认：设计规范（节点、数据契约、故障模式）
• 根据请求：workflow.json+workflow-lab.md（来自assets/workflow-lab.md）

认证头

所有请求必须包含：

X-N8N-API-KEY: $N8N_API_KEY

快速操作（API）

工作流：列表

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}"

工作流：激活或停用

# Activate (publish)
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"

# Deactivate
curl -s -X POST -H "X-N8N-API-KEY: $N8N_API_KEY" \
  "$N8N_API_BASE_URL/workflows/{id}/deactivate"

Webhook触发器

curl -s -X POST "$N8N_API_BASE_URL/../webhook/{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 -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"

设计工作流检查清单

1. 确认触发器类型和计划/时区。
2. 定义输入、输出和验证规则。
3. 选择去重键以保持运行幂等性。
4. 添加可观测性（run_id、日志、状态行）。
5. 添加重试策略和错误分支。
6. 将失败发送至审核队列。
7. 添加防护措施以防止静默失败。

端点索引

参见assets/endpoints-api.md以获取完整的端点列表。

注释与提示

• API调试器仅在自托管的n8n上可用，并使用真实数据。
• n8n API节点可以在工作流程中调用公共API。
• Webhook URL无需API密钥请求头。
• 执行数据可通过保留设置进行清理。