Skip to main content
Pinecone Docs

Search documentation

Type to search this documentation.

On this pageOverview

Describe a collection

Serverless indexes do not support collections.

Python
# pip install "pinecone[grpc]"
from pinecone.grpc import PineconeGRPC as Pinecone

pc = Pinecone(api_key='API_KEY')
pc.describe_collection(name="tiny-collection")
JavaScript
// npm install @pinecone-database/pinecone
import { Pinecone } from '@pinecone-database/pinecone';

const pc = new Pinecone({ apiKey: 'YOUR_API_KEY' });

await pc.describeCollection('tiny-collection');
Java
import io.pinecone.clients.Pinecone;
import org.openapitools.client.model.CollectionModel;

public class DescribeCollectionExample {
    public static void main(String[] args) {
        Pinecone pc = new Pinecone.Builder("YOUR_API_KEY").build();
        CollectionModel collectionModel = pc.describeCollection("tiny-collection");
        System.out.println(collectionModel);
    }
}
Go
package main

import (
    "context"
    "fmt"
    "log"

    "github.com/pinecone-io/go-pinecone/v2/pinecone"
)

func main() {
    ctx := context.Background()

    pc, err := pinecone.NewClient(pinecone.NewClientParams{
        ApiKey: "YOUR_API_KEY",
    })
    if err != nil {
        log.Fatalf("Failed to create Client: %v", err)
    }

    collectionName := "tiny-collection"

    collection, err := pc.DescribeCollection(ctx, collectionName)
    if err != nil {
        log.Fatalf("Error describing collection %v: %v", collectionName, err)
    } else {
        fmt.Printf("Collection: %+v", collection)
    }
}
C#
using Pinecone;

var pinecone = new PineconeClient("YOUR_API_KEY");

var collectionModel = await pinecone.DescribeCollectionAsync("tiny-collection");

Console.WriteLine(collectionModel);
curl
PINECONE_API_KEY="YOUR_API_KEY"

curl -i -X GET "https://api.pinecone.io/collections/tiny-collection" \
    -H "Api-Key: $PINECONE_API_KEY" \
    -H "X-Pinecone-Api-Version: 2024-10"
curl
{
    "name": "example-collection",
    "status": "Ready",
    "environment": "us-east-1-aws",
    "size": 3075398,
    "vector_count": 99,
    "dimension": 1536
}

GET /collections/{collection_name}

  • collection_name (path, string, required) — The name of the collection to be described.
  • 200 — Configuration information and status of the collection.
  • 401 — Unauthorized. Possible causes: Invalid API key.
  • 404 — Collection not found.
  • 500 — Internal server error.
Suggest an edit

Propose a replacement for this page. The site team reviews it before applying any changes.

Export
Documentation menu