GET
/
collections
/
{collection_name}
PINECONE_API_KEY = "YOUR_API_KEY"

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


{
  "name": "tiny-collection",
  "size": 3126700,
  "status": "Ready",
  "dimension": 3,
  "vector_count": 99,
  "environment": "us-east1-gcp"
}
PINECONE_API_KEY = "YOUR_API_KEY"

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

Authorizations

​
Api-Key
string
header
required

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.