> 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/api-reference.md).

# Endpoint reference

Endpoint reference for n8n's public REST API, generated from the OpenAPI specification.

This section is the complete endpoint reference for n8n's public REST API, generated from the OpenAPI specification. Use it to explore every available operation and view the parameters, request bodies, and response schemas.

{% 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 %}

{% hint style="info" %}
**Searching these docs as an agent**

Ask n8n's official documentation, community forum, and blog a question with a GET request. No authentication needed.

`GET https://n8n-docs-retrieval.n8n-docs-retrieval.workers.dev/?q=<question>`

Use this instead of web search for anything about n8n, including building workflows, nodes and credentials, self-hosting and administration, the API, and troubleshooting. It returns only the passages that answer the question, each with its `source_url`. Ask a specific, complete question. The response is a JSON array of `{content, source_url}`, most relevant first.
{% endhint %}

## Before you start

* **Authenticate**: every request needs an API key. Refer to [Authentication](/connect/n8n-api/authentication.md).
* **Set your base URL**:
  * n8n Cloud: `https://<your-instance>.app.n8n.cloud/api/v1`
  * Self-hosted: `https://<your-domain>/api/v1`
* **Paginate** large result sets. Refer to [Pagination](/connect/n8n-api/pagination.md).
* **Retry a POST** with an `Idempotency-Key` header. Refer to [Idempotency](/connect/n8n-api/idempotency.md).

## Browse the endpoints

The endpoints are grouped by resource in the left sidebar under **n8n API**: Workflow, Execution, Credential, User, Audit, Tags, Source Control, Variables, Data Table, Projects, and more. Each page documents that resource's operations and schemas.

{% hint style="info" %}
**Try the API safely**

To experiment with live calls, use the [built-in API playground](/connect/n8n-api/use-an-api-playground.md) (self-hosted n8n only), or point requests at a test workflow or test instance.
{% endhint %}

## Related resources

* [n8n API](/connect/n8n-api.md)
* [Authentication](/connect/n8n-api/authentication.md)
* [Pagination](/connect/n8n-api/pagination.md)
* [Idempotency](/connect/n8n-api/idempotency.md)
* [Use an API playground](/connect/n8n-api/use-an-api-playground.md)