n8n 公共 REST API

¥n8n public REST API

Feature availability

n8n API 在免费试用期间不可用。请升级以使用此功能。

¥The n8n API isn't available during the free trial. Please upgrade to access this feature.

使用 n8n 的公共节点 API，你可以以编程方式执行许多与 GUI 中相同的任务。本节介绍 n8n 的 REST API，包括：

¥Using n8n's public API, you can programmatically perform many of the same tasks as you can in the GUI. This section introduces n8n's REST API, including:

• 如何 authenticate

¥How to authenticate

• 分页 搜索结果

¥Paginating results

• 使用 内置 API 演示（仅限自托管 n8n）

¥Using the built-in API playground (self-hosted n8n only)

• 端点参考

¥Endpoint reference

n8n 提供 n8n API 节点 接口，用于在工作流中访问 API。

¥n8n provides an n8n API node to access the API in your workflows.

了解 REST API

¥Learn about REST APIs

本 API 文档假定你熟悉 REST API。如果你还不了解，以下资源或许对你有所帮助：

¥The API documentation assumes you are familiar with REST APIs. If you're not, these resources may be helpful:

• KnowledgeOwl API 使用指南：基本介绍，包括如何调用 REST API 的示例。

¥KnowledgeOwl's guide to working with APIs: a basic introduction, including examples of how to call REST APIs.

• IBM Cloud Learn 中心 - 什么是应用编程接口 (API)？：这篇文档对 API 进行了概括性的技术介绍。

¥IBM Cloud Learn Hub - What is an Application Programming Interface (API): this gives a general, but technical, introduction to APIs.

• IBM Cloud Learn 中心 - 什么是 REST API？：更多关于 REST API 的详细信息。

¥IBM Cloud Learn Hub - What is a REST API?: more detailed information about REST APIs.

• MDN Web 文档 - HTTP 概述：REST API 基于 HTTP 协议，并使用 HTTP 动词（或方法）来指定要执行的操作。

¥MDN web docs - An overview of HTTP: REST APIs work over HTTP and use HTTP verbs, or methods, to specify the action to perform.

Use the API playground

在 playground 中试用 API 可以帮助你了解 API 的工作原理。如果你担心更改实时数据，请考虑设置测试工作流或测试 n8n 实例，以便安全地进行探索。

¥Trying out the API in the playground can help you understand how APIs work. If you're worried about changing live data, consider setting up a test workflow, or test n8n instance, to explore safely.