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
import { algoliasearch } from 'algoliasearch';

//
const client = algoliasearch('ALGOLIA_APPLICATION_ID', 'ALGOLIA_API_KEY');

const response = await client.getTask({ indexName: 'theIndexName', taskID: 123 });
Did you find this page helpful?