32-byte encryption key as a hex string. Required for indexes created with the SDK-supplied KEK path; omit for KMS-backed indexes (the service resolves the key via the stored KMSBlob).
object
required
Batch of query vectors in binary format:
Show batch parameters
string
required
Base64-encoded float32 array. The decoded bytes represent a flat array of n_queries x dimension little-endian float32 values
integer
required
Dimensionality of each query vector
integer
Number of nearest neighbors to return per query. Defaults to 100
integer
Number of clusters to probe during search. Auto-determined when not specified
boolean
Whether to use greedy search algorithm. Defaults to false
integer
default:10
Multiplier for stage 1 retrieval in reranking indexes. Stage 1 returns top_k * rerank_mult candidates before the rerank pass narrows the result down to top_k. Higher values trade query latency for recall. Ignored by indexes that do not rerank.
object
Metadata filters to apply to the search
array[string]
Fields to include in response: "distance", "metadata", "vector". Defaults to [] (only id is returned). "contents" is not a valid value — fetch contents via POST /v1/vectors/get with the matching IDs afterwards.
Response
The response format is the same as the standard query endpoint:
The binary format is more efficient than the standard JSON query for large batch queries, as it avoids the overhead of encoding each float as a JSON number. The SDK clients automatically use this format when query vectors are passed as typed arrays (e.g., np.ndarray in Python, Float32Array in JS/TS).