Skip to navigation
API ReferenceVector storage and retrieval

Query Vectors

Authentication

AuthorizationBearer

Use a tq_live_ API key as a Bearer token.

Path parameters

index_idstringRequired

Request

This endpoint expects an object.
search_typeenumOptionalDefaults to dense
vectorlist of doubles or nullOptional
query_textstring or nullOptional1-10000 characters
sparse_querystring or nullOptional<=10000 characters
agentic_querystring or nullOptional1-2000 characters
top_kintegerOptional1-1000Defaults to 10
min_scoredoubleOptional0-1Defaults to 0
filtermap from strings to any or nullOptional
include_metadatabooleanOptionalDefaults to true
include_distancebooleanOptionalDefaults to true

Response

Successful Response
search_typeenum
resultslist of objects
status"ok"OptionalDefaults to ok
latency_msdoubleOptionalDefaults to 0
dense_latency_msdouble or nullOptional
sparse_latency_msdouble or nullOptional
fusion_latency_msdouble or nullOptional
planner_latency_msdouble or nullOptional
agentic_planlist of strings or nullOptional

Errors

422
Unprocessable Entity Error
429
Too Many Requests Error