---
title: "Get points"
method: POST
path: "/collections/{collection_name}/points"
tags: ["points"]
---

# Get points

`POST /collections/{collection_name}/points`

Retrieve multiple points by specified IDs

## Path parameters

- `collection_name` string, required

## Query parameters

- `consistency` union — Read consistency parameter Defines how many replicas should be queried to get the result * `N` - send N random request and return points, which present on all of them * `majority` - send N/2+1 random request and return points, which present on all of them * `quorum` - send requests to all nodes and return points which present on majority of them * `all` - send requests to all nodes and return points which present on all of them Default value is `Factor(1)`
  - integer
  - 'majority' | 'quorum' | 'all' — * `majority` - send N/2+1 random request and return points, which present on all of them * `quorum` - send requests to all nodes and return points which present on majority of nodes * `all` - send requests to all nodes and return points which present on all nodes
- `timeout` integer

## Request body

- PointRequest
  - `shard_key` union — Specify in which shards to look for the points, if not specified - look in all shards
    - union
      - union
        - string
        - integer
      - ShardKey[]
        - union
          - string
          - integer
    - unknown
  - `ids` ExtendedPointId[], required — Look for points with ids
    - union — Type, used for specifying point ID in user interface
      - integer
      - string, uuid
  - `with_payload` union — Select which payload to return with the response. Default is true.
    - union — Options for specifying which payload to include or not
      - boolean — If `true` - return all payload, If `false` - do not return payload
      - string[] — Specify which fields to return
      - union — Specifies how to treat payload selector
        - PayloadSelectorInclude
          - `include` string[], required — Only include this payload keys
        - PayloadSelectorExclude
          - `exclude` string[], required — Exclude this fields from returning payload
    - unknown
  - `with_vector` union — Options for specifying which vector to include
    - boolean — If `true` - return all vector, If `false` - do not return vector
    - string[] — Specify which vector to return

## Response `200`

successful operation

- object
  - `time` number, float — Time spent to process this request
  - `status` string
  - `result` Record[]
    - `id` union, required — Type, used for specifying point ID in user interface
      - integer
      - string, uuid
    - `payload` union — Payload - values assigned to the point
      - Payload
      - unknown
    - `vector` union — Vector of the point
      - union — Full vector data per point separator with single and multiple vector modes
        - number[]
        - array[]
          - number[]
        - object
        - Document — WARN: Work-in-progress, unimplemented Text document for embedding. Requires inference infrastructure, unimplemented.
          - `text` string, required — Text of the document This field will be used as input for the embedding model
          - `model` string, nullable — Name of the model used to generate the vector List of available models depends on a provider
      - unknown
    - `shard_key` union — Shard Key
      - union
        - string
        - integer
      - unknown
    - `order_value` union
      - union
        - integer
        - number, double
      - unknown

## Other responses

- `default` — error
- `4XX` — error

## Changes

- **2024-09-09** `99f8ca65a207` — 2 info
  - added `#/components/schemas/Document` to the `result/items/vector/anyOf[#/components/schemas/VectorStruct]/` response property `anyOf` list for the response status `200`
  - added `#/components/schemas/Document` to the `result/items/vector/anyOf[#/components/schemas/VectorStruct]/anyOf[subschema #3]/additionalProperties/` response property `anyOf` list for the response status `200`
- **2024-08-13** `d530ad1be7de` — 3 breaking, 12 info
  - removed `subschema #1, subschema #2` from the `ids/items/` request property `anyOf` list
  - removed `subschema #1, subschema #2` from the `shard_key/anyOf[#/components/schemas/ShardKeySelector]/anyOf[#/components/schemas/ShardKey]/` request property `anyOf` list
  - removed `subschema #1, subschema #2` from the `shard_key/anyOf[#/components/schemas/ShardKeySelector]/anyOf[subschema #2]/items/` request property `anyOf` list
  - added the new optional `query` request parameter `timeout`
  - …11 more
- **2024-07-01** `e1a916176c14` — 2 info
  - added the optional property `result/items/order_value` to the response with the `200` status
  - added `subschema #2` to the `result/items/vector/anyOf[#/components/schemas/VectorStruct]/` response property `anyOf` list for the response status `200`

[Change history](https://skmtc.dev/qdrant/apis/qdrant-api/changes/collections/:collection_name/points/post.md)

---

[API](https://skmtc.dev/qdrant/apis/qdrant-api.md) · [All operations](https://skmtc.dev/qdrant/apis/qdrant-api/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/qdrant/qdrant-api/revisions/99f8ca65a207/schema)
