Control plane
List collections
Control plane
List collections
This operation returns a list of your Pinecone collections.
Serverless indexes do not support collections.
GET
/
collections
PINECONE_API_KEY="YOUR_API_KEY"
curl -i -X GET "https://api.pinecone.io/collections" \
-H "Api-Key: $PINECONE_API_KEY"
{
"collections": [
{
"name": "small-collection",
"size": 3126700,
"status": "Ready",
"dimension": 3,
"vector_count": 99,
"environment": "us-east1-gcp"
},
{
"name": "small-collection-new",
"size": 3126700,
"status": "Initializing",
"dimension": 3,
"vector_count": 99,
"environment": "us-east1-gcp"
},
{
"name": "big-collection",
"size": 160087040000000,
"status": "Ready",
"dimension": 1536,
"vector_count": 10000000,
"environment": "us-east1-gcp"
}
]
}
Authorizations
Api-Key
string
headerrequiredResponse
200 - application/json
collections
object[]
collections.name
string
requiredcollections.size
integer
The size of the collection in bytes.
collections.status
enum<string>
requiredThe status of the collection.
Available options:
Initializing
, Ready
, Terminating
collections.dimension
integer
The dimension of the vectors stored in each record held in the collection.
collections.vector_count
integer
The number of records stored in the collection.
collections.environment
string
requiredThe environment where the collection is hosted.
Was this page helpful?
PINECONE_API_KEY="YOUR_API_KEY"
curl -i -X GET "https://api.pinecone.io/collections" \
-H "Api-Key: $PINECONE_API_KEY"
{
"collections": [
{
"name": "small-collection",
"size": 3126700,
"status": "Ready",
"dimension": 3,
"vector_count": 99,
"environment": "us-east1-gcp"
},
{
"name": "small-collection-new",
"size": 3126700,
"status": "Initializing",
"dimension": 3,
"vector_count": 99,
"environment": "us-east1-gcp"
},
{
"name": "big-collection",
"size": 160087040000000,
"status": "Ready",
"dimension": 1536,
"vector_count": 10000000,
"environment": "us-east1-gcp"
}
]
}