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

curl -s -X PATCH "https://api.pinecone.io/indexes/example-index" \
  -H "Content-Type: application/json" \
  -H "Api-Key: $PINECONE_API_KEY" \
  -d '{
         "pod_type": "s1.x2",
         "replicas": 4
      }'

{
  "name": "example-index",
  "dimension": 1536,
  "metric": "cosine",
  "host": "semantic-search-c01b5b5.svc.us-west1-gcp.pinecone.io",
  "spec": {
    "pod": {
      "environment": "us-east-1-aws",
      "replicas": 1,
      "shards": 1,
      "pod_type": "p1.x1",
      "pods": 1,
      "metadata_config": {
        "indexed": [
          "genre",
          "title",
          "imdb_rating"
        ]
      }
    }
  },
  "status": {
    "ready": true,
    "state": "ScalingUpPodSize"
  }
}

Authorizations

Api-Key
string
headerrequired

Path Parameters

index_name
string
required

The name of the index to configure.

Body

application/json
spec
object
required

Response

202 - 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?

Delete an indexList collections