v3

latestOpenAPI 3.0.3raw.githubusercontent.com2026-04-274135.4 KB

Search vectors

Find the most similar vectors in a collection using approximate nearest neighbor search. Supports score thresholds, payload filtering, and tunable HNSW parameters.

post/collections/{collection_name}/points/search

Path parameters

collection_namestring required

The name of the collection to search.

Request body

vectornumber[] required

The query vector to search for. The number of dimensions must match the collection's configured vector size.

limitinteger

Maximum number of results to return. Defaults to 10.

offsetinteger

Number of results to skip for pagination. Use with limit to page through results.

score_thresholdnumber

Minimum similarity score for results. Only points with scores at or above this threshold are returned.

filterobject

Optional filter to narrow search results based on payload metadata. See the Filters API for syntax.

with_payloadboolean

Whether to include payload metadata in the response.

with_vectorboolean

Whether to include vector data in the response. Set to false to reduce response size.

Example request

{
  "vector": [
    0.1,
    0.2,
    0.3,
    0.4
  ],
  "limit": 5,
  "score_threshold": 0.7,
  "with_payload": true,
  "params": {
    "hnsw_ef": 128
  }
}

Response

Search results

timenumber double

Time spent to process this request, in seconds.

statusstring

Operation status.

Example response

{
  "time": 0.0000553,
  "status": "ok",
  "result": [
    {
      "score": 0.9843740463256836
    }
  ]
}

All 4 operations