Skip to main content
GET
/
api
/
v1
/
indexes
/
{indexName}
/
stats
Get stats of an index
curl --request GET \
  --url https://api.example.com/api/v1/indexes/{indexName}/stats \
  --header 'X-Eigen-API-Key: <api-key>'
{
  "status": 200,
  "message": "Stats for index 'my-index' fetched successfully.",
  "data": {
    "index_name": "my-index",
    "dimensions": 1536,
    "metric": "cosine"
  }
}

Documentation Index

Fetch the complete documentation index at: https://eigendb.mintlify.app/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

​
X-Eigen-API-Key
string
header
required

Path Parameters

​
indexName
string
required

Name of the index

Response

Stats fetched successfully.

​
status
integer
required

Status code of the response

​
message
string
required

Message giving basic information on the response

​
data
object

Important data to be given to the caller

​
error
object

An error that has occured