Skip to main content
GET
/
namespaces
/
{namespace}
# Not supported with pinecone["grpc"] extras installed
from pinecone import Pinecone

pc = Pinecone(api_key="YOUR_API_KEY")

index = pc.Index(host="INDEX_HOST")

namespace = index.describe_namespace(namespace="example-namespace")

print(namespace)

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

# Not supported with pinecone["grpc"] extras installed
from pinecone import Pinecone

pc = Pinecone(api_key="YOUR_API_KEY")

index = pc.Index(host="INDEX_HOST")

namespace = index.describe_namespace(namespace="example-namespace")

print(namespace)

{
    "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<int64>

The total amount of records within the namespace.

Example:

20000