Describe an index

Get a description of an index.

cURL

PINECONE_API_KEY = "YOUR_API_KEY"

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

Response

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

Authorizations

Api-Key

string

header

required

Path Parameters

index_name

string

required

The name of the index to be described.

Response

200

application/json

Configuration information and deployment status of the index.

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

Example:

"example-index"

dimension

integer

required

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

Required range: 1 <= x <= 20000

Example:

1536

metric

enum<string>

default:cosine

required

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

Available options:

cosine,

euclidean,

dotproduct

spec

object

required

Show child attributes

spec.pod

object

Configuration needed to deploy a pod-based index.

Show child attributes

spec.pod.environment

string

required

The environment where the index is hosted.

Example:

"us-east1-gcp"

spec.pod.replicas

integer

default:1

required

The number of replicas. Replicas duplicate your index. They provide higher availability and throughput. Replicas can be scaled up or down as your needs change.

Required range: x >= 1

spec.pod.shards

integer

default:1

required

The number of shards. Shards split your data across multiple pods so you can fit more data into an index.

Required range: x >= 1

spec.pod.pod_type

string

default:p1.x1

required

The type of pod to use. One of s1, p1, or p2 appended with . and one of x1, x2, x4, or x8.

spec.pod.pods

integer

default:1

required

The number of pods to be used in the index. This should be equal to shards x replicas.'

Required range: x >= 1

Example:

1

spec.pod.metadata_config

object

Configuration for the behavior of Pinecone's internal metadata index. By default, all metadata is indexed; when metadata_config is present, only specified metadata fields are indexed. These configurations are only valid for use with pod-based indexes.

Show child attributes

spec.pod.metadata_config.indexed

string[]

By default, all metadata is indexed; to change this behavior, use this property to specify an array of metadata fields that should be indexed.

Example:

{
  "indexed": ["genre", "title", "imdb_rating"]
}

spec.pod.source_collection

string

The name of the collection to be used as the source for the index.

Example:

"movie-embeddings"

Example:

{
  "environment": "us-east1-gcp",
  "replicas": 1,
  "shards": 1,
  "pod_type": "p1.x1",
  "pods": 1,
  "metadata_config": {
    "indexed": ["genre", "title", "imdb_rating"]
  },
  "source_collection": "movie-embeddings"
}

spec.serverless

object

Configuration needed to deploy a serverless index.

Show child attributes

spec.serverless.cloud

enum<string>

required

The public cloud where you would like your index hosted. Serverless indexes can be hosted only in AWS at this time.

Available options:

gcp,

aws,

azure

Example:

"aws"

spec.serverless.region

string

required

The region where you would like your index to be created. Serverless indexes can be created only in the us-west-2 region of AWS at this time.

Example:

"us-west-2"

Example:

{
  "pod": {
    "environment": "us-east-1-aws",
    "replicas": 1,
    "shards": 1,
    "pod_type": "p1.x1",
    "pods": 1,
    "metadata_config": {
      "indexed": ["genre", "title", "imdb_rating"]
    }
  }
}

status

object

required

Show child attributes

status.ready

boolean

required

status.state

enum<string>

required

Available options:

Initializing,

InitializationFailed,

ScalingUp,

ScalingDown,

ScalingUpPodSize,

ScalingDownPodSize,

Upgrading,

Terminating,

Ready

Example:

{
  "ready": true,
  "state": "ScalingUpPodSize"
}

host

string

The URL address where the index is hosted.

Example:

"semantic-search-c01b5b5.svc.us-west1-gcp.pinecone.io"