Skip to main content
GET
/
indexes
# 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"
{
  "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"
      }
    }
  ]
}
# 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"

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[]