VectorStore

Test vector store connection by ID

Changed on

Test connectivity of an existing saved or env store. Returns detected server version. For DB stores, the version is automatically saved to connection_config.

post/vector-stores/{id}/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/{id}/test
  • Auth
    • API key in header Authorization
    • or API key in header X-API-Key

Path parameters

idstring required

Vector store ID

Response

Connection test result (success, version)

errorstring
successboolean
versionstring

Example response

{
  "success": true
}

Changes