Skip to main content
GET
/
namespaces
/
{namespace}
from pinecone import Pinecone

pc = Pinecone(api_key="YOUR_API_KEY")

# To get the unique host for an index, 
# see https://docs.pinecone.io/guides/manage-data/target-an-index
index = pc.Index(host="INDEX_HOST")

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

Documentation Index

Fetch the complete documentation index at: https://docs.pinecone.io/llms.txt

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

from pinecone import Pinecone

pc = Pinecone(api_key="YOUR_API_KEY")

# To get the unique host for an index, 
# see https://docs.pinecone.io/guides/manage-data/target-an-index
index = pc.Index(host="INDEX_HOST")

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

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:202601-alpha
required

Required date-based version header

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

​
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 }
  }
}
​
indexed_fields
object

A list of all indexed metatadata fields in the namespace