n8n 公共 REST API
提示
Feature availability 功能可用性
n8n API 可用于:
- n8n Cloud: Starter、Pro、Enterprise
- Self-hosted: 所有版本
免费试用期间无法使用该 API。
使用 n8n 的公共 API[^1],您可以通过编程方式执行许多与 GUI 中相同的任务。对于支持的 POST 请求,幂等性 key会返回首次成功的响应,而不会再次运行请求。
n8n 提供了 n8n API 节点,供您在工作流中访问 API。
本节内容
- 身份验证:对 n8n API 请求进行身份验证。
- 分页:对大量结果进行分页。
- 幂等性:使用
Idempotency-Keyheader 重试 POST 请求。 - 速率限制:将请求控制在限制范围内,并处理
429响应。 - 使用 API Playground:在内置的 Playground 中试用 API(仅限自托管 n8n)。
- 端点参考:根据 OpenAPI 规范生成的完整端点参考。
选择您的交互方式
REST API(本节)
使用 HTTP 请求直接与 n8n 交互。非常适合: - 定制集成和应用程序 - 与语言无关的 HTTP 调用 - 在工作流中直接使用 REST API
n8n CLI(推荐给开发者)
使用 n8n CLI 获得命令行体验。它封装了公共 API 并针对以下方面进行了优化: - 命令行自动化和脚本编写 - CI/CD 管道集成 - AI 代理集成(Claude Code、Cursor 等) - 喜欢 CLI 工具的开发人员
了解 REST API
API 文档假设您熟悉 REST API。如果您不是,这些资源可能会有所帮助:
- KnowledgeOwl API 使用指南:基本介绍,包括如何调用 REST API 的示例。
- IBM Cloud Learn Hub - What is an Application Programming Interface (API):对 API 进行通用但偏技术的介绍。
- IBM Cloud Learn Hub - 什么是 REST API?:有关 REST API 的更多详细信息。
- MDN 网络文档 - HTTP 概述:REST API 通过 HTTP 工作并使用 HTTP 动词或方法来指定要执行的操作。
提示
Use the API playground 使用 API 游乐场
在 playground 中尝试 API 可以帮助您了解 API 的工作原理。如果您担心更改实时数据,请考虑设置测试工作流程或测试 n8n 实例,以安全地进行探索。
[^1]: API(应用程序编程接口)提供对服务数据和功能的编程访问,让软件更容易与外部系统交互。它通常是通过 Web 浏览器或 UI 访问的传统用户界面的替代方案。
相关资源
不想自己部署和维护 n8n?n8ncn 托管 n8n 云服务:开通账号即可使用,不用买服务器;也可以在 n8ncn 工作流库 找现成的中文工作流。