n8n 中文文档

Endpoint reference 端点参考

本节是 n8n 公共 REST API 的完整端点参考,基于 OpenAPI 规范生成。你可以用它浏览所有可用操作,并查看参数、请求正文和响应 schema。

该参考与最新的稳定版 n8n 发行版一致。如果你运行的是 beta 版本,较新的端点可能尚未出现在这里。

提示

Feature availability 功能可用性

n8n API 可用于:

  • n8n Cloud: Starter、Pro、Enterprise
  • Self-hosted: 所有版本

免费试用期间无法使用该 API。

Before you start 开始之前

  • Authenticate 身份验证:每个请求都需要 API key。请参阅 Authentication 身份验证。
  • Set your base URL 设置基础 URL:
    • n8n Cloud:https://<your-instance>.app.n8n.cloud/api/v1
    • Self-hosted 自托管:https://<your-domain>/api/v1
  • 对大型结果集进行分页。请参阅 Pagination 分页。
  • 使用 Idempotency-Key header 重试 POST 请求。请参阅幂等性。

Browse the endpoints 浏览端点

端点按资源分组,位于左侧边栏的 n8n API 下:Workflow、Execution、Credential、User、Audit、Tags、Source Control、Variables、Data Table、Projects 等。每个页面都会说明该资源的操作和 schema。

提示

Try the API safely 安全试用 API

要试验实时调用,请使用内置 API playground(仅自托管 n8n),或将请求指向测试工作流或测试实例。

相关资源

不想自己部署和维护 n8n?n8ncn 托管 n8n 云服务:开通账号即可使用,不用买服务器;也可以在 n8ncn 工作流库 找现成的中文工作流。