API to create workflows, confused on what paramters are required for different integrations

Describe the problem/error/question

I am trying to use the node api in order to create workflows from within my own application, however the documentation on how to create a workflow is excessively bare, only showing one brief use case for JIRA

Here is the the docs:

I am wondering how I can create workflows from the api and wanted more robust explanation as to how. please respond at your earliest convenience.

What is the error message (if any)?

Please share your workflow

(Select the nodes on your canvas and use the keyboard shortcuts CMD+C/CTRL+C and CMD+V/CTRL+V to copy and paste the workflow.)

Share the output returned by the last node

Information on your n8n setup

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

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:

Hi @Sasank_Aduri, welcome to the community!

To create a more complex workflow using the API I’d suggest you first create the workflow type you have in mind through the UI.

Then read the example workflow through the REST API (GET http://localhost:5678/api/v1/workflows/$workflowID) and copy the nodes and and connections values from the response.

You can then use these values instead of the examples ones from the documentation when creating additional workflows through the API.