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" \
    -H "X-Pinecone-API-Version: 2025-04"
{
    "name": "example-collection",
    "status": "Ready",
    "environment": "us-east-1-aws",
    "size": 3075398,
    "vector_count": 99,
    "dimension": 1536
}
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: 2025-04"
{
    "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.

name
string
required

The name of the collection.

Example:

"example-collection"

status
enum<string>
required

The status of the collection.

Available options:
Initializing,
Ready,
Terminating
Example:

"Initializing"

environment
string
required

The environment where the collection is hosted.

Example:

"us-east1-gcp"

size
integer

The size of the collection in bytes.

Example:

10000000

dimension
integer

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

Required range: 1 <= x <= 20000
Example:

1536

vector_count
integer

The number of records stored in the collection.

Example:

120000