Skip to main content
GET
/
indexes
from pinecone.grpc import PineconeGRPC as Pinecone

pc = Pinecone(api_key="YOUR_API_KEY")

index_list = pc.list_indexes()

print(index_list)

{
    "indexes": [
        {
            "name": "docs-example2",
            "metric": "cosine",
            "dimension": 1536,
            "status": {
                "ready": true,
                "state": "Ready"
            },
            "host": "docs-example2-govk0nt.svc.aped-4627-b74a.pinecone.io",
            "spec": {
                "serverless": {
                    "region": "us-east-1",
                    "cloud": "aws"
                }
            },
            "deletion_protection": "disabled",
            "tags": {
                "environment": "production",
                "example": "tag2"
            },
			"vector_type": "dense"
        },
        {
            "name": "docs-example1",
            "metric": "cosine",
            "dimension": 1536,
            "status": {
                "ready": true,
                "state": "Ready"
            },
            "host": "docs-example1-govk0nt.svc.aped-4627-b74a.pinecone.io",
            "spec": {
                "serverless": {
                    "region": "us-east-1",
                    "cloud": "aws"
                }
            },
            "deletion_protection": "disabled",
            "tags": {
                "environment": "development",
                "example": "tag"
            },
			"vector_type": "dense"
        }
    ]
}

Documentation Index

Fetch the complete documentation index at: https://docs.pinecone.io/llms.txt

Use this file to discover all available pages before exploring further.

from pinecone.grpc import PineconeGRPC as Pinecone

pc = Pinecone(api_key="YOUR_API_KEY")

index_list = pc.list_indexes()

print(index_list)

{
    "indexes": [
        {
            "name": "docs-example2",
            "metric": "cosine",
            "dimension": 1536,
            "status": {
                "ready": true,
                "state": "Ready"
            },
            "host": "docs-example2-govk0nt.svc.aped-4627-b74a.pinecone.io",
            "spec": {
                "serverless": {
                    "region": "us-east-1",
                    "cloud": "aws"
                }
            },
            "deletion_protection": "disabled",
            "tags": {
                "environment": "production",
                "example": "tag2"
            },
			"vector_type": "dense"
        },
        {
            "name": "docs-example1",
            "metric": "cosine",
            "dimension": 1536,
            "status": {
                "ready": true,
                "state": "Ready"
            },
            "host": "docs-example1-govk0nt.svc.aped-4627-b74a.pinecone.io",
            "spec": {
                "serverless": {
                    "region": "us-east-1",
                    "cloud": "aws"
                }
            },
            "deletion_protection": "disabled",
            "tags": {
                "environment": "development",
                "example": "tag"
            },
			"vector_type": "dense"
        }
    ]
}

Authorizations

​
Api-Key
string
header
required

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

Response

This operation returns a list of all the indexes that you have previously created, and which are associated with the given project

The list of indexes that exist in the project.

​
indexes
object[]