Check task status

Checks the status of a given task.

Indexing tasks are asynchronous. When you add, update, or delete records or indices, a task is created on a queue and completed depending on the load on the server.

The indexing tasks’ responses include a task ID that you can use to check the status.

Usage

Required ACL: addObject
1
2
3
4
5
6
7
8
9
import algoliasearch.api.SearchClient
import algoliasearch.extension.SearchClientExtensions

val client = SearchClient(appId = "ALGOLIA_APPLICATION_ID", apiKey = "ALGOLIA_API_KEY")

val response = client.getTask(
  indexName = "ALGOLIA_INDEX_NAME",
  taskID = 123L
)
Did you find this page helpful?