Describe a collection - Pinecone Docs

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

pc = Pinecone(api_key='API_KEY')
pc.describe_collection(name="tiny-collection")

// npm install @pinecone-database/pinecone
import { Pinecone } from '@pinecone-database/pinecone';

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

await pc.describeCollection('tiny-collection');

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);
    }
}

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-04"

{
  "name": "tiny-collection",
  "size": 3126700,
  "status": "Ready",
  "dimension": 3,
  "vector_count": 99,
  "environment": "us-east1-gcp"
}

{
  "status": 401,
  "error": {
    "code": "UNAUTHENTICATED",
    "message": "Invalid API key."
  }
}

{
  "status": 404,
  "error": {
    "code": "NOT_FOUND",
    "message": "Collection example-collection not found."
  }
}

{
  "status": 500,
  "error": {
    "code": "UNKNOWN",
    "message": "Internal server error"
  }
}

GET

collections

{collection_name}

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

pc = Pinecone(api_key='API_KEY')
pc.describe_collection(name="tiny-collection")

// npm install @pinecone-database/pinecone
import { Pinecone } from '@pinecone-database/pinecone';

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

await pc.describeCollection('tiny-collection');

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);
    }
}

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-04"

{
  "name": "tiny-collection",
  "size": 3126700,
  "status": "Ready",
  "dimension": 3,
  "vector_count": 99,
  "environment": "us-east1-gcp"
}

{
  "status": 401,
  "error": {
    "code": "UNAUTHENTICATED",
    "message": "Invalid API key."
  }
}

{
  "status": 404,
  "error": {
    "code": "NOT_FOUND",
    "message": "Collection example-collection not found."
  }
}

{
  "status": 500,
  "error": {
    "code": "UNKNOWN",
    "message": "Internal server error"
  }
}

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

pc = Pinecone(api_key='API_KEY')
pc.describe_collection(name="tiny-collection")

// npm install @pinecone-database/pinecone
import { Pinecone } from '@pinecone-database/pinecone';

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

await pc.describeCollection('tiny-collection');

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);
    }
}

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-04"

Authorizations

Api-Key

string

header

required

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

Configuration information and status of the collection.

The CollectionModel describes the configuration and status of a Pinecone collection.

name

string

required

The name of the collection.

Example:

"example-collection"

status

enum<string>

required

The status of the collection.

Available options:

Initializing,

Ready,

Terminating

Example:

"Initializing"

environment

string

required

The environment where the collection is hosted.

Example:

"us-east1-gcp"

size

integer<int64>

The size of the collection in bytes.

Example:

10000000

dimension

integer<int32>

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

Required range: 1 <= x <= 2000

Example:

1536

vector_count

integer<int32>

The number of records stored in the collection.

Example:

120000

Create a collection Delete a collection

⌘I