介绍
{ "text": "# n8n Hub\n\n该技能融合了两条轨道：\n1) **设计**：规划可靠的工作流，并可选择输出 `workflow.json`。\n2) **操作**：通过公共 REST API 处理工作流/执行。\n\n## 可用性\n- 免费试用计划上禁用了公共 API 访问。\n- 使用 API 需要升级计划。\n\n## 配置\n\n建议的环境变量（或存储在 `.n8n-api-config` 中）：\n\n```bash 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" ```\n\n在以下位置创建 API 密钥：n8n 设置 → n8n API → 创建 API 密钥。\n\n## 在以下情况使用本技能\n- 您需要构建具有幂等性、重试、日志记录和审查队列的工作流。\n- 您需要可导入的 `workflow.json` 以及操作手册模板。\- 您希望通过 API 列出、发布、停用或调试工作流/执行。\n\n## 在以下情况不要使用\n- 您需要不依赖 n8n 的纯代码自动化。\n- 您想绕过安全控制或隐藏审计跟踪。\n\n## 输入\n**必需**\n- 触发器类型 + 计划/时区\n- 成功标准和目标（电子邮件/Drive/数据库）\n\n**可选**\n- 现有工作流 JSON\n- 示例负载/记录\n- 去重键\n\n## 输出\n- 默认：设计规范（节点、数据契约、故障模式）\n- 根据请求：`workflow.json` + `workflow-lab.md`（来自 `assets/workflow-lab.md`）\n\n## 认证头\n所有请求必须包含：\n\n``` X-N8N-API-KEY: $N8N_API_KEY ```\n\n## 快速操作 (API)\n\n### 工作流：列表\n```bash curl -s -H "X-N8N-API-KEY: $N8N_API_KEY" "$N8N_API_BASE_URL/workflows" \ | jq '.data[] | {id, name, active}' ```\n\n### 工作流：详情\n```bash curl -s -H "X-N8N-API-KEY: $N8N_API_KEY" "$N8N_API_BASE_URL/workflows/{id}" ```\n\n### 工作流：激活或停用\n```bash # n8n Hub 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" ```\n\n### Webhook 触发器\n```bash curl -s -X POST "$N8N_API_BASE_URL/../webhook/{webhook-path}" \ -H "Content-Type: application/json" \ -d '{"key":"value"}' ```\n\n### 执行：列表\n```bash curl -s -H "X-N8N-API-KEY: $N8N_API_KEY" \ "$N8N_API_BASE_URL/executions?limit=10" \ | jq '.data[] | {id, workflowId, status, startedAt}' ```\n\n### 执行：重试\n```bash 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" ```\n\n## 设计工作流清单\n1. 确认触发器类型和计划/时区。\n2. 定义输入、输出和验证规则。\n3. 选择去重键以保持运行的幂等性。\n4. 添加可观测性（run_id、日志、状态行）。\n5. 添加重试策略和错误分支。\n6. 将失败发送至审查队列。\n7. 添加防护措施以防止静默失败。\n\n## 端点索引\n请参阅 `assets/endpoints-api.md` 以获取完整的端点列表。\n\n## 说明和提示\n- API Playground 仅在自托管 n8n 上可用，并使用真实数据。\n- n8n API 节点可以从工作流内部调用公共 API。\n- Webhook URL 不需要 API 密钥头。\n- 执行数据可能会被保留设置修剪。" }