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
      • 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
LogoLogo
CloudGitHub
API ReferencePoints

Retrieve points

POST
/collections/:collection_name/points
POST
/collections/:collection_name/points
$curl  -X POST \
>  'http://localhost:6333/collections/collection_name/points' \
>  --header 'api-key: <api-key-value>' \
>  --header 'Content-Type: application/json' \
>  --data-raw '{
>  "ids": [
>    0,
>    3,
>    100
>  ]
>}'
200Successful
1{
2  "usage": {
3    "hardware": {
4      "cpu": 1,
5      "payload_io_read": 1,
6      "payload_io_write": 1,
7      "payload_index_io_read": 1,
8      "payload_index_io_write": 1,
9      "vector_io_read": 1,
10      "vector_io_write": 1
11    },
12    "inference": {
13      "models": {}
14    }
15  },
16  "time": 0.002,
17  "status": "ok",
18  "result": [
19    {
20      "id": 42,
21      "payload": {},
22      "vector": {},
23      "shard_key": "region_1",
24      "order_value": 42
25    }
26  ]
27}
Retrieves all details from multiple points.
Was this page helpful?
Previous

Upsert points

Next
Built with

Authentication

api-keystring
API Key authentication via header

Path parameters

collection_namestringRequired
Name of the collection to retrieve from

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

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 object 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 is true.
with_vectorboolean or list of stringsOptional
Options for specifying which vector to include

Response

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