# pip install --upgrade pinecone
import os
from pinecone import Pinecone
pc = Pinecone(api_key=os.environ["PINECONE_API_KEY"])
collection = pc.collections.describe(name="example-collection")
print(collection.name, collection.status, collection.dimension, collection.vector_count)
// npm install @pinecone-database/pinecone
import { Pinecone } from '@pinecone-database/pinecone';
// Reads PINECONE_API_KEY from the environment
const pc = new Pinecone();
const collection = await pc.collections.describe('example-collection');
console.log(collection.name, collection.status, collection.dimension, collection.vectorCount);
package main
import (
"context"
"fmt"
"log"
"os"
"github.com/pinecone-io/go-pinecone/v7/pinecone"
)
func main() {
ctx := context.Background()
pc, err := pinecone.NewClient(pinecone.NewClientParams{
ApiKey: os.Getenv("PINECONE_API_KEY"),
})
if err != nil {
log.Fatalf("Failed to create Client: %v", err)
}
collection, err := pc.DescribeCollection(ctx, "example-collection")
if err != nil {
log.Fatalf("Failed to describe collection: %v", err)
}
fmt.Println(collection.Name, collection.Status, collection.Dimension, collection.VectorCount)
}
PINECONE_API_KEY="YOUR_API_KEY"
curl -i -X GET "https://api.pinecone.io/collections/example-collection" \
-H "Api-Key: $PINECONE_API_KEY" \
-H "X-Pinecone-Api-Version: 2026-07"
{
"dimension": 3,
"environment": "us-east1-gcp",
"name": "tiny-collection",
"size": 3126700,
"status": "Ready",
"vector_count": 99
}Invalid API key{
"error": {
"code": "NOT_FOUND",
"message": "Collection example-collection not found."
},
"status": 404
}{
"error": {
"code": "UNKNOWN",
"message": "Internal server error"
},
"status": 500
}Backups
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.
GET
/
collections
/
{collection_name}
# pip install --upgrade pinecone
import os
from pinecone import Pinecone
pc = Pinecone(api_key=os.environ["PINECONE_API_KEY"])
collection = pc.collections.describe(name="example-collection")
print(collection.name, collection.status, collection.dimension, collection.vector_count)
// npm install @pinecone-database/pinecone
import { Pinecone } from '@pinecone-database/pinecone';
// Reads PINECONE_API_KEY from the environment
const pc = new Pinecone();
const collection = await pc.collections.describe('example-collection');
console.log(collection.name, collection.status, collection.dimension, collection.vectorCount);
package main
import (
"context"
"fmt"
"log"
"os"
"github.com/pinecone-io/go-pinecone/v7/pinecone"
)
func main() {
ctx := context.Background()
pc, err := pinecone.NewClient(pinecone.NewClientParams{
ApiKey: os.Getenv("PINECONE_API_KEY"),
})
if err != nil {
log.Fatalf("Failed to create Client: %v", err)
}
collection, err := pc.DescribeCollection(ctx, "example-collection")
if err != nil {
log.Fatalf("Failed to describe collection: %v", err)
}
fmt.Println(collection.Name, collection.Status, collection.Dimension, collection.VectorCount)
}
PINECONE_API_KEY="YOUR_API_KEY"
curl -i -X GET "https://api.pinecone.io/collections/example-collection" \
-H "Api-Key: $PINECONE_API_KEY" \
-H "X-Pinecone-Api-Version: 2026-07"
{
"dimension": 3,
"environment": "us-east1-gcp",
"name": "tiny-collection",
"size": 3126700,
"status": "Ready",
"vector_count": 99
}Invalid API key{
"error": {
"code": "NOT_FOUND",
"message": "Collection example-collection not found."
},
"status": 404
}{
"error": {
"code": "UNKNOWN",
"message": "Internal server error"
},
"status": 500
}# pip install --upgrade pinecone
import os
from pinecone import Pinecone
pc = Pinecone(api_key=os.environ["PINECONE_API_KEY"])
collection = pc.collections.describe(name="example-collection")
print(collection.name, collection.status, collection.dimension, collection.vector_count)
// npm install @pinecone-database/pinecone
import { Pinecone } from '@pinecone-database/pinecone';
// Reads PINECONE_API_KEY from the environment
const pc = new Pinecone();
const collection = await pc.collections.describe('example-collection');
console.log(collection.name, collection.status, collection.dimension, collection.vectorCount);
package main
import (
"context"
"fmt"
"log"
"os"
"github.com/pinecone-io/go-pinecone/v7/pinecone"
)
func main() {
ctx := context.Background()
pc, err := pinecone.NewClient(pinecone.NewClientParams{
ApiKey: os.Getenv("PINECONE_API_KEY"),
})
if err != nil {
log.Fatalf("Failed to create Client: %v", err)
}
collection, err := pc.DescribeCollection(ctx, "example-collection")
if err != nil {
log.Fatalf("Failed to describe collection: %v", err)
}
fmt.Println(collection.Name, collection.Status, collection.Dimension, collection.VectorCount)
}
PINECONE_API_KEY="YOUR_API_KEY"
curl -i -X GET "https://api.pinecone.io/collections/example-collection" \
-H "Api-Key: $PINECONE_API_KEY" \
-H "X-Pinecone-Api-Version: 2026-07"
Authorizations
Headers
Required date-based version header
Path Parameters
The name of the collection to be described.
Response
Configuration information and status of the collection.
The CollectionModel describes the configuration and status of a Pinecone collection.
The name of the collection.
Example:
"example-collection"
The status of the collection.
Possible values: Initializing, Ready, Terminating, or Terminated.
Example:
"Initializing"
The environment where the collection is hosted.
Example:
"us-east1-gcp"
The size of the collection in bytes.
Example:
10000000
The dimension of the vectors stored in each record held in the collection.
Required range:
1 <= x <= 20000Example:
1536
The number of records stored in the collection.
Example:
120000
Was this page helpful?