Backups
List collections
Database
Assistant
- Assistants
- Files
- Chat
- Evaluation
- Context snippets
Backups
List collections
This operation returns a list of all collections in a project.
Serverless indexes do not support collections.
GET
/
collections
from pinecone.grpc import PineconeGRPC as Pinecone
pc = Pinecone(api_key='YOUR_API_KEY')
active_collections = pc.list_collections()
{
"collections": [
{
"dimension": 3,
"environment": "us-east1-gcp",
"name": "small-collection",
"size": 3126700,
"status": "Ready",
"vector_count": 99
},
{
"dimension": 3,
"environment": "us-east1-gcp",
"name": "small-collection-new",
"size": 3126700,
"status": "Initializing",
"vector_count": 99
},
{
"dimension": 1536,
"environment": "us-east1-gcp",
"name": "big-collection",
"size": 160087040000000,
"status": "Ready",
"vector_count": 10000000
}
]
}
from pinecone.grpc import PineconeGRPC as Pinecone
pc = Pinecone(api_key='YOUR_API_KEY')
active_collections = pc.list_collections()
Response
200
application/json
This operation returns a list of all the collections in your current project.
The list of collections that exist in the project.
The name of the collection.
The status of the collection.
Available options:
Initializing
, Ready
, Terminating
The environment where the collection is hosted.
The size of the collection in bytes.
The dimension of the vectors stored in each record held in the collection.
Required range:
1 < x < 2000
The number of records stored in the collection.
Was this page helpful?
from pinecone.grpc import PineconeGRPC as Pinecone
pc = Pinecone(api_key='YOUR_API_KEY')
active_collections = pc.list_collections()
{
"collections": [
{
"dimension": 3,
"environment": "us-east1-gcp",
"name": "small-collection",
"size": 3126700,
"status": "Ready",
"vector_count": 99
},
{
"dimension": 3,
"environment": "us-east1-gcp",
"name": "small-collection-new",
"size": 3126700,
"status": "Initializing",
"vector_count": 99
},
{
"dimension": 1536,
"environment": "us-east1-gcp",
"name": "big-collection",
"size": 160087040000000,
"status": "Ready",
"vector_count": 10000000
}
]
}