端点参考

本节是根据 OpenAPI 规范生成的 n8n 公共 REST API 完整端点参考。你可以查阅所有可用操作，以及参数、请求体和响应结构。

信息

功能可用范围

以下套餐和版本可以使用 n8n API：

• n8n Cloud： Starter、Pro、Enterprise
• 自托管： 所有版本

免费试用期间无法使用。

开始之前

• 身份验证：每个请求都需要 API 密钥。请参阅身份验证。
• 设置基础 URL：
  • n8n Cloud：https://<your-instance>.app.n8n.cloud/api/v1
  • 自托管：https://<your-domain>/api/v1
• 对大型结果集使用分页。请参阅分页。
• 使用 Idempotency-Key 请求头重试 POST 请求。请参阅幂等性。

浏览端点

左侧边栏的 n8n API 下按资源对端点分组，包括 Workflow（工作流）、Execution（执行）、Credential（凭据）、User（用户）、Audit（审计）、Tags（标签）、Source Control（源代码管理）、Variables（变量）、Data Table（数据表）、Projects（项目）等。每个页面都说明该资源的操作和数据结构。

信息

安全地试用 API

如需尝试实际 API 调用，请使用内置 API 调试界面（仅限自托管 n8n），或将请求发送到测试工作流或测试实例。

相关资源

• n8n API
• 身份验证
• 分页
• 幂等性
• 使用 API 调试界面