Skip to main content
POST
Index fullness is also relevant for dedicated read nodes. The response includes memoryFullness and storageFullness alongside indexFullness, which summarizes overall capacity usage. For serverless on-demand indexes, all three values are typically 0 because storage and compute scale automatically. For dedicated indexes, these values indicate when the index needs more capacity. See Scale your index.

Authorizations

Api-Key
string
header
required

An API Key is required to call Pinecone APIs. Get yours from the console.

Headers

X-Pinecone-Api-Version
string
default:2026-07
required

Required date-based version header

Body

application/json

The request for the describe_index_stats operation.

filter
object

If this parameter is present, the operation only returns statistics for vectors that satisfy the filter. See Understanding metadata.

Serverless and Starter indexes do not support filtering describe_index_stats by metadata, and reject a request carrying a non-empty filter.

Response

A successful response.

The response for the describe_index_stats operation.

namespaces
object

A mapping for each namespace in the index from the namespace name to a summary of its contents.

dimension
integer<int64>

The dimension of the indexed vectors. Not specified if sparse index.

Example:

1024

indexFullness
number<float>

The fullness of the index, reported to a granularity of 1% and capped at 1.0. Always 0 for indexes with on-demand read capacity.

Serverless indexes scale automatically as needed, so index fullness is relevant only for pod-based indexes.

The index fullness result may be inaccurate during pod resizing; to get the status of a pod resizing process, use describe_index.

Example:

0.4

totalVectorCount
integer<int64>

The total number of vectors in the index, regardless of whether a metadata filter expression was passed

Example:

80000

metric
string

The metric used to measure similarity.

Example:

"cosine"

vectorType
string

The type of vectors stored in the index.

Example:

"dense"

memoryFullness
number<float>

The amount of memory used by a dedicated index

storageFullness
number<float>

The amount of storage used by a dedicated index