Create Vector Index

Create a new vector index in a specified cloud region. POST /vectors/indexes

Try it

Authorizations

Authorization: API key (header) — required

Body (application/json)

Field	Type	Required	Description
name	string	required	Index name (1-255 chars, alphanumeric, ’-’, ’_‘)
dimension	integer	required	Vector dimension (1-2000)
cloud_provider	`enum<string>`	required	Cloud provider: 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
metric	`enum<string>`	default: cosine	Similarity metric: cosine, euclidean, dot_product
vector_type	`enum<string>`	default: dense	Vector type: dense
metadata	object	optional	Custom metadata (max 1MB JSON)
delete_protection	boolean	default: false	Enable delete protection

Example Requests

cURL
Python SDK
JavaScript SDK

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
  }'

Responses

201 Created — application/json — Index created successfully Example body:

{
  "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"
}

400 Bad Request — invalid input
401 Unauthorized — missing/invalid API key
500 Internal Server Error — server error

Fields in Response

Field	Type	Description
id	string	Index ID (UUID)
name	string	Index name
dimension	integer	Vector dimension
metric	string	Similarity metric
vector_type	string	Vector type
cloud_provider	string	Cloud provider
region	string	Region ID
index_type	string	Index type
metadata	object	Custom metadata
delete_protection	boolean	Delete protection flag
created_at	string (date-time)	Creation timestamp (ISO 8601)

Introduction

AI Inference

Files

Vectors

Memory

Integrations

Policies

Create Vector Index

Try it

Authorizations

Body (application/json)

Example Requests

Responses

Fields in Response

Introduction

AI Inference

Files

Vectors

Memory

Integrations

Policies

​Try it

​Authorizations

​Body (application/json)

​Example Requests

​Responses

​Fields in Response

Try it

Authorizations

Body (application/json)

Example Requests

Responses

Fields in Response