Skip to main content
POST
/
indexes
/
create-for-model
PINECONE_API_KEY="YOUR_API_KEY"

curl https://api.pinecone.io/indexes/create-for-model \
  -H "Content-Type: application/json" \
  -H "Api-Key: $PINECONE_API_KEY" \
  -H "X-Pinecone-Api-Version: 2025-10" \
  -d '{
        "name": "integrated-dense-curl",
        "cloud": "aws",
        "region": "us-east-1",
        "embed": {
          "model": "llama-text-embed-v2",
          "metric": "cosine",
          "field_map": {
            "text": "chunk_text"
          },
          "write_parameters": {
            "input_type": "passage",
            "truncate": "END"
          },
          "read_parameters": {
            "input_type": "query",
            "truncate": "END"
          }
        }
      }'

{
  "id": "9dabb7cb-ec0a-4e2e-b79e-c7c997e592ce",
  "name": "integrated-dense-curl",
  "metric": "cosine",
  "dimension": 1024,
  "status": {
    "ready": false,
    "state": "Initializing"
  },
  "host": "integrated-dense-curl-govk0nt.svc.aped-4627-b74a.pinecone.io",
  "spec": {
    "serverless": {
      "region": "us-east-1",
      "cloud": "aws"
    }
  },
  "deletion_protection": "disabled",
  "tags": null,
  "embed": {
    "model": "llama-text-embed-v2",
    "field_map": {
      "text": "chunk_text"
    },
    "dimension": 1024,
    "metric": "cosine",
    "write_parameters": {
      "input_type": "passage",
      "truncate": "END"
    },
    "read_parameters": {
      "input_type": "query",
      "truncate": "END"
    }
  }
}

PINECONE_API_KEY="YOUR_API_KEY"

curl https://api.pinecone.io/indexes/create-for-model \
  -H "Content-Type: application/json" \
  -H "Api-Key: $PINECONE_API_KEY" \
  -H "X-Pinecone-Api-Version: 2025-10" \
  -d '{
        "name": "integrated-dense-curl",
        "cloud": "aws",
        "region": "us-east-1",
        "embed": {
          "model": "llama-text-embed-v2",
          "metric": "cosine",
          "field_map": {
            "text": "chunk_text"
          },
          "write_parameters": {
            "input_type": "passage",
            "truncate": "END"
          },
          "read_parameters": {
            "input_type": "query",
            "truncate": "END"
          }
        }
      }'

{
  "id": "9dabb7cb-ec0a-4e2e-b79e-c7c997e592ce",
  "name": "integrated-dense-curl",
  "metric": "cosine",
  "dimension": 1024,
  "status": {
    "ready": false,
    "state": "Initializing"
  },
  "host": "integrated-dense-curl-govk0nt.svc.aped-4627-b74a.pinecone.io",
  "spec": {
    "serverless": {
      "region": "us-east-1",
      "cloud": "aws"
    }
  },
  "deletion_protection": "disabled",
  "tags": null,
  "embed": {
    "model": "llama-text-embed-v2",
    "field_map": {
      "text": "chunk_text"
    },
    "dimension": 1024,
    "metric": "cosine",
    "write_parameters": {
      "input_type": "passage",
      "truncate": "END"
    },
    "read_parameters": {
      "input_type": "query",
      "truncate": "END"
    }
  }
}

Authorizations

​
Api-Key
string
header
required

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

Headers

​
X-Pinecone-Api-Version
string
default:2025-10
required

Required date-based version header

Body

application/json

The desired configuration for the index and associated embedding model.

​
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"

​
cloud
string
required

The public cloud where you would like your index hosted. Possible values: gcp, aws, or azure.

Example:

"aws"

​
region
string
required

The region where you would like your index to be created.

Example:

"us-east-1"

​
embed
object
required

Specify the integrated inference embedding configuration for the index.

Once set the model cannot be changed, but you can later update the embedding configuration for an integrated inference index including field map, read parameters, or write parameters.

Refer to the model guide for available models and model details.

Example:
{
  "field_map": { "text": "your-text-field" },
  "metric": "cosine",
  "model": "multilingual-e5-large",
  "read_parameters": { "input_type": "query", "truncate": "NONE" },
  "write_parameters": { "input_type": "passage" }
}
​
deletion_protection
string
default:disabled

Whether deletion protection is enabled/disabled for the index. Possible values: disabled or 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.

Example:
{ "tag0": "val0", "tag1": "val1" }
​
schema
object

Schema for the behavior of Pinecone's internal metadata index. By default, all metadata is indexed; when schema is present, only fields which are present in the fields object with a filterable: true are indexed. Note that filterable: false is not currently supported.

Example:
{
  "fields": {
    "description": { "filterable": true },
    "genre": { "filterable": true },
    "year": { "filterable": true }
  }
}
​
read_capacity
object

By default the index will be created with read capacity mode OnDemand. If you prefer to allocate dedicated read nodes for your workload, you must specify mode Dedicated and additional configurations for node_type and scaling.

  • On-demand
  • Dedicated
Example:
{ "mode": "OnDemand" }

Response

The index has successfully been created for the embedding model.

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"

​
metric
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'. Possible values: cosine, euclidean, or dotproduct.

​
host
string
required

The URL address where the index is hosted.

Example:

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

​
spec
object
required

The spec object defines how the index should be deployed.

  • Serverless
  • Pod-based
  • BYOC
Example:
{
  "pod": {
    "environment": "us-east-1-aws",
    "metadata_config": {
      "indexed": ["genre", "title", "imdb_rating"]
    },
    "pod_type": "p1.x1",
    "pods": 1,
    "replicas": 1,
    "shards": 1
  }
}
​
status
object
required

The current status of the index

Example:
{
  "ready": true,
  "state": "ScalingUpPodSize"
}
​
vector_type
string
default:dense
required

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
Example:

1536

​
private_host
string

The private endpoint URL of an index.

Example:

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

​
deletion_protection
string
default:disabled

Whether deletion protection is enabled/disabled for the index. Possible values: disabled or 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.

Example:
{ "tag0": "val0", "tag1": "val1" }
​
embed
object

The embedding model and document fields mapped to embedding inputs.

Example:
{
  "field_map": { "text": "your-text-field" },
  "metric": "cosine",
  "model": "multilingual-e5-large",
  "read_parameters": { "input_type": "query", "truncate": "NONE" },
  "write_parameters": { "input_type": "passage" }
}
⌘I