Meilisearch icon

Meilisearch

Consume Meilisearch API

Overview

This node integrates with the Meilisearch API to perform various operations related to search engine management. Specifically, for the "Tasks" resource and the "Get A Single Task" operation, it retrieves detailed information about a single asynchronous task executed in Meilisearch. This is useful for monitoring the status and results of tasks such as index updates, document additions, or settings changes.

Common scenarios include:

  • Checking the completion status of an indexing task.
  • Retrieving error details if a task failed.
  • Auditing recent operations performed on the Meilisearch instance.

Example: After submitting a document update task, use this node to poll and confirm when the task has completed successfully.

Properties

Name Meaning
Task UID The unique identifier (number) of the task to retrieve. Must be a positive integer (≥1).

Output

The node outputs JSON data representing the details of the requested task. This typically includes fields such as:

  • Task unique ID
  • Status (e.g., enqueued, processing, succeeded, failed)
  • Type of task performed
  • Duration and timestamps
  • Any error messages if the task failed

No binary data output is produced by this operation.

Dependencies

  • Requires an active connection to a Meilisearch instance.
  • Needs an API key credential configured in n8n to authenticate requests.
  • The base URL of the Meilisearch server must be provided via credentials.

Troubleshooting

  • Invalid Task UID: If the provided Task UID does not exist or is invalid, the API will return an error. Ensure the UID is correct and corresponds to an existing task.
  • Authentication Errors: Missing or incorrect API key credentials will cause authentication failures. Verify that the API key is correctly set up in n8n.
  • Network Issues: Connectivity problems to the Meilisearch server can cause request failures. Check network access and server availability.
  • API Version Mismatch: Using incompatible versions of Meilisearch may result in unexpected errors. Confirm compatibility between the node and your Meilisearch version.

Links and References

Discussion