v1

latestOpenAPI 3.0.3Apache 2.02026-07-1372170520.1 KB
Manage Indexes

List indexes

List all indexes in a project.

get/indexes

Headers

X-Pinecone-Api-Versionstring required

Required date-based version header

Response

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

Example response

{
  "indexes": [
    {
      "name": "example-index",
      "dimension": 1536,
      "host": "semantic-search-c01b5b5.svc.us-west1-gcp.pinecone.io",
      "private_host": "semantic-search-c01b5b5.svc.private.us-west1-gcp.pinecone.io",
      "tags": {
        "tag0": "val0",
        "tag1": "val1"
      },
      "embed": {
        "field_map": {
          "text": "your-text-field"
        },
        "metric": "cosine",
        "model": "multilingual-e5-large",
        "read_parameters": {
          "input_type": "query",
          "truncate": "NONE"
        },
        "write_parameters": {
          "input_type": "passage"
        }
      },
      "spec": {
        "serverless": {
          "cloud": "aws",
          "region": "us-east-1",
          "read_capacity": {
            "mode": "OnDemand",
            "status": {
              "state": "Ready"
            }
          },
          "source_collection": "movie-embeddings",
          "schema": {
            "fields": {
              "description": {
                "filterable": true
              },
              "genre": {
                "filterable": true
              },
              "year": {
                "filterable": true
              }
            }
          }
        }
      },
      "status": {
        "ready": true,
        "state": "ScalingUpPodSize"
      }
    }
  ]
}