Skip to main content
GET
/
namespaces
/
{namespace}
PINECONE_API_KEY="YOUR_API_KEY"
INDEX_HOST="YOUR_INDEX_HOST"
NAMESPACE="YOUR_NAMESPACE"  # To target the default namespace, use "__default__".

curl "https://$INDEX_HOST/namespaces/$NAMESPACE" \
    -H "Api-Key: $PINECONE_API_KEY" \
    -H "X-Pinecone-Api-Version: 2025-10"

{
  "name": "example-namespace",
  "record_count": 20000
}

PINECONE_API_KEY="YOUR_API_KEY"
INDEX_HOST="YOUR_INDEX_HOST"
NAMESPACE="YOUR_NAMESPACE"  # To target the default namespace, use "__default__".

curl "https://$INDEX_HOST/namespaces/$NAMESPACE" \
    -H "Api-Key: $PINECONE_API_KEY" \
    -H "X-Pinecone-Api-Version: 2025-10"

{
  "name": "example-namespace",
  "record_count": 20000
}

Authorizations

​
Api-Key
string
header
required

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

Path Parameters

​
namespace
string
required

The namespace to describe.

Response

A description of a namespace.

A description of a namespace, including the name and record count.

​
name
string

The name of the namespace.

Example:

"example-namespace"

​
record_count
integer

The total amount of records within the namespace.

Example:

20000

​
schema
object

Schema for the behavior of Pinecone's internal metadata index. By default, all metadata is indexed; when schema is present, only fields which are present in the fields object with a filterable: true are indexed. Note that filterable: false is not currently supported.

Example:
{
  "fields": {
    "description": { "filterable": true },
    "genre": { "filterable": true },
    "year": { "filterable": true }
  }
}
​
total_count
integer

The total number of namespaces in the index matching the prefix

Example:

25