Skip to main content
POST
Create Index
Create a new encrypted index with the specified configuration.

Request Body

Index Types

Suitable for applications requiring high recall with moderate memory usage:
Speed: Fast | Recall: Highest | Index Size: Biggest

IVF

Ideal for large-scale datasets where fast retrieval is prioritized:
Speed: Fastest | Recall: Lowest | Index Size: Smallest

IVFPQ

Product Quantization compresses embeddings, balancing memory use and recall:
Speed: Fast | Recall: High | Index Size: Medium

Distance Metrics

  • "euclidean": Euclidean distance
  • "cosine": Cosine similarity
  • "squared_euclidean": Squared Euclidean distance

Response

Exceptions

  • 401: Authentication failed (invalid API key)
  • 409: Index name already exists
  • 422: Invalid request parameters
  • 500: Internal server error

Example Usage

With Auto-Embedding

When embedding_model is specified, the dimension parameter in index_config is optional as it will be inferred from the embedding model.