Skip to main content
POST
/
vectors
/
indexes
Create Vector Index
curl --request POST \
  --url https://api.gravixlayer.com/v1/vectors/indexes \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "name": "my-embeddings-index",
  "dimension": 1536,
  "metric": "cosine",
  "vector_type": "dense",
  "cloud_provider": "AWS",
  "region": "us-east-1",
  "index_type": "serverless",
  "metadata": {
    "project": "recommendation-engine",
    "environment": "production"
  },
  "delete_protection": true
}'
{
  "id": "idx-1234567890abcdef",
  "name": "my-embeddings-index",
  "dimension": 1536,
  "metric": "cosine",
  "vector_type": "dense",
  "cloud_provider": "AWS",
  "region": "us-east-1",
  "index_type": "serverless",
  "metadata": {
    "project": "recommendation-engine",
    "environment": "production"
  },
  "delete_protection": true,
  "created_at": "2025-10-15T12:34:56Z"
}

Authorizations

​
Authorization
string
header
required

API key authentication. Get your API key from the Gravix Layer Dashboard.

Body

application/json
​
name
string
required

Index name (1-255 chars, alphanumeric, -, _)

​
dimension
integer
required

Vector dimension (1-2000)

Required range: 1 <= x <= 2000
​
cloud_provider
enum<string>
required

Cloud provider: AWS, GCP, Azure, Gravix

Available options:
AWS,
GCP,
Azure,
Gravix
​
region
string
required

Region ID. Allowed values: AWS: us-east-1, us-west-2, eu-west-1; GCP: us-central1; Azure: eastus; Gravix: gravix-us-1

​
index_type
enum<string>
required

Index type: serverless, dedicated

Available options:
serverless,
dedicated
​
metric
enum<string>
default:cosine

Similarity metric: cosine, euclidean, dot_product (default: cosine)

Available options:
cosine,
euclidean,
dot_product
​
vector_type
enum<string>
default:dense

Vector type: dense (default: dense)

Available options:
dense
​
metadata
object

Custom metadata (max 1MB JSON)

​
delete_protection
boolean
default:false

Enable delete protection (default: false)

Response

Index created successfully

​
id
string

Index ID (UUID)

​
name
string

Index name (1-255 chars, alphanumeric, -, _)

​
dimension
integer

Vector dimension (1-2000)

​
metric
string

Similarity metric: cosine, euclidean, dot_product (default: cosine)

​
vector_type
string

Vector type: dense (default: dense)

​
cloud_provider
string

Cloud provider: AWS, GCP, Azure, Gravix

​
region
string

Region ID. Allowed values: AWS: us-east-1, us-west-2, eu-west-1; GCP: us-central1; Azure: eastus; Gravix: gravix-us-1

​
index_type
string

Index type: serverless, dedicated

​
metadata
object

Custom metadata (max 1MB JSON)

​
delete_protection
boolean

Enable delete protection (default: false)

​
created_at
string<date-time>

Creation timestamp (ISO 8601)

⌘I