Meilisearch icon

Meilisearch

Consume Meilisearch API

Actions33

Documents → Delete Batch of Documents

AI-generated

Overview

This node operation deletes a batch of documents from a specified Meilisearch index. It is useful for bulk removal of multiple documents by their IDs in one API call, which can improve efficiency when managing large datasets. For example, you can delete multiple outdated or irrelevant documents from a search index in a single operation.

Use Case Examples

  1. Deleting multiple product entries from an e-commerce search index by providing their document IDs.
  2. Removing a batch of user records from a search index after a data cleanup process.

Properties

Name Meaning
Index UID The unique identifier of the Meilisearch index from which documents will be deleted.
UIDs A JSON array string containing the document IDs to be deleted in batch.
Wait for Completion Whether to wait for the deletion task to complete before returning. If enabled, the node polls the task status until it succeeds, fails, or is canceled.
Use Exponential Backoff If waiting for completion, whether to use exponential backoff for polling intervals to reduce API calls.
Polling Interval (ms) Fixed interval between polling requests in milliseconds, used if exponential backoff is disabled.
Initial Polling Interval (ms) Starting interval between polling requests in milliseconds, increases by 1.5x every 5 attempts if exponential backoff is enabled.
Max Polling Interval (ms) Maximum interval between polling requests when using exponential backoff.
Timeout (seconds) Maximum time to wait for task completion in seconds (default 5 minutes).

Output

JSON

  • taskUid - The unique identifier of the deletion task initiated in Meilisearch.
  • status - The status of the deletion task (e.g., succeeded, failed, canceled).
  • details - Additional details about the task result or error if any.

Dependencies

  • Meilisearch API key credential

Troubleshooting

  • Ensure the Index UID is correct and exists in the Meilisearch instance to avoid 404 errors.
  • Verify the UIDs input is a valid JSON array string of document IDs; malformed JSON will cause errors.
  • If waiting for completion, the node may timeout if the task takes longer than the specified timeout; increase timeout or disable waiting if needed.
  • Check API credentials and host URL configuration if authentication errors occur.

Links

Discussion