Using the API playground#
The n8n API comes with a built-in Swagger UI playground. This provides interactive documentation, allowing you to try out requests. The path to access the playground depends on your hosting.
For self-hosted users, n8n constructs the path from values set in your environment variables:
For n8n Cloud users, the API playground path contains your cloud instance URL:
The API includes built-in documentation about credential formats. This is available using the
If you click Authorize and enter your API key in the API playground, you have access to your live data. This is useful for trying out requests. However, be aware you can change or delete real data.