n8n API

通过 OpenClaw 使用 n8n 公开 REST API 进行操作。用于工作流管理、执行及自动化任务,包括列出、创建、发布、触发或排查故障。兼容自托管 n8n 和 n8n Cloud。

安装

概览

什么是n8n API

n8n API 是 OpenClaw 提供的一项核心能力,允许开发者通过 RESTful 接口对 n8n 工作流引擎进行程序化操作。该 API 覆盖了 n8n 用户界面中所有关键功能的核心操作,包括工作流的创建、管理、执行监控以及自动化任务的触发等。它完全兼容自托管的 n8n 实例和 n8n Cloud 服务,为集成外部系统或构建复杂自动化流程提供了统一的编程入口。要使用该 API,用户需要先升级账户以启用 API 访问权限,并在 n8n 设置中生成专用的 API 密钥。所有请求都必须包含一个名为 `X-N8N-API-KEY` 的自定义头部字段,用于身份验证。API 支持丰富的 HTTP 方法(GET、POST 等),并返回结构化的 JSON 数据,便于解析和处理。对于自托管用户,n8n 还提供了交互式 API 游乐场(playground),可在真实数据上安全地测试各种端点。

核心功能特点

  1. 支持工作流的全生命周期管理:列出、创建、激活/停用、删除
  2. 可触发和管理工作流执行,包括重试失败任务
  3. 提供 webhook 触发机制,支持生产环境和测试环境
  4. 支持凭据、标签、项目等资源的管理与查询
  5. 具备执行历史记录查看和错误日志分析功能
  6. 兼容 n8n Cloud 和自托管部署两种模式

适用场景

n8n API 特别适合需要与 n8n 深度集成的自动化场景。例如,在 DevOps 实践中,可以通过 API 自动部署和发布新版本的 n8n 工作流,实现 CI/CD 流水线中的配置即代码(Infrastructure as Code)。运维团队也可利用 API 定期检查工作流健康状态,统计活跃工作流数量和近期失败次数,实现自动化监控告警。对于 SaaS 平台或企业内部工具链,n8n API 可作为统一入口,将 n8n 嵌入到更大的业务流程中,如根据订单系统调用结果自动触发 n8n 工作流处理客户请求。此外,开发者在调试阶段可通过 API 快速重试失败的执行任务,获取详细执行日志,显著提升排查效率。无论是构建企业级自动化平台,还是实现跨系统的数据同步,n8n API 都提供了灵活且强大的后端支撑能力。