> For the complete documentation index, see [llms.txt](https://docs.n8n.io/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.n8n.io/connect/n8n-api.md).

# n8n API

Use n8n's public REST API to perform tasks programmatically instead of through the GUI.

{% hint style="info" %}
**Feature availability**

The n8n API is available on:

* **n8n Cloud:** Starter, Pro, Enterprise
* **Self-hosted:** All editions

It isn't available on the free trial.
{% endhint %}

Using n8n's public API[^1], you can programmatically perform many of the same tasks as you can in the GUI.

n8n provides an [n8n API node](/integrations/builtin/core-nodes/n8n-nodes-base.n8n.md) to access the API in your workflows.

## In this section

* [Authentication](/connect/n8n-api/authentication.md): how to authenticate requests to the n8n API.
* [Pagination](/connect/n8n-api/pagination.md): paginate large result sets.
* [Use an API playground](/connect/n8n-api/use-an-api-playground.md): try out the API in a built-in playground (self-hosted n8n only).
* [Endpoint reference](/connect/n8n-api/api-reference.md): the complete endpoint reference, generated from the OpenAPI specification.

## Choose your interaction method <a href="#choose-your-interaction-method" id="choose-your-interaction-method"></a>

### REST API (this section) <a href="#rest-api-this-section" id="rest-api-this-section"></a>

Interact with n8n directly using HTTP requests. Ideal for:

* Custom integrations and applications
* Language-agnostic HTTP calls
* Direct REST API usage in workflows

### n8n CLI (recommended for developers) <a href="#n8n-cli-recommended-for-developers" id="n8n-cli-recommended-for-developers"></a>

Use [n8n CLI](/connect/n8n-cli.md) for a command-line experience. It wraps the public API and is a good fit for:

* Command-line automation and scripting
* CI/CD pipeline integration
* AI agent integration (Claude Code, Cursor, etc.)
* Developers who prefer CLI tools

## Learn about REST APIs <a href="#learn-about-rest-apis" id="learn-about-rest-apis"></a>

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

* [KnowledgeOwl's guide to working with APIs](https://support.knowledgeowl.com/help/working-with-apis): a basic introduction, including examples of how to call REST APIs.
* [IBM Cloud Learn Hub - What is an Application Programming Interface (API)](https://www.ibm.com/cloud/learn/api): this gives a general, but technical, introduction to APIs.
* [IBM Cloud Learn Hub - What is a REST API?](https://www.ibm.com/cloud/learn/rest-apis): more detailed information about REST APIs.
* [MDN web docs - An overview of HTTP](https://developer.mozilla.org/en-US/docs/Web/HTTP/Overview): REST APIs work over HTTP and use HTTP verbs, or methods, to specify the action to perform.

{% hint style="info" %}
**Use the API playground**

Trying out the API in the [playground](/connect/n8n-api/use-an-api-playground.md) 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.
{% endhint %}

## Related resources

* [Connect](/connect/readme.md)
* [n8n CLI](/connect/n8n-cli.md)
* [Connect to n8n MCP server](/connect/connect-to-n8n-mcp-server.md)
* [Connect to the n8n docs MCP server](/connect/connect-to-n8n-docs-mcp-server.md)
* [Create nodes](/connect/create-nodes.md)

[^1]: APIs, or application programming interfaces, offer programmatic access to a service's data and functionality. APIs make it easier for software to interact with external systems. They're often offered as an alternative to traditional user-focused interfaces accessed through web browsers or UI.