Meilisearch icon

Meilisearch

Consume Meilisearch API

Overview

This node integrates with the Meilisearch API, specifically allowing users to retrieve settings for a given search index. The "Get Index Settings" operation under the "Settings" resource fetches configuration details of a specified index by its unique identifier (UID). This is useful when you want to inspect or audit the current settings of an index, such as ranking rules, synonyms, stop-words, or other search-related configurations.

Practical examples include:

  • Verifying the current search behavior of an index before updating it.
  • Debugging search relevance issues by checking index settings.
  • Automating monitoring or reporting on index configurations.

Properties

Name Meaning
UID Name of the index whose settings you want to retrieve. This is a required field and must be selected from existing indexes available in your Meilisearch instance.

The UID property is presented as an options dropdown that dynamically loads available indexes by querying the /indexes endpoint of the Meilisearch API.

Output

The node outputs JSON data representing the settings of the specified index. This includes all configurable parameters related to the index's search behavior, such as ranking rules, searchable attributes, displayed attributes, synonyms, stop-words, and more depending on what Meilisearch exposes.

No binary data output is involved in this operation.

Dependencies

  • Requires connection to a Meilisearch instance via an API host URL.
  • Needs an API key credential configured in n8n to authenticate requests against the Meilisearch API.
  • The node depends on the Meilisearch REST API being accessible and responsive at the provided host URL.

Troubleshooting

  • Common Issues:

    • If the UID is not selected or invalid, the node will fail to retrieve settings.
    • Network connectivity problems or incorrect host URL/API key will cause authentication or connection errors.
    • If the specified index does not exist, the API will return an error indicating the index was not found.
  • Error Messages:

    • 404 Not Found: The index UID does not exist. Verify the index name.
    • 401 Unauthorized: Invalid or missing API key. Check credentials configuration.
    • Network Errors: Ensure the Meilisearch server is reachable from n8n.

Resolving these typically involves verifying the index UID, ensuring correct API credentials, and confirming network access.

Links and References

Discussion