Meilisearch icon

Meilisearch

Consume Meilisearch API

Overview

The node integrates with the Meilisearch API, specifically providing functionality to list indexes within a Meilisearch instance. This operation is useful for retrieving metadata about all available search indexes, which can then be used for further operations such as querying documents, updating settings, or managing keys.

Common scenarios include:

  • Displaying all indexes in a Meilisearch server to allow users to select one for searching or management.
  • Automating workflows that need to process or monitor multiple indexes.
  • Integrating Meilisearch index data into other systems or dashboards.

Example: A user wants to fetch and display all indexes with pagination support to manage large numbers of indexes efficiently.

Properties

Name Meaning
Additional Fields Optional additional parameters to customize the listing of indexes.
Offset Number of indexes to skip before starting to return results (used for pagination).
Limit Maximum number of indexes to return in the response (controls page size).

Output

The output contains a JSON array representing the list of indexes retrieved from the Meilisearch API. Each item typically includes details such as the index unique identifier, primary key, creation date, and other metadata relevant to each index.

No binary data output is involved in this operation.

Dependencies

  • Requires an active connection to a Meilisearch instance via an API key credential.
  • The node expects the base URL of the Meilisearch server to be configured in the credentials.
  • The Meilisearch API must be accessible from the environment where n8n runs.

Troubleshooting

  • Connection errors: Ensure the Meilisearch host URL and API key are correctly set in the credentials.
  • Empty results: Verify that there are indexes created in the Meilisearch instance; otherwise, the list will be empty.
  • Pagination issues: If using offset and limit, ensure values are positive integers and within valid ranges supported by the API.
  • API errors: Check for proper permissions associated with the API key; insufficient rights may cause authorization failures.

Links and References

Discussion