VectorStore

Test vector store connection with raw credentials

Changed on

Test connectivity using provided credentials without persisting. Returns detected server version.

post/vector-stores/test

Request

  • Base URL
    /api/v1 (relative, and the document was published on a file host, not at the API’s origin)
  • URL
    /api/v1/vector-stores/test
  • Auth
    • API key in header Authorization
    • or API key in header X-API-Key

Request body

engine_type'postgres' | 'elasticsearch' | 'infinity' | 'elasticfaiss' | 'qdrant' | 'milvus' | 'weaviate' | 'doris' | 'sqlite' | 'tencent_vectordb' | 'opensearch' required

Response

Connection test result (success, version)

errorstring
successboolean
versionstring

Example response

{
  "success": true
}

Changes