Context Data
  • Welcome to the Context Data Documentation
  • Quickstart
  • Adding Source Connections
  • Adding Embedding Models
  • Adding Target Connections
  • Create Transformations
  • Create and Run Flows
  • API reference
    • Auth
    • Workspace
      • Source connections
      • Embedding models
      • Chat models
      • Target connections
      • Flows
      • Vector Store Query
      • Query sessions
  • API Documentation (Redoc)
Powered by GitBook
On this page
  1. API reference
  2. Workspace

Vector Store Query

PreviousFlowsNextQuery sessions

Query

post

Run a vector search query on configured target connection

Authorizations
Body
vector_store_identifierstringRequired

Vector Store (Target Connection) identifier. Get the UUID from the '/target_connections' endpoint

vector_store_columnstring[]Required

Specify the columns/fields in the target vector store connection

embedding_model_identifierstringRequired

Embedding model identifier. Get the UUID from the '/embedding_models' endpoint

query_textstringRequired

Your query text

response_limitany ofOptional
integerOptional
or
nullOptional
Responses
post
POST /api/workspace/query HTTP/1.1
Host: sapphire.contextdata.ai
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 140

{
  "vector_store_identifier": "text",
  "vector_store_column": [
    "text"
  ],
  "embedding_model_identifier": "text",
  "query_text": "text",
  "response_limit": 1
}
{
  "message": "text",
  "data": {}
}