Retrieve points

POST

http://localhost:6333/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
  ]
}'

{
  "usage": {
    "hardware": {
      "cpu": 1,
      "payload_index_io_read": 1,
      "payload_index_io_write": 1,
      "payload_io_read": 1,
      "payload_io_write": 1,
      "vector_io_read": 1,
      "vector_io_write": 1
    },
    "inference": {
      "models": {}
    }
  },
  "time": 0.002,
  "status": "ok",
  "result": [
    {
      "id": 42,
      "payload": {
        "city": "London",
        "color": "green"
      },
      "vector": [
        0.875,
        0.140625,
        0.897599995136261
      ],
      "shard_key": "region_1",
      "order_value": 42
    }
  ]
}

Retrieves all details from multiple points.

Authentication

api-keystring

Authorization key, either read-write or read-only

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

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 anyOptional

timefloatOptional

Time spent to process this request

statusstringOptional

resultlist of objectsOptional

Errors

4XX

Client Request Error