For AI agents: a documentation index is available at the root level at /llms.txt and /llms-full.txt. Append /llms.txt to any URL for a page-level index, or .md for the markdown version of any page.
CloudGitHub
  • API Reference
      • POSTSearch points
      • POSTSearch batch points
      • POSTSearch point groups
      • POSTRecommend points
      • POSTRecommend batch points
      • POSTRecommend point groups
      • POSTDiscover points
      • POSTDiscover batch points
      • POSTQuery points
      • POSTQuery points in batch
      • POSTQuery point groups
      • POSTDistance matrix pairs
      • POSTDistance matrix offsets
LogoLogo
CloudGitHub
API ReferenceSearch

Query points in batch

POST
/collections/:collection_name/points/query/batch
POST
/collections/:collection_name/points/query/batch
$curl -X POST \
> 'http://localhost:6333/collections/collection_name/points/query/batch' \
> --header 'api-key: <api-key-value>' \
> --header 'Content-Type: application/json' \
> --data-raw '{
> "searches": [
> {
> "query": [
> 0.23,
> 0.325,
> 0.623
> ],
> "limit": 1
> },
> {
> "query": [
> 0.423,
> 0.23,
> 0.623
> ],
> "limit": 5,
> "using": "image-vector"
> }
> ]
>}'
200Successful
1{
2 "usage": {
3 "cpu": 1,
4 "payload_io_read": 1,
5 "payload_io_write": 1,
6 "payload_index_io_read": 1,
7 "payload_index_io_write": 1,
8 "vector_io_read": 1,
9 "vector_io_write": 1
10 },
11 "time": 0.002,
12 "status": "ok",
13 "result": [
14 {
15 "points": [
16 {
17 "id": 42,
18 "version": 3,
19 "score": 0.75,
20 "payload": {},
21 "vector": {},
22 "shard_key": "region_1",
23 "order_value": 42
24 }
25 ]
26 }
27 ]
28}

Universally query points in batch. This endpoint covers all capabilities of search, recommend, discover, filters. But also enables hybrid and multi-stage queries.

Was this page helpful?
Previous

Query point groups

Next
Built with

Authentication

api-keystring
API Key authentication via header

Path parameters

collection_namestringRequired
Name of the collection to query

Query parameters

consistencyinteger or enumOptional
Define read consistency guarantees for the operation
timeoutintegerOptional>=1
If set, overrides global timeout for this request. Unit is seconds.

Request

Describes the queries to make to the collection
searcheslist of objectsRequired

Response

successful operation
usageobject or any
timedouble
Time spent to process this request
statusstring
resultlist of objects