GET
/
indexes
/
{index_name}
{
  "dimension": 1536,
  "host": "movie-recommendations-c01b5b5.svc.us-east1-gcp.pinecone.io",
  "metric": "cosine",
  "name": "movie-recommendations",
  "spec": {
    "serverless": {
      "cloud": "aws",
      "region": "us-east-1"
    }
  },
  "status": {
    "ready": false,
    "state": "Initializing"
  }
}

The describe_index operation uses a different API (api.pinecone.io) than data plane operations such as upsert and query. In production, you should therefore not rely on describe_index to programmatically get an index endpoint for data manipulation operations. Instead, you should get an index endpoint once and cache it for reuse or specify the endpoint directly.

Authorizations

Api-Key
string
headerrequired

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

Path Parameters

index_name
string
required

The name of the index to be described.

Response

200 - application/json
name
string
required

The 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 '-'.

dimension
integer
required

The dimensions of the vectors to be inserted in the index.

metric
enum<string>
default: cosinerequired

The distance metric to be used for similarity search. You can use 'euclidean', 'cosine', or 'dotproduct'.

Available options:
cosine,
euclidean,
dotproduct
host
string
required

The URL address where the index is hosted.

deletion_protection
enum<string>
default: disabled

Whether deletion protection is enabled/disabled for the index.

Available options:
disabled,
enabled
spec
object
required
status
object
required

Was this page helpful?

Create an indexDelete an index