Meilisearch icon

Meilisearch

Consume Meilisearch API

Overview

The Meilisearch node for n8n allows you to interact with the Meilisearch API. Specifically, when using the Settings resource and the Get Index Settings operation, this node retrieves the configuration settings of a specified index within your Meilisearch instance. This is useful for inspecting how an index is configured, such as its searchable attributes, filterable fields, ranking rules, and other relevant settings.

Common scenarios:

  • Auditing or debugging index configurations.
  • Automating documentation or monitoring of index settings.
  • Integrating Meilisearch settings into workflows for backup or migration purposes.

Example:
You might use this node in a workflow that checks the settings of all indexes before performing updates, ensuring consistency across environments.

Properties

Name Meaning
UID Name of the index. This is a required option field populated dynamically with available index UIDs from your Meilisearch instance.

Output

The output will be a JSON object containing the settings of the selected index. The structure typically includes (but is not limited to):

{
  "rankingRules": [...],
  "distinctAttribute": "...",
  "searchableAttributes": [...],
  "displayedAttributes": [...],
  "filterableAttributes": [...],
  "sortableAttributes": [...],
  "stopWords": [...],
  "synonyms": {...},
  "pagination": {...}
}
  • Each property reflects a specific aspect of the index's configuration in Meilisearch.
  • No binary data is produced by this operation.

Dependencies

  • External Service: Requires access to a running Meilisearch instance.
  • API Key: You must provide valid Meilisearch credentials (meilisearchApi), including the host_url and an API key with sufficient permissions.
  • n8n Configuration: Ensure the Meilisearch node is properly configured with the correct credentials in n8n.

Troubleshooting

Common issues:

  • Invalid UID: If the provided UID does not correspond to an existing index, the node may return an error indicating the index was not found.
  • Authentication errors: If the API key is missing or invalid, you may receive authentication or authorization errors.
  • Connection errors: Network issues or incorrect host_url can result in connection failures.

Error messages and resolutions:

  • "Index not found": Double-check the UID value; ensure the index exists in your Meilisearch instance.
  • "Unauthorized" or "Invalid API key": Verify your credentials and permissions.
  • "Could not connect to Meilisearch": Check your network connection and the correctness of the host_url.

Links and References

Discussion