GET
/
indexes
/
{index_name}
PINECONE_API_KEY = "YOUR_API_KEY"

curl -i -X GET "https://api.pinecone.io/indexes/serverless-index" \
    -H "Api-Key: $PINECONE_API_KEY"

{
   "name": "serverless-index",
   "metric": "cosine",
   "dimension": 1536,
   "status": {
      "ready": true,
      "state": "Ready"
   },
   "host": "serverless-index-4zo0ijk.svc.us-east1-aws.pinecone.io",
   "spec": {
      "serverless": {
         "region": "us-east-1",
         "cloud": "aws"
      }
   }
}

Authorizations

Api-Key
string
headerrequired

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

The URL address where the index is hosted.

spec
object
required
status
object
required

Was this page helpful?

Create an indexDelete an index