POST
/
indexes

Authorizations

Api-Key
string
headerrequired

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

Body

application/json

The configuration needed to create 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
dimension
integer
required

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

Required range: 1 < x < 20000
spec
object
required

The spec object defines how the index should be deployed.

For serverless indexes, you define only the cloud and region where the index should be hosted. For pod-based indexes, you define the environment where the index should be hosted, the pod type and size to use, and other index characteristics.

metric
enum<string>
default: cosine

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

Available options:
cosine,
euclidean,
dotproduct
deletion_protection
enum<string>
default: disabled

Whether deletion protection is enabled/disabled for the index.

Available options:
disabled,
enabled
tags
object | null

Custom user tags added to an index. Keys must be alphanumeric and 80 characters or less. Values must be 120 characters or less.

Response

201 - 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
dimension
integer
required

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

Required range: 1 < x < 20000
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
required

The URL address where the index is hosted.

spec
object
required
status
object
required
deletion_protection
enum<string>
default: disabled

Whether deletion protection is enabled/disabled for the index.

Available options:
disabled,
enabled
tags
object | null

Custom user tags added to an index. Keys must be alphanumeric and 80 characters or less. Values must be 120 characters or less.