Skip to Content
API Reference

API Reference

VectorX Class

  • __init__(token=None): Initialize with optional API token
  • set_token(token): Set API token
  • set_base_url(base_url): Set custom API endpoint
  • generate_key(): Generate a secure encryption key
  • create_index(name, dimension, key, space_type, ...): Create a new index
  • list_indexes(): List all indexes
  • delete_index(name): Delete an index
  • get_index(name, key): Get reference to an index

Index Class

  • upsert(input_array): Insert or update vectors
  • query(vector, top_k, filter, ef, include_vectors): Search for similar vectors
  • delete_vector(id): Delete a vector by ID
  • delete_with_filter(filter): Delete vectors matching a filter
  • get_vector(id): Get a specific vector
  • describe(): Get index statistics and info
Last updated on