Meilisearch icon

Meilisearch

Consume Meilisearch API

Actions33

Indexes → Create Index

AI-generated

Overview

This node operation creates a new index in Meilisearch, a powerful search engine. It allows users to specify the index's unique identifier (UID) and an optional primary key attribute. The node supports waiting for the index creation task to complete, with configurable polling intervals and timeout settings. This is useful for workflows that require confirmation that the index is ready before proceeding, such as setting up search infrastructure or automating index management.

Use Case Examples

  1. Creating a new search index with a specific UID and primary key to organize searchable data.
  2. Automating index creation in a data pipeline, waiting for the index to be fully created before adding documents.

Properties

Name Meaning
UID The unique name of the index to be created. This is a required field and identifies the index within Meilisearch.
Primary Key An optional unique attribute of the index that acts as the primary key for documents within the index.
Wait for Completion Whether to wait for the index creation task to complete before returning. If enabled, the node will poll the task status until it succeeds, fails, or is canceled.
Use Exponential Backoff If enabled, the polling interval will gradually increase to reduce API calls during task status polling. If disabled, uses a fixed polling interval.
Polling Interval (ms) Fixed interval between polling requests in milliseconds, used when exponential backoff is disabled.
Initial Polling Interval (ms) Starting interval between polling requests in milliseconds. The interval increases by 1.5x every 5 attempts when exponential backoff is enabled.
Max Polling Interval (ms) Maximum interval between polling requests. Exponential backoff will not exceed this value.
Timeout (seconds) Maximum time to wait for task completion in seconds (default is 5 minutes).

Output

JSON

  • taskUid - The unique identifier of the task created for the index creation operation.
  • status - The status of the task, e.g., 'succeeded', 'failed', or 'canceled'.
  • details - Additional details about the task result or error information if the task failed.

Dependencies

  • Meilisearch API key credential

Troubleshooting

  • If the node times out waiting for task completion, increase the timeout setting or check the Meilisearch server status.
  • Ensure the UID is unique and valid to avoid index creation errors.
  • If polling fails, verify network connectivity and API credentials.
  • Common error messages include task timeout, authentication failure, or invalid parameters. Check credentials and input values.

Links

Discussion