GET/v1/namespaces/{name}/indexREAD

Collection index state

The current index lifecycle state for one collection — desired vs. active vs. building.

desired_type is what was asked for; active_type and status describe what this node is actually serving right now. In cluster mode, desired_type comes from the Raft-replicated spec and is cluster-wide, while active_type/status are this node's local build state — they can differ while a build propagates across replicas:

{
  "desired_type": "ivf",
  "active_type": "hnsw",
  "status": "building",
  "building_generation": 2,
  "active_generation": 1
}

In standalone mode, desired_type always equals active_type once a build completes — there's only one node.

Parameters

namestringrequired

Collection name (path parameter).

Response fields

collectionstringrequired

The collection name.

active_typestringrequired

The index type currently serving searches: "hnsw", "ivf", "bq", or "none".

statusstringrequired

Current lifecycle status of the active or building generation. The contract does not declare a fixed enum for this field — its own example shows "building" and "active" as observed values; don't treat that as an exhaustive closed set.

desired_typestringoptional

The type that was requested. May differ from active_type while a build is in progress or propagating.

active_generationintegeroptional

The active generation number, if any.

building_generationintegeroptional

If a build is in progress, its generation number.

build_started_atintegeroptional

Unix seconds when the current build started.

base_lsnintegeroptional

The base LSN of the building generation.

errorstringoptional

Human-readable failure reason, if the last build failed.

Errors

Status	`code`	Meaning
`401`	`unauthorized`	Missing or invalid API key.
`403`	`forbidden`	The key's scope doesn't include `read_only`.
`404`	`collection_not_found`	No such collection.

Parameters

Response fields

Errors

Related endpoints