n8n 工作流管理

通过 REST API 与 n8n 自动化平台交互。

配置

首次配置：

1. 安装依赖（虚拟环境）：

cd skills/n8n-1.0.2
python3 -m venv .venv
source .venv/bin/activate
pip install -r requirements.txt

2. 在 ~/.zshrc（或 ~/.bashrc）中配置环境变量：

export N8N_API_KEY="your-api-key-here"
export N8N_BASE_URL="https://your-n8n-instance.com"

3. 重载 Shell 并验证连接：

source ~/.zshrc
./skills/n8n-1.0.2/scripts/n8n.sh list-workflows --pretty

提示：在 n8n UI 中获取 API 密钥：设置 → API

快速参考

列出工作流

./scripts/n8n.sh list-workflows --pretty
./scripts/n8n.sh list-workflows --active true --pretty

获取工作流详情

./scripts/n8n.sh get-workflow --id  --pretty

启用/停用工作流

./scripts/n8n.sh activate --id 
./scripts/n8n.sh deactivate --id 

执行记录

# 列出最近的执行记录
./scripts/n8n.sh list-executions --limit 10 --pretty

# 获取执行详情
./scripts/n8n.sh get-execution --id  --pretty

# 按工作流筛选
./scripts/n8n.sh list-executions --id  --limit 20 --pretty

手动执行

# 触发工作流
./scripts/n8n.sh execute --id 

# 带输入数据执行
./scripts/n8n.sh execute --id  --data '{"key": "value"}'

Python API

如需编程方式调用：

from scripts.n8n_api import N8nClient

client = N8nClient()

# 列出工作流
workflows = client.list_workflows(active=True)

# 获取工作流
workflow = client.get_workflow('workflow-id')

# 启用/停用工作流
client.activate_workflow('workflow-id')
client.deactivate_workflow('workflow-id')

# 执行记录
executions = client.list_executions(workflow_id='workflow-id', limit=10)
execution = client.get_execution('execution-id')

# 执行工作流
result = client.execute_workflow('workflow-id', data={'key': 'value'})

常见任务

调试失败的工作流

1. 列出含失败记录的最近执行
2. 获取执行详情以查看错误信息
3. 检查工作流配置
4. 如有必要，停用该工作流

监控工作流健康状态

1. 列出所有启用中的工作流
2. 检查最近执行的状态
3. 分析错误模式

工作流管理

1. 列出全部工作流
2. 审查各工作流的启用/停用状态
3. 按需启用或停用工作流
4. 删除过期的工作流

API 参考文档

详细的 API 文档请参阅 references/api.md。

故障排查

认证错误：

• 确认已正确设置 N8N_API_KEY：运行 echo $N8N_API_KEY
• 在 n8n UI 中检查 API 密钥是否有效

连接错误：

• 若使用自定义地址，请检查 N8N_BASE_URL 是否配置正确

命令执行错误：

• 使用 --pretty 参数获得格式化输出
• 确保在需要时提供了 --id 参数
• 验证 --data 参数传入的 JSON 格式是否合法