Create API docs for your workflow

I want to build API documentation for my workflow so others can use it.

  1. Is it possible?
  2. Can the URLs be custom without including n8n in the url. (example below)

P.S. I’m new to n8n, go easy with the advanced lingo :sweat_smile:

It looks like your topic is missing some important information. Could you provide the following if applicable.

  • n8n version:
  • Database (default: SQLite):
  • n8n EXECUTIONS_PROCESS setting (default: own, main):
  • Running n8n via (Docker, npm, n8n cloud, desktop app):
  • Operating system:

First, if you’re planning on charging for access it likely isn’t allowed under n8n’s license.

Are you on the cloud plan? If you’re self hosted you could make the link whatever you want.

There is a very easy way to do this though and it works on cloud or self hosted. Simply use http redirects.

Buy any domain you want. If you’re making a cookie recipe API then buy a domain like tastycookiez.com. Then simply add any redirects to the webhook url.
so you could configure api.tastycookiez.com/chocolate-chip to go to n8n.yourUrl.com/webhook/dfgkjdnfgd.

It will work as expected. You can use a tool like postman to test.
Just know people will be able to see your n8ns base url if they look for it

2 Likes

Thank you Liam!

This topic was automatically closed 7 days after the last reply. New replies are no longer allowed.