LogoLogo
CloudGitHub
  • API Reference
CloudGitHub
API ReferencePoints

Retrieve points

POST
/collections/:collection_name/points
POST
/collections/:collection_name/points
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}'
Try it
200Successful
1{
2  "time": 1.1,
3  "status": "string",
4  "result": [
5    {
6      "id": 1,
7      "payload": {},
8      "vector": {},
9      "shard_key": "string"
10    }
11  ]
12}
Retrieves all details from multiple points.

Path parameters

collection_namestringRequired
Name of the collection to retrieve from

Headers

api-keystringRequired

Query parameters

consistencyinteger or enumOptional
Define read consistency guarantees for the operation

Request

List of points to retrieve
idslist of uint64s or stringsRequired
Look for points with ids
shard_keystring or uint64 or list of strings or uint64s or anyOptional
Specify in which shards to look for the points, if not specified - look in all shards
with_payloadboolean or list of strings or object or anyOptional
Select which payload to return with the response. Default: All
with_vectorboolean or list of stringsOptional
Options for specifying which vector to include

Response

successful operation
timedouble or null
Time spent to process this request
statusstring or null
resultlist of objects or null
Was this page helpful?
Previous

Upsert points

Next
Built with
Name of the collection to retrieve from
Define read consistency guarantees for the operation
List of points to retrieve
successful operation

Specify in which shards to look for the points, if not specified - look in all shards

Select which payload to return with the response. Default: All