Get vector store 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
get
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": "2025-06-26T13:17:19.889Z",
  "modified": "2025-06-26T13:17:19.889Z"
}

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.

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.

Last updated