POST
/
describe_index_stats
PINECONE_API_KEY="YOUR_API_KEY"
INDEX_HOST="INDEX_HOST"

curl -X POST "https://$INDEX_HOST/describe_index_stats" \
  -H "Api-Key: $PINECONE_API_KEY"
{
  "namespaces": {
    "ns1": {
      "vectorCount": 4
    },
    "ns2": {
      "vectorCount": 4
    }
  },
  "dimension": 8,
  "indexFullness": 0.00008,
  "totalVectorCount": 8
}

Authorizations

Api-Key
string
headerrequired

An API Key is required to call Pinecone APIs. Get yours at https://app.pinecone.io/.

Body

application/json
filter
object

If this parameter is present, the operation only returns statistics for vectors that satisfy the filter. See https://www.pinecone.io/guides/data/filtering-with-metadata.

Response

200 - application/json
dimension
integer

The dimension of the indexed vectors.

indexFullness
number

The fullness of the index, regardless of whether a metadata filter expression was passed. The granularity of this metric is 10%.

namespaces
object

A mapping for each namespace in the index from the namespace name to a summary of its contents. If a metadata filter expression is present, the summary will reflect only vectors matching that expression.

totalVectorCount
integer