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
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 \
>     -H "api-key: <apiKey>" \
>     -H "Content-Type: application/json" \
>     -d '{
>  "ids": [
>    1
>  ]
>}'
200Successful
1{
2  "time": 1.1,
3  "status": "string",
4  "result": [
5    {
6      "id": 1,
7      "payload": {},
8      "vector": {},
9      "shard_key": "string",
10      "order_value": 1
11    }
12  ]
13}
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

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

Response

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