Authentication
Send an API key as a bearer token. The key must carry the vector.manage permission; a key without it is refused with 403, not 404.
This endpoint takes no organisation id. Your key already identifies the organisation it belongs to, and the response is scoped to it.
Try it
Replace anything in angle brackets with your own values, and the key placeholder with a key from your dashboard.
curl -X POST https://api.zinndigital.com/v1/vector/indexes/{indexId}/query \
-H "Authorization: Bearer zdk_live_…" \
-H "Content-Type: application/json" \
-d '{ "values": <number[]> }'Signed in? The API console in your dashboard fills in your real organisation id and your own key, and runs the request against the live API so you can see the actual response. Open this endpoint in the API console
Details
Returns the `top_k` nearest vectors, nearest first, optionally restricted to those whose metadata contains `filter`. `distance` is in the index's own metric, so smaller is always nearer whichever metric you chose. ⛔ A query **spends the plan's monthly query allowance**, which is why it requires `vector.manage` rather than `vector.view` — a read that costs money is not a read.
Parameters
| Name | Type | Required | What it is |
|---|---|---|---|
indexId (path) | string | Yes | The index's id. |
Request body
| Name | Type | Required | What it is |
|---|---|---|---|
values | number[] | Yes | The query vector — exactly `dimension` values. |
top_k | integer | No | — |
filter | object | No | Restrict the search to vectors whose metadata contains these keys and values. Containment, not equality of the whole object, so a filter naming one key matches a vector carrying… |
Response
| Name | Type | Required | What it is |
|---|---|---|---|
matches | object[] | Yes | — |
Errors this endpoint can return
401 · 403 · 404 · 422 · 429