Skip to content

Vector Store API

DRAFT — Internal Developer Use Only

This API reference is for internal development teams.

Overview

What it is: The vector store API manages collections of vector embeddings for semantic search and AI-powered queries. Collections store document embeddings that enable similarity search across identity data.

Endpoints

MethodPathDescriptionAuth required
POST/internal/v1/ai/vector_store/collectionCreate a collectionJWT + API token
GET/internal/v1/ai/vector_store/collectionList all collectionsJWT + API token
GET/internal/v1/ai/vector_store/collection/:idGet collection detailsJWT + API token
POST/internal/v1/ai/vector_store/collection/:id/queryQuery a collectionJWT + API token
DELETE/internal/v1/ai/vector_store/collection/:idDelete a collectionJWT + API token

POST /internal/v1/ai/vector_store/collection

Create a new vector store collection.

Request:

http
POST /internal/v1/ai/vector_store/collection
Authorization: Bearer <token>
Content-Type: application/json

{
  "name": "identity-embeddings",
  "description": "Vector embeddings for identity entity search",
  "dimensions": 1536
}

Response (201):

json
{
  "id": "collection-uuid-001",
  "name": "identity-embeddings",
  "status": "created",
  "documentCount": 0
}

POST /internal/v1/ai/vector_store/collection/:id/query

Execute a semantic query against a vector store collection.

Request:

http
POST /internal/v1/ai/vector_store/collection/collection-uuid-001/query
Authorization: Bearer <token>
Content-Type: application/json

{
  "query": "privileged accounts with access to production databases",
  "topK": 10,
  "threshold": 0.7
}

Response (200):

json
{
  "results": [
    {
      "id": "doc-001",
      "score": 0.95,
      "metadata": {
        "entityType": "account",
        "source": "PostgreSQL"
      },
      "content": "DBA admin account with full access to production database cluster"
    }
  ]
}

Hydden Documentation and Training Hub