Get vector store's information

get

Retrieve information about the vector store associated with the API key.

Header parameters

x-api-keystringRequired

The API key for authentication.

Responses

200

Vector store information retrieved successfully.

application/json

idstringOptional

The ID of the vector store.

namestringOptional

The name of the vector store.

descriptionstringOptional

Description of the vector store.

embedding_modelstringOptional

The embedding model used.

indexing_algorithmstringOptional

The indexing algorithm used.

vector_dimensionintegerOptional

The dimension of the vectors.

search_metricstringOptional

The search metric used.

createdstring · date-timeOptional

Creation timestamp.

modifiedstring · date-timeOptional

Modification timestamp.

get

/vector-stores/me

GET /api/v1/vector-stores/me HTTP/1.1
Host: api.rememberizer.ai
x-api-key: text
Accept: */*

200

Vector store information retrieved successfully.

{
  "id": "text",
  "name": "text",
  "description": "text",
  "embedding_model": "text",
  "indexing_algorithm": "text",
  "vector_dimension": 1,
  "search_metric": "text",
  "created": "2026-02-27T03:40:28.888Z",
  "modified": "2026-02-27T03:40:28.888Z"
}

Example Requests

curl -X GET \
  https://api.rememberizer.ai/api/v1/vector-stores/me \
  -H "x-api-key: YOUR_API_KEY"

Replace YOUR_API_KEY with your actual Vector Store API key.

const getVectorStoreInfo = async () => {
  const response = await fetch('https://api.rememberizer.ai/api/v1/vector-stores/me', {
    method: 'GET',
    headers: {
      'x-api-key': 'YOUR_API_KEY'
    }
  });
  
  const data = await response.json();
  console.log(data);
};

getVectorStoreInfo();

Replace YOUR_API_KEY with your actual Vector Store API key.

import requests

def get_vector_store_info():
    headers = {
        "x-api-key": "YOUR_API_KEY"
    }
    
    response = requests.get(
        "https://api.rememberizer.ai/api/v1/vector-stores/me",
        headers=headers
    )
    
    data = response.json()
    print(data)

get_vector_store_info()

Replace YOUR_API_KEY with your actual Vector Store API key.

Response Format

{
  "id": "vs_abc123",
  "name": "My Vector Store",
  "description": "A vector store for product documentation",
  "embedding_model": "sentence-transformers/all-mpnet-base-v2",
  "indexing_algorithm": "ivfflat",
  "vector_dimension": 128,
  "search_metric": "cosine_distance",
  "created": "2023-06-01T10:30:00Z",
  "modified": "2023-06-15T14:45:00Z"
}

Authentication

This endpoint requires authentication using an API key in the x-api-key header.

Error Responses

Status Code

Description

401

Unauthorized - Invalid or missing API key

404

Not Found - Vector Store not found

500

Internal Server Error

This endpoint retrieves information about the vector store associated with the provided API key. It's useful for checking configuration details, including the embedding model, dimensionality, and search metric being used. This information can be valuable for optimizing search queries and understanding the vector store's capabilities.

PreviousGet the information of a document NextRemove a document in Vector Store

Last updated 3 months ago

hashtagExample Requests

hashtagResponse Format

hashtagAuthentication

hashtagError Responses

Example Requests

Response Format

Authentication

Error Responses