GET
/
collections
/
{collection_name}

Authorizations

Api-Key
string
headerrequired

An API Key is required to call Pinecone APIs. Get yours from the console.

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

The name of the collection.

size
integer

The size of the collection in bytes.

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.

vector_count
integer

The number of records stored in the collection.

environment
string
required

The environment where the collection is hosted.

Was this page helpful?

Create a collectionDelete a collection