Tasks

Many operations (index creation, document ingestion, settings updates) are processed asynchronously. These operations return a taskUid you can poll to track progress.

GET/v1/tasks

List all tasks for your project.

Auth admin or search keyReturns 200

Response

{
  "results": [
    {
      "uid": 1,
      "indexUid": "products",
      "status": "succeeded",
      "type": "indexCreation",
      "enqueuedAt": "2025-01-15T08:30:00Z",
      "startedAt": "2025-01-15T08:30:01Z",
      "finishedAt": "2025-01-15T08:30:01Z"
    },
    {
      "uid": 2,
      "indexUid": "products",
      "status": "processing",
      "type": "documentAdditionOrUpdate",
      "enqueuedAt": "2025-01-15T09:00:00Z",
      "startedAt": "2025-01-15T09:00:01Z"
    }
  ]
}

Parameter	Type	Default	Description
`limit`	number	20	Number of tasks to return.
`from`	number	--	Task UID to start from (for pagination).
`statuses`	string	--	Comma-separated list of statuses to filter (e.g. "succeeded,failed").
`types`	string	--	Comma-separated list of task types to filter.
`indexUids`	string	--	Comma-separated list of index UIDs to filter.

GET/v1/tasks/:taskId

Get the status and details of a single task.

Task statuses: enqueued, processing, succeeded, failed.

Auth admin or search keyReturns 200

Response

{
  "uid": 2,
  "indexUid": "products",
  "status": "succeeded",
  "type": "documentAdditionOrUpdate",
  "details": {
    "receivedDocuments": 1500,
    "indexedDocuments": 1500
  },
  "enqueuedAt": "2025-01-15T09:00:00Z",
  "startedAt": "2025-01-15T09:00:01Z",
  "finishedAt": "2025-01-15T09:00:03Z"
}