Skip to main content
Pinecone Docs

Search documentation

Type to search this documentation.

On this pageOverview

Describe a collection

Collections are supported only for pod-based indexes. Pod-based indexes cannot be created with API version 2026-07, so this operation applies to pod-based indexes created with an earlier API version.

curl
PINECONE_API_KEY="YOUR_API_KEY"

curl -i -X GET "https://api.pinecone.io/collections/tiny-collection" \
    -H "Api-Key: $PINECONE_API_KEY" \
    -H "X-Pinecone-Api-Version: 2026-07"

GET /collections/{collection_name}

  • X-Pinecone-Api-Version (header, string, required) — Required date-based version header
  • collection_name (path, string, required) — The name of the collection to be described.
  • 200 — Configuration information and status of the collection.
  • 401 — Unauthorized. Possible causes: missing or invalid API key.
  • 404 — Collection not found.
  • 500 — Internal server error.
Suggest an edit

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

Export
Documentation menu