Skip to main content
Pinecone Docs

Search documentation

Type to search this documentation.

On this pageOverview

Describe a namespace

For guidance and examples, see Manage namespaces.

Note: This operation is not supported for pod-based indexes.

curl
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"

GET /namespaces/{namespace}

  • X-Pinecone-Api-Version (header, string, required) — Required date-based version header
  • namespace (path, string, required) — The namespace to describe.
  • 200 — A description of a namespace.
  • 400 — Bad request. The request body included invalid request parameters.
  • 4XX — An unexpected error response.
  • 5XX — An unexpected error response.
Suggest an edit

Propose a replacement for this page. The site team reviews it before applying any changes.

Export
Documentation menu