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"
}

Authorizations

Api-Key
string
headerrequired

Path Parameters

collection_name
string
required

The name of the collection to be described.

Response

200 - application/json
name
string
required
size
integer

The size of the collection in bytes.

status
enum<string>
required

The status of the collection.

Available options:
Initializing,
Ready,
Terminating
dimension
integer

The dimension of the vectors stored in each record held in the collection.

vector_count
integer

The number of records stored in the collection.

environment
string
required

The environment where the collection is hosted.