Skip to main content
PUT
/
api
/
v1
/
indexes
/
{indexName}
/
create
Create an index
curl --request PUT \
  --url https://api.example.com/api/v1/indexes/{indexName}/create \
  --header 'Content-Type: application/json' \
  --header 'X-Eigen-API-Key: <api-key>' \
  --data '
{
  "dimensions": 123,
  "metric": "<string>"
}
'
{
  "status": 200,
  "message": "Index '<indexName>' created successfully."
}

Documentation Index

Fetch the complete documentation index at: https://eigendb.mintlify.app/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

​
X-Eigen-API-Key
string
header
required

Path Parameters

​
indexName
string
required

Name of the index

Body

application/json
​
dimensions
number<integer>
required

Dimensions of the index

​
metric
string
required

The similarity metric for the index

Response

Index created successfully.

​
status
integer
required

Status code of the response

​
message
string
required

Message giving basic information on the response

​
data
object

Important data to be given to the caller

​
error
object

An error that has occured