Skip to main content
POST
vector.vectors.query

Authorizations

Authorization
string
header
required

API key: sk_live_…

Headers

Idempotency-Key
string

Optional. A retry with the same key returns the stored result.

Maximum string length: 255
Pramaan-Max-Price-Micro
string

Optional. The most this request may be priced at, in micro-USD (a whole number above 0). It replaces the capability's own price ceiling for this request, lower or higher. Sources that could cost more are left out; when none is left the answer is 400 with the lowest limit that would work.

Pattern: ^[1-9]\d{0,14}$

Body

application/json
vector
number[]
required

The query embedding: finite numbers, not all zero. Its length must equal the index's dimension; use a text.embed vector from the index's space.

Required array length: 1 - 3072 elements
ref
string

The ref returned by vector.index.create.

Pattern: ^(ref_[0-9A-HJKMNP-TV-Z]{26}|rh_[A-Za-z0-9_-]{24,1024})$
index
string

Your own index name, as given to vector.index.create. Send this or ref.

Pattern: ^[a-z][a-z0-9-]{1,23}$
limit
number

How many matches to return, 1 to 1,000. Default 10. At most 100 when includeValues is true.

Required range: x >= 1
filter
object

Only vectors whose metadata passes every test here are searched. Flat AND of field tests: {field: {eq, ne, gt, gte, lt, lte, in, nin, exists}}. No and/or groups.

includeValues
boolean

Return each match's stored vector with it. Default false.

space
string

The text.embed space the query vector came from. Required when the index was created with a space, and it must match; otherwise the query is refused.

Pattern: ^sp_[0-9a-f]{12}$

Response

The result

matches
object[]
required

The nearest vectors, most similar first.