Overview

This node operation retrieves a single task from the Meilisearch API by its unique identifier (Task UID). It is useful for monitoring the status or details of a specific task that has been submitted to Meilisearch, such as indexing or document operations. For example, after submitting a document indexing task, you can use this operation to check the task's progress or result.

Use Case Examples

1. Retrieve the status of a document indexing task by providing its Task UID.
2. Check details of a specific Meilisearch task to verify if it succeeded or failed.

Properties

Output

JSON

• json
  • status - The status of the task (e.g., succeeded, failed, canceled).
  • taskUid - The unique identifier of the task.
  • type - The type of the task.
  • details - Additional details about the task.
  • duration - Duration of the task execution.
  • enqueuedAt - Timestamp when the task was enqueued.
  • startedAt - Timestamp when the task started.
  • finishedAt - Timestamp when the task finished.

Dependencies

• Meilisearch API key credential

Troubleshooting

• If the task UID is invalid or not provided, the node will throw an error indicating the missing or incorrect parameter.
• If the Meilisearch API credentials are incorrect or missing, authentication will fail and the node will not be able to retrieve the task.
• Network issues or incorrect base URL in credentials can cause HTTP request failures.
• If the task does not complete within a configured timeout (if waiting for completion is enabled), an error will be thrown indicating the timeout.

Links

• Meilisearch API - Get a Task - Official Meilisearch API documentation for retrieving a single task by its UID.