Actions24
- Documents Actions
- Indexes Actions
- Keys Actions
- Search Actions
- Settings Actions
- Tasks Actions
Overview
This node provides integration with the Meilisearch API, specifically for operations related to "Documents". In the context of Meilisearch, documents are the primary data entities stored within an index. This node allows users to interact with documents in a specified index—such as adding, updating, or retrieving them—by selecting the appropriate operation.
Common scenarios where this node is beneficial include:
- Automating the process of indexing new content into Meilisearch from other systems.
- Keeping search indexes up-to-date by synchronizing document changes.
- Retrieving or managing documents programmatically as part of larger n8n workflows.
Practical examples:
- Automatically add new blog posts to a Meilisearch index when published.
- Update product information in Meilisearch whenever inventory changes.
- Retrieve all documents from a specific index for reporting or backup purposes.
Properties
Name | Meaning |
---|---|
Index UID | Name of the index. This is a required field and determines which Meilisearch index the operation targets. |
Output
The output will be a JSON object containing the result of the document-related operation performed on the specified index. The structure of the output depends on the specific operation (e.g., add, update, get), but typically includes fields such as:
- Task status or ID (for asynchronous operations)
- Document data (for retrieval operations)
- Error messages (if the operation fails)
If the node supports binary output (e.g., exporting documents), it would summarize the exported data, but based on the provided information, the output is primarily JSON.
Dependencies
- External Service: Requires access to a running Meilisearch instance.
- API Key: Needs valid Meilisearch API credentials configured in n8n under the name
meilisearchApi
. - n8n Configuration: The Meilisearch host URL must be set in the credentials (
host_url
).
Troubleshooting
Common issues:
- Invalid Index UID: If the specified index does not exist, the operation will fail. Ensure the "Index UID" matches an existing index in your Meilisearch instance.
- Authentication Errors: Missing or incorrect API key/host URL will result in authentication failures.
- Network Issues: Connectivity problems between n8n and Meilisearch can cause timeouts or connection errors.
Error messages and resolutions:
"Index not found"
: Double-check the "Index UID" value."Unauthorized"
or"Invalid API key"
: Verify your Meilisearch API credentials in n8n."Connection refused"
: Ensure the Meilisearch server is running and accessible from n8n.