Describe a collection

This operation gets a description of a collection.

Serverless and starter indexes do not support collections.

Authorizations

Api-Key

string

header

required

Path Parameters

collection_name

string

required

The name of the collection to be described.

Response

200 - application/json

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

environment

string

required

The environment where the collection is hosted.

name

string

required

status

enum<string>

required

The status of the collection.

Available options:

Initializing,

Ready,

Terminating

dimension

integer

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

Required range: 1 < x < 2000

size

integer

The size of the collection in bytes.

vector_count

integer

The number of records stored in the collection.