List indexes
This operation returns a list of all indexes in a project.
# pip install "pinecone[grpc]"
from pinecone.grpc import PineconeGRPC as Pinecone
pc = Pinecone(api_key="YOUR_API_KEY")
pc.list_indexes()// npm install @pinecone-database/pinecone
import { Pinecone } from '@pinecone-database/pinecone'
const pc = new Pinecone({ apiKey: 'YOUR_API_KEY' })
await pc.listIndexes();import io.pinecone.clients.Pinecone;
import org.openapitools.control.client.model.*;
public class ListIndexesExample {
public static void main(String[] args) {
Pinecone pc = new Pinecone.Builder("YOUR_API_KEY").build();
IndexList indexList = pc.listIndexes();
System.out.println(indexList);
}
}package main
import (
"context"
"encoding/json"
"fmt"
"log"
"github.com/pinecone-io/go-pinecone/v2/pinecone"
)
func prettifyStruct(obj interface{}) string {
bytes, _ := json.MarshalIndent(obj, "", " ")
return string(bytes)
}
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)
}
idxs, err := pc.ListIndexes(ctx)
if err != nil {
log.Fatalf("Failed to list indexes: %v", err)
} else {
for _, index := range idxs {
fmt.Printf("index: %v\n", prettifyStruct(index))
}
}
}using Pinecone;
var pinecone = new PineconeClient("YOUR_API_KEY");
var indexList = await pinecone.ListIndexesAsync();
Console.WriteLine(indexList);PINECONE_API_KEY="YOUR_API_KEY"
curl -i -X GET "https://api.pinecone.io/indexes" \
-H "Api-Key: $PINECONE_API_KEY" \
-H "X-Pinecone-Api-Version: 2024-07"GET /indexes
{
"indexes": [
{
"dimension": 384,
"host": "semantic-search-c01b5b5.svc.us-west1-gcp.pinecone.io",
"metric": "cosine",
"name": "semantic-search",
"spec": {
"pod": {
"environment": "us-west1-gcp",
"pod_type": "p1.x1",
"pods": 4,
"replicas": 2,
"shards": 2
}
},
"status": {
"ready": true,
"state": "Ready"
}
},
{
"dimension": 200,
"host": "image-search-a31f9c1.svc.us-east1-gcp.pinecone.io",
"metric": "dotproduct",
"name": "image-search",
"spec": {
"serverless": {
"cloud": "aws",
"region": "us-east-1"
}
},
"status": {
"ready": false,
"state": "Initializing"
}
}
]
}{
"error": {
"code": "UNAUTHENTICATED",
"message": "Invalid API key."
},
"status": 401
}{
"error": {
"code": "UNKNOWN",
"message": "Internal server error"
},
"status": 500
}Authorizations
Section titled “Authorizations”Api-KeystringrequiredAn API Key is required to call Pinecone APIs. Get yours from the console.
Response
Section titled “Response”200 — 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[]Show child attributes
namestringrequiredThe name of the index. Resource name must be 1-45 characters long, start and end with an alphanumeric character, and consist only of lower case alphanumeric characters or '-'.
Required string length: 1 - 45. Example: example-index
dimensionintegerrequiredThe dimensions of the vectors to be inserted in the index.
Required range: 1 <= x <= 20000. Example: 1536
metricenum<string>requiredThe distance metric to be used for similarity search. You can use 'euclidean', 'cosine', or 'dotproduct'.
Available options: cosine, euclidean, dotproduct
hoststringrequiredThe URL address where the index is hosted.
Example: semantic-search-c01b5b5.svc.us-west1-gcp.pinecone.io
deletion_protection?enum<string>Available options: disabled, enabled
Whether deletion protection is enabled/disabled for the index.
specobjectrequiredShow child attributes
pod?objectConfiguration needed to deploy a pod-based index.
Show child attributes
environmentstringrequiredThe environment where the index is hosted.
Example: us-east1-gcp
replicas?integerThe number of replicas. Replicas duplicate your index. They provide higher availability and throughput. Replicas can be scaled up or down as your needs change.
Required range: 1 <= x
shards?integerThe number of shards. Shards split your data across multiple pods so you can fit more data into an index.
Required range: 1 <= x
pod_typestringrequiredThe type of pod to use. One of s1, p1, or p2 appended with . and one of x1, x2, x4, or x8.
pods?integerThe number of pods to be used in the index. This should be equal to shards x replicas.'
Required range: 1 <= x. Example: 1
metadata_config?objectConfiguration for the behavior of Pinecone's internal metadata index. By default, all metadata is indexed; when metadata_config is present, only specified metadata fields are indexed. These configurations are only valid for use with pod-based indexes.
source_collection?stringThe name of the collection to be used as the source for the index.
Example: movie-embeddings
serverless?objectConfiguration needed to deploy a serverless index.
Show child attributes
cloudenum<string>requiredThe public cloud where you would like your index hosted.
Available options: gcp, aws, azure. Example: aws
regionstringrequiredThe region where you would like your index to be created.
Example: us-east-1
statusobjectrequiredShow child attributes
readybooleanrequiredstateenum<string>requiredAvailable options: Initializing, InitializationFailed, ScalingUp, ScalingDown, ScalingUpPodSize, ScalingDownPodSize, Terminating, Ready