Actions24
- Documents Actions
- Indexes Actions
- Keys Actions
- Search Actions
- Settings Actions
- Tasks Actions
Overview
The "Get Documents" operation in the "Documents" resource of this Meilisearch node retrieves documents from a specified index within a Meilisearch instance. This operation is useful when you want to fetch stored records or entries from a search index for further processing, analysis, or display.
Common scenarios include:
- Fetching search results or data entries from a specific index.
- Retrieving subsets of documents with pagination controls (offset and limit).
- Selecting specific fields from documents to optimize data transfer and processing.
For example, you might use this node to get the first 50 documents from an index named "products" to display on a website or to analyze product data in an automation workflow.
Properties
| Name | Meaning |
|---|---|
| Index UID | The unique identifier (name) of the index from which to retrieve documents. |
| Additional Fields | A collection of optional parameters to customize the document retrieval: |
| Offset | Number of documents to skip before starting to collect the result set (for pagination). |
| Limit | Maximum number of documents to return in the response. |
| Fields | Comma-separated list of document fields to include in the output. Defaults to all fields (*). |
Output
The node outputs JSON data representing the retrieved documents from the specified index. Each item in the output corresponds to a document with its fields as key-value pairs according to the requested fields.
If binary data were supported, it would typically represent attachments or files associated with documents, but this operation focuses on JSON document data only.
Dependencies
- Requires connection to a Meilisearch server instance.
- Needs an API authentication token or API key credential configured in n8n to authorize requests.
- The base URL of the Meilisearch host must be provided in the credentials configuration.
Troubleshooting
- Missing or incorrect Index UID: If the index name is not provided or misspelled, the node will fail to retrieve documents. Ensure the index exists and the exact UID is used.
- Authentication errors: If the API key or token is invalid or missing, the node will return authorization errors. Verify that the correct credentials are configured.
- Pagination issues: Setting offset or limit values incorrectly (e.g., negative numbers) may cause errors or unexpected results. Use non-negative integers for offset and positive integers for limit.
- Field selection errors: Providing invalid field names in the "Fields" property may result in empty or partial data. Confirm field names exist in the index schema.