How to Set Up an n8n API with an API Key

steps

1. Log into n8n.
   Start by logging into your n8n account (either cloud or self-hosted).

2. Access account settings.
   Click on the three dots next to your account name in the upper-right corner and select Settings from the dropdown.

3. Navigate to the 'n8n API' section.
   On the side panel of the settings page, find and click n8n API.

4. Create a new API key.

   • Provide a meaningful name for the key.
   • (Optional) Set an expiration date or use "No Expiration."
   • Click Save to generate the key.

5. Save the API key value.

   • Copy the generated API key securely.
   • Never share your API key publicly, as it grants access to your instance.

6. Determine the base URL of your n8n instance.

   • For cloud instances, the URL will look something like https://your-instance-name.n8n.cloud/v1.
   • For self-hosted setups, it should match your deployment domain with the appended path /v1.

7. Input credentials in the NAND node.
   Open a workflow that requires the n8n API. Inside the NAND node settings:

   • In Credentials, select "Create New Credential."
   • Paste the API key and base URL into the corresponding fields.

8. Save and test the setup.

   • Save the credentials and run a basic workflow (e.g., fetching workflows or schema) to ensure proper configuration.

steps

1. Test the integration with a sample workflow.
   Create or open a workflow in n8n and configure it to use the recently added credentials in a NAND node.

2. Fetch and verify data.

   • For example, configure the NAND node to fetch the first five workflows or another dataset.
   • Run the workflow and inspect the output JSON. Confirm it matches the expected data from your account.

3. Troubleshoot if issues arise.

   • Verify the expiration date of the API key.
   • Double-check that the base URL and API key were entered correctly.
   • Review error messages, as they often provide hints about misconfigurations.