GET
/
collections
/
{collection_name}

Authorizations

Api-Key
string
headerrequired

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.

name
string
required
status
enum<string>
required

The status of the collection.

Available options:
Initializing,
Ready,
Terminating
environment
string
required

The environment where the collection is hosted.

size
integer

The size of the collection in bytes.

dimension
integer

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

Required range: 1 < x < 2000
vector_count
integer

The number of records stored in the collection.

Was this page helpful?