Points

Retrieve points

POST
Retrieves all details from multiple points.

Path parameters

collection_namestringRequired
Name of the collection to retrieve from

Query parameters

consistencyunionOptional
Define read consistency guarantees for the operation

Request

This endpoint expects an object.
ids
list of unionsRequired
Look for points with ids
shard_key
unionOptional
Specify in which shards to look for the points, if not specified - look in all shards
with_payload
unionOptional
Select which payload to return with the response. Default is true.
with_vector
unionOptional
Options for specifying which vector to include

Response

This endpoint returns an object
time
doubleOptional
Time spent to process this request
status
stringOptional
result
list of objectsOptional
Point data
POST
1curl -X POST http://localhost:6333/collections/collection_name/points \
2 -H "api-key: <apiKey>" \
3 -H "Content-Type: application/json" \
4 -d '{
5 "ids": [
6 1
7 ]
8}'
200Successful
1{
2 "time": 1.1,
3 "status": "status",
4 "result": [
5 {
6 "id": 1,
7 "vector": [
8 1.1
9 ],
10 "shard_key": "shard_key",
11 "order_value": 1
12 }
13 ]
14}