GET
/
collections
/
{collection_name}
# pip install "pinecone[grpc]"
from pinecone.grpc import PineconeGRPC as Pinecone

pc = Pinecone(api_key='API_KEY')
pc.describe_collection(name="tiny-collection")

{
    "name": "example-collection",
    "status": "Ready",
    "environment": "us-east-1-aws",
    "size": 3075398,
    "vector_count": 99,
    "dimension": 1536
}

# pip install "pinecone[grpc]"
from pinecone.grpc import PineconeGRPC as Pinecone

pc = Pinecone(api_key='API_KEY')
pc.describe_collection(name="tiny-collection")

{
    "name": "example-collection",
    "status": "Ready",
    "environment": "us-east-1-aws",
    "size": 3075398,
    "vector_count": 99,
    "dimension": 1536
}

Authorizations

​
Api-Key
string
header
required

An API Key is required to call Pinecone APIs. Get yours from the console.

Path Parameters

​
collection_name
string
required

The name of the collection to be described.

Response

200
application/json

Configuration information and status of the collection.

The CollectionModel describes the configuration and status of a Pinecone collection.