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)
import { Pinecone } from '@pinecone-database/pinecone'

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

const indexList = await pc.listIndexes();

console.log(indexList);
import io.pinecone.clients.Pinecone;
import org.openapitools.db_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/v3/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-10"
[{
    "name": "docs-example-sparse",
    "metric": "dotproduct",
    "host": "docs-example-sparse-govk0nt.svc.aped-4627-b74a.pinecone.io",
    "spec": {
        "serverless": {
            "cloud": "aws",
            "region": "us-east-1"
        }
    },
    "status": {
        "ready": true,
        "state": "Ready"
    },
    "vector_type": "sparse",
    "dimension": null,
    "deletion_protection": "disabled",
    "tags": {
        "environment": "development"
    }
}, {
    "name": "docs-example-dense",
    "metric": "cosine",
    "host": "docs-example-dense-govk0nt.svc.aped-4627-b74a.pinecone.io",
    "spec": {
        "serverless": {
            "cloud": "aws",
            "region": "us-east-1"
        }
    },
    "status": {
        "ready": true,
        "state": "Ready"
    },
    "vector_type": "dense",
    "dimension": 1536,
    "deletion_protection": "disabled",
    "tags": {
        "environment": "development"
    }
}]
{
  indexes: [
    {
      name: 'docs-example-sparse',
      dimension: undefined,
      metric: 'dotproduct',
      host: 'docs-example-sparse-govk0nt.svc.aped-4627-b74a.pinecone.io',
      deletionProtection: 'disabled',
      tags: { environment: 'development', example: 'tag' },
      embed: undefined,
      spec: { pod: undefined, serverless: { cloud: 'aws', region: 'us-east-1' } },
      status: { ready: true, state: 'Ready' },
      vectorType: 'sparse'
    },
    {
      name: 'docs-example-dense',
      dimension: 1536,
      metric: 'cosine',
      host: 'docs-example-dense-govk0nt.svc.aped-4627-b74a.pinecone.io',
      deletionProtection: 'disabled',
      tags: { environment: 'development', example: 'tag' },
      embed: undefined,
      spec: { pod: undefined, serverless: { cloud: 'aws', region: 'us-east-1' } },
      status: { ready: true, state: 'Ready' },
      vectorType: 'dense'
    }
  ]
}
class IndexList {
    indexes: [class IndexModel {
        name: docs-example-sparse
        dimension: null
        metric: dotproduct
        host: docs-example-sparse-govk0nt.svc.aped-4627-b74a.pinecone.io
        deletionProtection: disabled
        tags: {environment=development}
        embed: null
        spec: class IndexModelSpec {
            pod: null
            serverless: class ServerlessSpec {
                cloud: aws
                region: us-east-1
                additionalProperties: null
            }
            additionalProperties: null
        }
        status: class IndexModelStatus {
            ready: true
            state: Ready
            additionalProperties: null
        }
        vectorType: sparse
        additionalProperties: null
    }, class IndexModel {
        name: docs-example-dense
        dimension: 1536
        metric: cosine
        host: docs-example-dense-govk0nt.svc.aped-4627-b74a.pinecone.io
        deletionProtection: disabled
        tags: {environment=development}
        embed: null
        spec: class IndexModelSpec {
            pod: null
            serverless: class ServerlessSpec {
                cloud: aws
                region: us-east-1
                additionalProperties: null
            }
            additionalProperties: null
        }
        status: class IndexModelStatus {
            ready: true
            state: Ready
            additionalProperties: null
        }
        vectorType: dense
        additionalProperties: null
    }]
    additionalProperties: null
}
index: {
  "name": "docs-example-sparse",
  "host": "docs-example-sparse-govk0nt.svc.aped-4627-b74a.pinecone.io",
  "metric": "dotproduct",
  "vector_type": "sparse",
  "deletion_protection": "disabled",
  "dimension": null,
  "spec": {
    "serverless": {
      "cloud": "aws",
      "region": "us-east-1"
    }
  },
  "status": {
    "ready": true,
    "state": "Ready"
  },
  "tags": {
    "environment": "development"
  }
}
index: {
  "name": "docs-example-dense",
  "host": "docs-example-dense-govk0nt.svc.aped-4627-b74a.pinecone.io",
  "metric": "cosine",
  "vector_type": "dense",
  "deletion_protection": "disabled",
  "dimension": 1536,
  "spec": {
    "serverless": {
      "cloud": "aws",
      "region": "us-east-1"
    }
  },
  "status": {
    "ready": true,
    "state": "Ready"
  },
  "tags": {
    "environment": "development"
  }
}
{
  "indexes": [
    {
      "name": "docs-example-sparse",
      "metric": "dotproduct",
      "host": "docs-example-sparse-govk0nt.svc.aped-4627-b74a.pinecone.io",
      "deletion_protection": "disabled",
      "tags": {
        "environment": "development"
      },
      "spec": {
        "serverless": {
          "cloud": "aws",
          "region": "us-east-1"
        }
      },
      "status": {
        "ready": true,
        "state": "Ready"
      },
      "vector_type": "sparse"
    },
    {
      "name": "docs-example-dense",
      "dimension": 1536,
      "metric": "cosine",
      "host": "docs-example-dense-govk0nt.svc.aped-4627-b74a.pinecone.io",
      "deletion_protection": "disabled",
      "tags": {
        "environment": "development"
      },
      "spec": {
        "serverless": {
          "cloud": "aws",
          "region": "us-east-1"
        }
      },
      "status": {
        "ready": true,
        "state": "Ready"
      },
      "vector_type": "dense"
    }
  ]
}
{
  "indexes": [
    {
      "name": "docs-example-sparse",
      "vector_type": "sparse",
      "metric": "dotproduct",
      "dimension": null,
      "status": {
        "ready": true,
        "state": "Ready"
      },
      "host": "docs-example-sparse-govk0nt.svc.aped-4627-b74a.pinecone.io",
      "spec": {
        "serverless": {
          "region": "us-east-1",
          "cloud": "aws"
        }
      },
      "deletion_protection": "disabled",
      "tags": {
        "environment": "development"
      }
    },
    {
      "name": "docs-example-dense",
      "vector_type": "dense",
      "metric": "cosine",
      "dimension": 1536,
      "status": {
        "ready": true,
        "state": "Ready"
      },
      "host": "docs-example-dense-govk0nt.svc.aped-4627-b74a.pinecone.io",
      "spec": {
        "serverless": {
          "region": "us-east-1",
          "cloud": "aws"
        }
      },
      "deletion_protection": "disabled",
      "tags": {
        "environment": "development"
      }
    }
  ]
}
from pinecone.grpc import PineconeGRPC as Pinecone

pc = Pinecone(api_key="YOUR_API_KEY")

index_list = pc.list_indexes()

print(index_list)
import { Pinecone } from '@pinecone-database/pinecone'

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

const indexList = await pc.listIndexes();

console.log(indexList);
import io.pinecone.clients.Pinecone;
import org.openapitools.db_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/v3/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-10"
[{
    "name": "docs-example-sparse",
    "metric": "dotproduct",
    "host": "docs-example-sparse-govk0nt.svc.aped-4627-b74a.pinecone.io",
    "spec": {
        "serverless": {
            "cloud": "aws",
            "region": "us-east-1"
        }
    },
    "status": {
        "ready": true,
        "state": "Ready"
    },
    "vector_type": "sparse",
    "dimension": null,
    "deletion_protection": "disabled",
    "tags": {
        "environment": "development"
    }
}, {
    "name": "docs-example-dense",
    "metric": "cosine",
    "host": "docs-example-dense-govk0nt.svc.aped-4627-b74a.pinecone.io",
    "spec": {
        "serverless": {
            "cloud": "aws",
            "region": "us-east-1"
        }
    },
    "status": {
        "ready": true,
        "state": "Ready"
    },
    "vector_type": "dense",
    "dimension": 1536,
    "deletion_protection": "disabled",
    "tags": {
        "environment": "development"
    }
}]
{
  indexes: [
    {
      name: 'docs-example-sparse',
      dimension: undefined,
      metric: 'dotproduct',
      host: 'docs-example-sparse-govk0nt.svc.aped-4627-b74a.pinecone.io',
      deletionProtection: 'disabled',
      tags: { environment: 'development', example: 'tag' },
      embed: undefined,
      spec: { pod: undefined, serverless: { cloud: 'aws', region: 'us-east-1' } },
      status: { ready: true, state: 'Ready' },
      vectorType: 'sparse'
    },
    {
      name: 'docs-example-dense',
      dimension: 1536,
      metric: 'cosine',
      host: 'docs-example-dense-govk0nt.svc.aped-4627-b74a.pinecone.io',
      deletionProtection: 'disabled',
      tags: { environment: 'development', example: 'tag' },
      embed: undefined,
      spec: { pod: undefined, serverless: { cloud: 'aws', region: 'us-east-1' } },
      status: { ready: true, state: 'Ready' },
      vectorType: 'dense'
    }
  ]
}
class IndexList {
    indexes: [class IndexModel {
        name: docs-example-sparse
        dimension: null
        metric: dotproduct
        host: docs-example-sparse-govk0nt.svc.aped-4627-b74a.pinecone.io
        deletionProtection: disabled
        tags: {environment=development}
        embed: null
        spec: class IndexModelSpec {
            pod: null
            serverless: class ServerlessSpec {
                cloud: aws
                region: us-east-1
                additionalProperties: null
            }
            additionalProperties: null
        }
        status: class IndexModelStatus {
            ready: true
            state: Ready
            additionalProperties: null
        }
        vectorType: sparse
        additionalProperties: null
    }, class IndexModel {
        name: docs-example-dense
        dimension: 1536
        metric: cosine
        host: docs-example-dense-govk0nt.svc.aped-4627-b74a.pinecone.io
        deletionProtection: disabled
        tags: {environment=development}
        embed: null
        spec: class IndexModelSpec {
            pod: null
            serverless: class ServerlessSpec {
                cloud: aws
                region: us-east-1
                additionalProperties: null
            }
            additionalProperties: null
        }
        status: class IndexModelStatus {
            ready: true
            state: Ready
            additionalProperties: null
        }
        vectorType: dense
        additionalProperties: null
    }]
    additionalProperties: null
}
index: {
  "name": "docs-example-sparse",
  "host": "docs-example-sparse-govk0nt.svc.aped-4627-b74a.pinecone.io",
  "metric": "dotproduct",
  "vector_type": "sparse",
  "deletion_protection": "disabled",
  "dimension": null,
  "spec": {
    "serverless": {
      "cloud": "aws",
      "region": "us-east-1"
    }
  },
  "status": {
    "ready": true,
    "state": "Ready"
  },
  "tags": {
    "environment": "development"
  }
}
index: {
  "name": "docs-example-dense",
  "host": "docs-example-dense-govk0nt.svc.aped-4627-b74a.pinecone.io",
  "metric": "cosine",
  "vector_type": "dense",
  "deletion_protection": "disabled",
  "dimension": 1536,
  "spec": {
    "serverless": {
      "cloud": "aws",
      "region": "us-east-1"
    }
  },
  "status": {
    "ready": true,
    "state": "Ready"
  },
  "tags": {
    "environment": "development"
  }
}
{
  "indexes": [
    {
      "name": "docs-example-sparse",
      "metric": "dotproduct",
      "host": "docs-example-sparse-govk0nt.svc.aped-4627-b74a.pinecone.io",
      "deletion_protection": "disabled",
      "tags": {
        "environment": "development"
      },
      "spec": {
        "serverless": {
          "cloud": "aws",
          "region": "us-east-1"
        }
      },
      "status": {
        "ready": true,
        "state": "Ready"
      },
      "vector_type": "sparse"
    },
    {
      "name": "docs-example-dense",
      "dimension": 1536,
      "metric": "cosine",
      "host": "docs-example-dense-govk0nt.svc.aped-4627-b74a.pinecone.io",
      "deletion_protection": "disabled",
      "tags": {
        "environment": "development"
      },
      "spec": {
        "serverless": {
          "cloud": "aws",
          "region": "us-east-1"
        }
      },
      "status": {
        "ready": true,
        "state": "Ready"
      },
      "vector_type": "dense"
    }
  ]
}
{
  "indexes": [
    {
      "name": "docs-example-sparse",
      "vector_type": "sparse",
      "metric": "dotproduct",
      "dimension": null,
      "status": {
        "ready": true,
        "state": "Ready"
      },
      "host": "docs-example-sparse-govk0nt.svc.aped-4627-b74a.pinecone.io",
      "spec": {
        "serverless": {
          "region": "us-east-1",
          "cloud": "aws"
        }
      },
      "deletion_protection": "disabled",
      "tags": {
        "environment": "development"
      }
    },
    {
      "name": "docs-example-dense",
      "vector_type": "dense",
      "metric": "cosine",
      "dimension": 1536,
      "status": {
        "ready": true,
        "state": "Ready"
      },
      "host": "docs-example-dense-govk0nt.svc.aped-4627-b74a.pinecone.io",
      "spec": {
        "serverless": {
          "region": "us-east-1",
          "cloud": "aws"
        }
      },
      "deletion_protection": "disabled",
      "tags": {
        "environment": "development"
      }
    }
  ]
}

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