List collections

This operation returns a list of your Pinecone collections.

Serverless and starter indexes do not support collections.

Authorizations

Api-Key

string

header

required

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.

collections

object[]

The CollectionModel describes the configuration and status of a Pinecone collection.

Show child attributes

collections.name

string

required

collections.status

enum<string>

required

The status of the collection.

Available options:

Initializing,

Ready,

Terminating

collections.environment

string

required

The environment where the collection is hosted.

collections.size

integer

The size of the collection in bytes.

collections.dimension

integer

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

Required range: 1 < x < 2000

collections.vector_count

integer

The number of records stored in the collection.