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"
  },
  "vector_type": "dense"
}

Path Parameters

​
index_name
string
required

The name of the index to be described.

Response

200 - application/json

The IndexModel describes the configuration and status of a Pinecone index.

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

Required string length: 1 - 45
​
metric
enum<string>
required

The distance metric to be used for similarity search. You can use 'euclidean', 'cosine', or 'dotproduct'. If the 'vector_type' is 'sparse', the metric must be 'dotproduct'. If the vector_type is dense, the metric defaults to 'cosine'.

Available options:
cosine,
euclidean,
dotproduct
​
host
string
required

The URL address where the index is hosted.

​
spec
object
required
​
status
object
required
​
vector_type
string
default: denserequired

The index vector type. You can use 'dense' or 'sparse'. If 'dense', the vector dimension must be specified. If 'sparse', the vector dimension should not be specified.

​
dimension
integer

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

Required range: 1 < x < 20000
​
deletion_protection
enum<string>
default: disabled

Whether deletion protection is enabled/disabled for the index.

Available options:
disabled,
enabled
​
tags
object

Custom user tags added to an index. Keys must be 80 characters or less. Values must be 120 characters or less. Keys must be alphanumeric, '', or '-'. Values must be alphanumeric, ';', '@', '', '-', '.', '+', or ' '. To unset a key, set the value to be an empty string.

​
embed
object

The embedding model and document fields mapped to embedding inputs.

Was this page helpful?

Create an indexDelete an index