Meilisearch icon

Meilisearch

Consume Meilisearch API

Overview

This node integrates with the Meilisearch API, specifically allowing users to add or replace documents within a specified index. It is useful in scenarios where you need to update search indexes dynamically by inserting new documents or completely replacing existing ones. For example, if you maintain a product catalog and want to keep your search index up-to-date with the latest product information, this node can push JSON-formatted documents directly into the Meilisearch index.

Properties

Name Meaning
Index UID The unique identifier (name) of the Meilisearch index where documents will be added/replaced. This must be selected from existing indexes.
Documents JSON A JSON string representing one or more documents to add or replace in the index. Must be valid JSON. Examples include serializing current input data or using JMESPath expressions to gather multiple items.

Output

The node outputs JSON data reflecting the response from the Meilisearch API after attempting to add or replace documents. This typically includes status information about the operation such as update IDs or task statuses. There is no binary output associated with this operation.

Dependencies

  • Requires an active connection to a Meilisearch instance.
  • Needs an API key credential for authentication to the Meilisearch server.
  • The base URL of the Meilisearch host must be configured in the node credentials.
  • The node depends on the Meilisearch REST API endpoints for indexes and documents.

Troubleshooting

  • Invalid JSON Error: If the "Documents JSON" property contains malformed JSON, the node will fail. Ensure the JSON string is correctly formatted.
  • Index Not Found: Selecting an invalid or non-existent Index UID will cause errors. Make sure the index exists in Meilisearch before running the node.
  • Authentication Errors: Missing or incorrect API keys will result in authorization failures. Verify that the API key credential is properly set.
  • Network Issues: Connection problems to the Meilisearch host URL will prevent the node from working. Check network connectivity and host URL correctness.

Links and References

Discussion