Search point groups (API Explorer) | Qdrant

Collections
- GETGet collection details
- PUTCreate a collection
- DELDelete a collection
- PATCHUpdate collection parameters
- GETList all collections
- GETCheck collection existence
Points
- POSTRetrieve points
- PUTUpsert points
- GETRetrieve a point
- POSTDelete points
- PUTUpdate vectors
- POSTDelete vectors
- POSTSet payload
- PUTOverwrite payload
- POSTDelete payload
- POSTClear payload
- POSTBatch update points
- POSTScroll points
- POSTCount points
- POSTPayload field facets
Search
- 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
Indexes
- PUTCreate payload index
- DELDelete payload index
Snapshots
- GETList all snapshots (collection)
- POSTCreate a snapshot (collection)
- POSTRecover from an uploaded snapshot (collection)
- PUTRecover from a snapshot (collection)
- GETDownload a snapshot (collection)
- DELDelete a snapshot (collection)
- GETList all snapshots (storage)
- POSTCreate a snapshot (storage)
- GETDownload a snapshot (storage)
- DELDelete a snapshot (storage)
- POSTRecover from an uploaded snapshot (shard)
- PUTRecover from a snapshot (shard)
- GETList all snapshots (shard)
- POSTCreate a snapshot (shard)
- GETDownload a snapshot (shard)
- DELDelete a snapshot (shard)
Aliases
- POSTUpdate collection aliases
- GETList collection aliases
- GETList all aliases
Distributed
- GETCheck cluster status
- PUTCreate a shard key
- POSTDelete a shard key
- POSTRecover cluster state
- DELRemove peer from cluster
- GETRetrieve cluster details
- POSTUpdate cluster setup
Service
- GETCollect telemetry data
- GETRetrieve instance details
- GETCollect Prometheus metrics data
- GETCheck write protection
- POSTSet write protection
- GETKubernetes health check
- GETKubernetes liveness probe
- GETKubernetes readiness probe
Beta
- GETReport issues
- DELClear issues
Collections
- GETGet collection details
- PUTCreate a collection
- DELDelete a collection
- PATCHUpdate collection parameters
- GETList all collections
- GETCheck collection existence
Points
- POSTRetrieve points
- PUTUpsert points
- GETRetrieve a point
- POSTDelete points
- PUTUpdate vectors
- POSTDelete vectors
- POSTSet payload
- PUTOverwrite payload
- POSTDelete payload
- POSTClear payload
- POSTBatch update points
- POSTScroll points
- POSTCount points
- POSTPayload field facets
Search
- 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
Indexes
- PUTCreate payload index
- DELDelete payload index
Snapshots
- GETList all snapshots (collection)
- POSTCreate a snapshot (collection)
- POSTRecover from an uploaded snapshot (collection)
- PUTRecover from a snapshot (collection)
- GETDownload a snapshot (collection)
- DELDelete a snapshot (collection)
- GETList all snapshots (storage)
- POSTCreate a snapshot (storage)
- GETDownload a snapshot (storage)
- DELDelete a snapshot (storage)
- POSTRecover from an uploaded snapshot (shard)
- PUTRecover from a snapshot (shard)
- GETList all snapshots (shard)
- POSTCreate a snapshot (shard)
- GETDownload a snapshot (shard)
- DELDelete a snapshot (shard)
Aliases
- POSTUpdate collection aliases
- GETList collection aliases
- GETList all aliases
Distributed
- GETCheck cluster status
- PUTCreate a shard key
- POSTDelete a shard key
- POSTRecover cluster state
- DELRemove peer from cluster
- GETRetrieve cluster details
- POSTUpdate cluster setup
Service
- GETCollect telemetry data
- GETRetrieve instance details
- GETCollect Prometheus metrics data
- GETCheck write protection
- POSTSet write protection
- GETKubernetes health check
- GETKubernetes liveness probe
- GETKubernetes readiness probe
Beta
- GETReport issues
- DELClear issues
Collections
- GETGet collection details
- PUTCreate a collection
- DELDelete a collection
- PATCHUpdate collection parameters
- GETList all collections
- GETCheck collection existence
Points
- POSTRetrieve points
- PUTUpsert points
- GETRetrieve a point
- POSTDelete points
- PUTUpdate vectors
- POSTDelete vectors
- POSTSet payload
- PUTOverwrite payload
- POSTDelete payload
- POSTClear payload
- POSTBatch update points
- POSTScroll points
- POSTCount points
Search
- 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
Indexes
- PUTCreate payload index
- DELDelete payload index
Snapshots
- GETList all snapshots (collection)
- POSTCreate a snapshot (collection)
- POSTRecover from an uploaded snapshot (collection)
- PUTRecover from a snapshot (collection)
- GETDownload a snapshot (collection)
- DELDelete a snapshot (collection)
- GETList all snapshots (storage)
- POSTCreate a snapshot (storage)
- GETDownload a snapshot (storage)
- DELDelete a snapshot (storage)
- POSTRecover from an uploaded snapshot (shard)
- PUTRecover from a snapshot (shard)
- GETList all snapshots (shard)
- POSTCreate a snapshot (shard)
- GETDownload a snapshot (shard)
- DELDelete a snapshot (shard)
Aliases
- POSTUpdate collection aliases
- GETList collection aliases
- GETList all aliases
Distributed
- GETCheck cluster status
- PUTCreate a shard key
- POSTDelete a shard key
- POSTRecover cluster state
- DELRemove peer from cluster
- GETRetrieve cluster details
- POSTUpdate cluster setup
Service
- GETCollect telemetry data
- GETRetrieve instance details
- GETCollect Prometheus metrics data
- GETCheck write protection
- POSTSet write protection
- GETKubernetes health check
- GETKubernetes liveness probe
- GETKubernetes readiness probe
Beta
- GETReport issues
- DELClear issues
Collections
- GETGet collection details
- PUTCreate a collection
- DELDelete a collection
- PATCHUpdate collection parameters
- GETList all collections
- GETCheck collection existence
Points
- POSTRetrieve points
- PUTUpsert points
- GETRetrieve a point
- POSTDelete points
- PUTUpdate vectors
- POSTDelete vectors
- POSTSet payload
- PUTOverwrite payload
- POSTDelete payload
- POSTClear payload
- POSTBatch update points
- POSTScroll points
- POSTCount points
Search
- 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
Indexes
- PUTCreate payload index
- DELDelete payload index
Snapshots
- GETList all snapshots (collection)
- POSTCreate a snapshot (collection)
- POSTRecover from an uploaded snapshot (collection)
- PUTRecover from a snapshot (collection)
- GETDownload a snapshot (collection)
- DELDelete a snapshot (collection)
- GETList all snapshots (storage)
- POSTCreate a snapshot (storage)
- GETDownload a snapshot (storage)
- DELDelete a snapshot (storage)
- POSTRecover from an uploaded snapshot (shard)
- PUTRecover from a snapshot (shard)
- GETList all snapshots (shard)
- POSTCreate a snapshot (shard)
- GETDownload a snapshot (shard)
- DELDelete a snapshot (shard)
Aliases
- POSTUpdate collection aliases
- GETList collection aliases
- GETList all aliases
Distributed
- GETCheck cluster status
- PUTCreate a shard key
- POSTDelete a shard key
- POSTRecover cluster state
- DELRemove peer from cluster
- GETRetrieve cluster details
- POSTUpdate cluster setup
Service
- GETCollect telemetry data
- GETRetrieve instance details
- GETCollect Prometheus metrics data
- GETCheck write protection
- POSTSet write protection
- GETKubernetes health check
- GETKubernetes liveness probe
- GETKubernetes readiness probe
Beta
- GETReport issues
- DELClear issues
Collections
- GETGet collection details
- PUTCreate a collection
- DELDelete a collection
- PATCHUpdate collection parameters
- GETList all collections
- GETCheck collection existence
Points
- POSTRetrieve points
- PUTUpsert points
- GETRetrieve a point
- POSTDelete points
- PUTUpdate vectors
- POSTDelete vectors
- POSTSet payload
- PUTOverwrite payload
- POSTDelete payload
- POSTClear payload
- POSTBatch update points
- POSTScroll points
- POSTCount points
Search
- POSTSearch points
- POSTSearch batch points
- POSTSearch point groups
- POSTRecommend points
- POSTRecommend batch points
- POSTRecommend point groups
- POSTDiscover points
- POSTDiscover batch points
Indexes
- PUTCreate payload index
- DELDelete payload index
Snapshots
- GETList all snapshots (collection)
- POSTCreate a snapshot (collection)
- POSTRecover from an uploaded snapshot (collection)
- PUTRecover from a snapshot (collection)
- GETDownload a snapshot (collection)
- DELDelete a snapshot (collection)
- GETList all snapshots (storage)
- POSTCreate a snapshot (storage)
- GETDownload a snapshot (storage)
- DELDelete a snapshot (storage)
- POSTRecover from an uploaded snapshot (shard)
- PUTRecover from a snapshot (shard)
- GETList all snapshots (shard)
- POSTCreate a snapshot (shard)
- GETDownload a snapshot (shard)
- DELDelete a snapshot (shard)
Aliases
- POSTUpdate collection aliases
- GETList collection aliases
- GETList all aliases
Distributed
- GETCheck cluster status
- PUTCreate a shard key
- POSTDelete a shard key
- POSTRecover cluster state
- DELRemove peer from cluster
- GETRetrieve cluster details
- POSTUpdate cluster setup
Service
- GETCollect telemetry data
- GETRetrieve instance details
- GETCollect Prometheus metrics data
- GETCheck write protection
- POSTSet write protection
- GETKubernetes health check
- GETKubernetes liveness probe
- GETKubernetes readiness probe
Collections
- GETGet collection details
- PUTCreate a collection
- DELDelete a collection
- PATCHUpdate collection parameters
- GETList all collections
- GETCheck collection existence
Points
- POSTRetrieve points
- PUTUpsert points
- GETRetrieve a point
- POSTDelete points
- PUTUpdate vectors
- POSTDelete vectors
- POSTSet payload
- PUTOverwrite payload
- POSTDelete payload
- POSTClear payload
- POSTBatch update points
- POSTScroll points
- POSTCount points
- POSTPayload field facets
Search
- 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
Indexes
- PUTCreate payload index
- DELDelete payload index
Snapshots
- GETList all snapshots (collection)
- POSTCreate a snapshot (collection)
- POSTRecover from an uploaded snapshot (collection)
- PUTRecover from a snapshot (collection)
- GETDownload a snapshot (collection)
- DELDelete a snapshot (collection)
- GETList all snapshots (storage)
- POSTCreate a snapshot (storage)
- GETDownload a snapshot (storage)
- DELDelete a snapshot (storage)
- POSTRecover from an uploaded snapshot (shard)
- PUTRecover from a snapshot (shard)
- GETList all snapshots (shard)
- POSTCreate a snapshot (shard)
- GETDownload a snapshot (shard)
- DELDelete a snapshot (shard)
Aliases
- POSTUpdate collection aliases
- GETList collection aliases
- GETList all aliases
Distributed
- GETCheck cluster status
- PUTCreate a shard key
- POSTDelete a shard key
- POSTRecover cluster state
- DELRemove peer from cluster
- GETRetrieve cluster details
- POSTUpdate cluster setup
Service
- GETCollect telemetry data
- GETRetrieve instance details
- GETCollect Prometheus metrics data
- GETCheck write protection
- POSTSet write protection
- GETKubernetes health check
- GETKubernetes liveness probe
- GETKubernetes readiness probe
Beta
- GETReport issues
- DELClear issues

Built with

POSThttp://localhost:6333/collections/collection_name/points/search/groups

Path Parameters

collection_namestringRequired

Query Parameters

Body Parameters

vectorlist of doubles or objectRequired
1
group_bystringRequired=1 character
group_sizeintegerRequired>=1
limitintegerRequired>=1

View in API Reference

Request

$ curl -X POST http://localhost:6333/collections/collection_name/points/search/groups \
>      -H "api-key: " \
>      -H "Content-Type: application/json" \
>      -d '{
>   "vector": [
>     1.1
>   ],
>   "group_by": "group_by",
>   "group_size": 1,
>   "limit": 1
> }'

Response

$	curl -X POST http://localhost:6333/collections/collection_name/points/search/groups \
>	-H "api-key: " \
>	-H "Content-Type: application/json" \
>	-d '{
>	"vector": [
>	1.1
>	],
>	"group_by": "group_by",
>	"group_size": 1,
>	"limit": 1
>	}'