How can I configure an HTTP request to a Weaviate vector database using n8n Cloud?

Below is a blueprint-style approach for making an HTTP request to your vector database (Weaviate) using n8n on the cloud. You can follow similar steps as you’d use for other REST APIs. Note that you’ll need to adjust details such as the method, endpoint, headers, and authentication according to your Weaviate instance’s requirements.

1. Create a new Workflow

Open your n8n Cloud Editor UI and create a new workflow. Name it appropriately, for example “Weaviate HTTP Request”.

2. Add an HTTP Request Node

Drag an HTTP Request node into your workflow. This node is very versatile and can talk to most REST-based APIs (including vector databases).

3. Configure the HTTP Request Node

In the node’s configuration, set the following based on your Weaviate API requirements:

• Method: Choose the appropriate HTTP method (e.g. GET, POST) depending on your endpoint’s specification.
• URL: Enter the API endpoint of your Weaviate instance.
• Authentication:
  • If Weaviate requires an API key or another form of authentication, select the appropriate authentication method.
  • For example, if header authentication is used, toggle on Send Headers and add required header key/value pairs (such as Authorization or an API key header).

Example configuration for headers using Fields Below:

JSONCopied
[
  {
    "name": "Authorization",
    "value": "Your_API_Key_or_Token"
  }
]

• Send Query Parameters / Body (if applicable):
  • If your request needs additional query parameters (to filter or direct the search) or a body for a POST request, configure these options with the provided name/value fields (or JSON).

For example, if you’re sending a POST request with JSON data (such as a vector query), switch the Send Body option to JSON and enter your payload.

4. Test the Node

After configuring, click on the Test button in the HTTP Request node to see if you receive the expected response from your Weaviate API.

• Debug any errors by verifying your API endpoint URL, method, headers, and authentication credentials.
• If your Weaviate instance is behind a firewall or requires specific network considerations, make sure those are addressed in your network configuration.

5. Use the Response data

Upon a successful test, you can continue to process the returned data within your workflow (e.g., with additional nodes to parse JSON or further automate actions).

Additional Tips

• Refer to the HTTP Request Node Documentation:
  The HTTP Request node in n8n lets you set up all of the above. Check out the HTTP Request node docs for deeper insights on configuring parameters, handling authentication, and more.

• Review Your Weaviate API Docs:
  Ensure you check the official Weaviate documentation for details on the expected HTTP request structure, required headers, and the response format.

• Workflow Debugging:
  Use the built-in test step and inspect the outputs. n8n also allows you to log or pass the response further in your workflow for continued processing.

This blueprint should help you set up your HTTP request to Weaviate on n8n Cloud in a straightforward way. Adjust the configuration according to your specific API details and required functionality.