Sign in

v1

latestOpenAPI 3.0.3Apache 2.02026-07-2685172326.0 KB
Manage Indexes

Describe a collection

Get a description of a collection. Serverless indexes do not support collections.

get/collections/{collection_name}

Path parameters

collection_namestring required

The name of the collection to be described.

Headers

X-Pinecone-Api-Versionstring required

Required date-based version header

Response

Configuration information and status of the collection.

namestring required

The name of the collection.

sizeinteger

The size of the collection in bytes.

statusstring required

The status of the collection. Possible values: Initializing, Ready, or Terminating.

dimensioninteger

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

vector_countinteger

The number of records stored in the collection.

environmentstring required

The environment where the collection is hosted.

Example response

{
  "name": "example-collection",
  "size": 10000000,
  "status": "Initializing",
  "dimension": 1536,
  "vector_count": 120000,
  "environment": "us-east1-gcp"
}