GET
/
collections
/
{collectionName}
curl --request GET \
     --url https://controller.us-east1-gcp.pinecone.io/collections/collectionName \
     --header 'accept: application/json'
{
  "name": "example-collection",
  "size": 1,
  "status": "created",
  "dimension": 1024,
  "vector_count": 50000
}

Authorizations

Api-Key
string
headerrequired

An API Key is required to call Pinecone APIs. Get yours at https://app.pinecone.io/.

Path Parameters

collectionName
string
required

The name of the collection

Response

200 - application/json
name
string

The name of the collection.

size
integer

The size of the collection in bytes.

status
string

The status of the collection.

dimension
integer

The dimension of the records stored in the collection.

vector_count
integer

The number of records stored in the collection.