Meilisearch icon

Meilisearch

Consume Meilisearch API

Overview

This node interacts with the Meilisearch API to retrieve a list of tasks. Specifically, the "Get All Tasks" operation under the "Tasks" resource fetches multiple task records from Meilisearch, allowing users to filter and paginate through tasks based on various criteria such as status, type, timestamps, and unique identifiers.

Common scenarios for this node include:

  • Monitoring the progress or history of indexing and search-related tasks in Meilisearch.
  • Retrieving specific subsets of tasks for auditing or debugging purposes.
  • Automating workflows that depend on task statuses or types within Meilisearch.

For example, a user might use this node to get all indexing tasks that started after a certain date or to limit the results to the most recent 50 tasks.

Properties

Name Meaning
Additional Fields Collection of optional filters and parameters to refine the task query:
- Limit Max number of results to return (minimum 1, default 50)
- From Fetch the next set of results starting from the given UID (pagination)
- UIDs Comma-delimited list of Task UIDs to filter results by
- Index UIDs Comma-delimited list of Index UIDs to filter results by
- Statuses Comma-delimited list of Task Statuses to filter results by
- Types Comma-delimited list of Task Types to filter results by
- Canceled By Comma-delimited list of Task UIDs that canceled other tasks
- Before Enqueued At Filter tasks enqueued before this datetime
- After Enqueued At Filter tasks enqueued after this datetime
- Before Started At Filter tasks started before this datetime
- After Started At Filter tasks started after this datetime
- Before Finished At Filter tasks finished before this datetime
- After Finished At Filter tasks finished after this datetime

All date/time fields expect ISO 8601 formatted datetime values and are converted internally to JSON date strings.

Output

The node outputs a JSON array of task objects retrieved from Meilisearch. Each task object typically contains details such as:

  • Unique identifier (UID)
  • Associated index UID
  • Task status (e.g., enqueued, processing, succeeded, failed)
  • Task type (e.g., indexing, deletion)
  • Timestamps for enqueuedAt, startedAt, finishedAt
  • Information about cancellation if applicable

If binary data were involved, it would be summarized here; however, this operation deals solely with JSON task data.

Dependencies

  • Requires an active 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.
  • No additional external dependencies beyond the Meilisearch API.

Troubleshooting

  • Empty Results: If no tasks are returned, verify that the filters (UIDs, statuses, types, dates) are correct and that tasks matching those criteria exist.
  • Invalid Date Format: Ensure date/time inputs are valid ISO 8601 strings; otherwise, the API may reject the request.
  • API Connection Errors: Check that the Meilisearch host URL and API key are correctly configured in the node credentials.
  • Limit Exceeded: The 'Limit' property must be at least 1; setting it to zero or negative will cause errors.
  • Malformed Comma Lists: Comma-separated lists should not contain spaces; the node automatically removes spaces but double-check input formatting.

Links and References

Discussion