n8n Hub
This skill merges two tracks:
1) Design: plan dependable workflows and optionally emit workflow.json.
2) Operate: handle workflows/executions via the public REST API.
Availability
- - Public API access is disabled on free trial plans.
- An upgraded plan is required to use the API.
Configuration
Suggested environment variables (or store in .n8n-api-config):
CODEBLOCK0
Create an API key at: n8n Settings → n8n API → Create an API key.
Use this skill when
- - You want a workflow built for idempotency, retries, logging, and review queues.
- You need importable
workflow.json plus a runbook template. - You want to list, publish, deactivate, or debug workflows/executions via API.
Do not use when
- - You need pure code automation without n8n.
- You want to bypass security controls or conceal audit trails.
Inputs
Required
- - Trigger type + schedule/timezone
- Success criteria and destinations (email/Drive/DB)
Optional
- - Existing workflow JSON
- Sample payloads/records
- Dedup keys
Outputs
- - Default: design spec (nodes, data contracts, failure modes)
- On request:
workflow.json + workflow-lab.md (from assets/workflow-lab.md)
Auth header
All requests must include:
CODEBLOCK1
Quick actions (API)
Workflows: list
CODEBLOCK2
Workflows: details
CODEBLOCK3
Workflows: activate or deactivate
CODEBLOCK4
Webhook trigger
CODEBLOCK5
Executions: list
CODEBLOCK6
Executions: retry
CODEBLOCK7
Design workflow checklist
- 1. Confirm trigger type and schedule/timezone.
- Define inputs, outputs, and validation rules.
- Choose dedup keys to keep runs idempotent.
- Add observability (run_id, logs, status row).
- Add retry policy and error branches.
- Send failures to a review queue.
- Add guardrails to prevent silent failure.
Endpoint index
See
assets/endpoints-api.md for the complete endpoint list.
Notes and tips
- - The API playground is available only on self-hosted n8n and uses real data.
- The n8n API node can call the public API from within workflows.
- Webhook URLs do not require the API key header.
- Execution data can be pruned by retention settings.
n8n Hub
该技能融合了两条主线：
1) 设计：规划可靠的工作流，并可选择生成 workflow.json。
2) 运维：通过公共 REST API 管理工作流/执行记录。
可用性
- - 免费试用计划禁用公共 API 访问。
- 需升级计划方可使用 API。
配置
建议设置的环境变量（或存储在 .n8n-api-config 文件中）：
bash
export N8NAPIBASE_URL=https://your-instance.app.n8n.cloud/api/v1 # 或 http://localhost:5678/api/v1
export N8NAPIKEY=your-api-key-here
在以下位置创建 API 密钥：n8n 设置 → n8n API → 创建 API 密钥。
适用场景
- - 需要构建具备幂等性、重试机制、日志记录和审核队列的工作流。
- 需要可导入的 workflow.json 及运行手册模板。
- 需要通过 API 列出、发布、停用或调试工作流/执行记录。
不适用场景
- - 需要纯代码自动化且不使用 n8n。
- 试图绕过安全控制或隐藏审计轨迹。
输入
必填项
- - 触发器类型 + 计划/时区
- 成功标准及目标位置（邮件/云盘/数据库）
可选项
输出
- - 默认：设计规范（节点、数据契约、故障模式）
- 按需：workflow.json + workflow-lab.md（来自 assets/workflow-lab.md）
认证头
所有请求必须包含：
X-N8N-API-KEY: $N8NAPIKEY
快速操作（API）
工作流：列表
bash
curl -s -H X-N8N-API-KEY: $N8N
APIKEY $N8N
APIBASE_URL/workflows \
| jq .data[] | {id, name, active}
工作流：详情
bash
curl -s -H X-N8N-API-KEY: $N8N
APIKEY $N8N
APIBASE_URL/workflows/{id}
工作流：激活或停用
bash
激活（发布）
curl -s -X POST -H X-N8N-API-KEY: $N8N
APIKEY \
-H Content-Type: application/json \
-d {versionId:,name:,description:} \
$N8N
APIBASE_URL/workflows/{id}/activate
停用
curl -s -X POST -H X-N8N-API-KEY: $N8N
APIKEY \
$N8N
APIBASE_URL/workflows/{id}/deactivate
Webhook 触发器
bash
curl -s -X POST $N8N
APIBASE_URL/../webhook/{webhook-path} \
-H Content-Type: application/json \
-d {key:value}
执行记录：列表
bash
curl -s -H X-N8N-API-KEY: $N8N
APIKEY \
$N8N
APIBASE_URL/executions?limit=10 \
| jq .data[] | {id, workflowId, status, startedAt}
执行记录：重试
bash
curl -s -X POST -H X-N8N-API-KEY: $N8N
APIKEY \
-H Content-Type: application/json \
-d {loadWorkflow:true} \
$N8N
APIBASE_URL/executions/{id}/retry
设计工作流检查清单
- 1. 确认触发器类型及计划/时区。
- 定义输入、输出及验证规则。
- 选择去重键以保持运行幂等性。
- 添加可观测性（运行ID、日志、状态行）。
- 添加重试策略及错误分支。
- 将失败任务发送至审核队列。
- 添加防护措施防止静默失败。
端点索引
完整端点列表请参见 assets/endpoints-api.md。
注意事项与提示
- - API 沙箱仅适用于自托管 n8n，并使用真实数据。
- n8n API 节点可在工作流内部调用公共 API。
- Webhook URL 无需 API 密钥头。
- 执行数据可通过保留设置进行清理。
