Meilisearch icon

Meilisearch

Consume Meilisearch API

Actions33

Documents → Get Documents

AI-generated

Overview

This node operation retrieves documents from a specified index in Meilisearch. It allows users to fetch multiple documents with options to filter, sort, limit, and specify fields, among other parameters. This is useful for scenarios where you need to query and extract specific documents from a search index, such as fetching product details, user data, or any indexed content based on custom criteria.

Use Case Examples

  1. Fetch documents from a product catalog index with a limit of 50 results.
  2. Retrieve documents filtered by specific genres or attributes using a filter query.
  3. Get documents sorted by price or release date in ascending or descending order.

Properties

Name Meaning
Index UID The unique identifier (name) of the index from which to retrieve documents.
Additional Fields Optional parameters to customize the document retrieval, including offset, limit, fields to return, filter query, sort order, specific document IDs, and whether to retrieve vector embeddings.

Output

JSON

  • json - The JSON response containing the retrieved documents and their details from the Meilisearch index.

Dependencies

  • Meilisearch API key credential

Troubleshooting

  • Ensure the Index UID is correctly specified and exists in the Meilisearch instance to avoid errors.
  • Verify that filter and sort query strings are correctly formatted to prevent request failures.
  • If retrieving vectors, confirm that the index supports vector embeddings and that the feature is enabled.
  • Common error messages may include authentication failures if the API key is invalid or missing, or request errors if parameters are incorrect. Check credentials and parameter values accordingly.

Links

Discussion