List collections

This operation returns a list of your Pinecone collections.

Serverless and starter indexes do not support collections.

cURL

PINECONE_API_KEY="YOUR_API_KEY"

curl -i -X GET "https://api.pinecone.io/collections" \
  -H "Api-Key: $PINECONE_API_KEY"

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

Example:

"example-collection"

collections.status

enum<string>

required

The status of the collection.

Available options:

Initializing,

Ready,

Terminating

Example:

"Initializing"

collections.environment

string

required

The environment where the collection is hosted.

Example:

"us-east1-gcp"

collections.size

integer

The size of the collection in bytes.

Example:

10000000

collections.dimension

integer

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

Required range: 1 <= x <= 2000

Example:

1536

collections.vector_count

integer

The number of records stored in the collection.

Example:

120000