Describe a collection
Get a description of 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.
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}
{
"dimension": 3,
"environment": "us-east1-gcp",
"name": "tiny-collection",
"size": 3126700,
"status": "Ready",
"vector_count": 99
}{
"error": {
"code": "NOT_FOUND",
"message": "Collection example-collection not found."
},
"status": 404
}{
"error": {
"code": "UNKNOWN",
"message": "Internal server error"
},
"status": 500
}Authorizations
Section titled “Authorizations”Api-KeystringrequiredAn API Key is required to call Pinecone APIs. Get yours from the console.
Headers
Section titled “Headers”X-Pinecone-Api-VersionstringrequiredRequired date-based version header
Path Parameters
Section titled “Path Parameters”collection_namestringrequiredThe name of the collection to be described.
Response
Section titled “Response”200 — Configuration information and status of the collection.
The CollectionModel describes the configuration and status of a Pinecone collection.
namestringrequiredThe name of the collection.
Example: example-collection
size?integerThe size of the collection in bytes.
Example: 10000000
statusstringrequiredThe status of the collection. Possible values: Initializing, Ready, Terminating, or Terminated.
Example: Initializing
dimension?integerThe dimension of the vectors stored in each record held in the collection.
Required range: 1 <= x <= 20000. Example: 1536
vector_count?integerThe number of records stored in the collection.
Example: 120000
environmentstringrequiredThe environment where the collection is hosted.
Example: us-east1-gcp