Meilisearch icon

Meilisearch

Consume Meilisearch API

Overview

This node integrates with the Meilisearch API, specifically allowing users to retrieve a single document from a specified index. It is useful in scenarios where you need to fetch detailed information about a particular document stored within a Meilisearch index, such as displaying or processing that document's data in a workflow.

Practical examples include:

  • Retrieving user profile data by document ID from a search index.
  • Fetching product details for display or further processing in an e-commerce automation.
  • Accessing specific records for validation or enrichment in data pipelines.

Properties

Name Meaning
Index UID The unique identifier (name) of the index from which to retrieve the document.
Document ID The unique identifier of the document to fetch from the specified index.
Fields Comma-separated list of fields to return for the document. Defaults to all fields (*).

Output

The node outputs JSON data representing the requested document retrieved from the Meilisearch index. The structure corresponds directly to the document's fields as stored in Meilisearch. If the Fields property is set, only those specified fields will be included in the output.

No binary data output is produced by this operation.

Dependencies

  • Requires 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.
  • Proper permissions on the API key to read documents from the specified index are necessary.

Troubleshooting

  • Common issues:

    • Invalid or missing Index UID: Ensure the index name exists and is correctly selected.
    • Incorrect Document ID: Verify the document ID is correct and exists in the index.
    • Insufficient permissions: The API key must have read access to the index.
    • Network or authentication errors: Check the host URL and API key configuration.
  • Error messages:

    • "Document not found": The specified document ID does not exist in the given index.
    • "Unauthorized" or "Forbidden": The API key lacks required permissions.
    • "Index not found": The provided Index UID does not correspond to any existing index.

Resolving these typically involves verifying input values, checking API key scopes, and ensuring connectivity to the Meilisearch server.

Links and References

Discussion