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

Scroll points

POST
/collections/:collection_name/points/scroll
POST
/collections/:collection_name/points/scroll
$curl -X POST http://localhost:6333/collections/collection_name/points/scroll \
>     -H "api-key: <apiKey>" \
>     -H "Content-Type: application/json" \
>     -d '{}'
200Successful
1{
2  "time": 1.1,
3  "status": "string",
4  "result": {
5    "points": [
6      {
7        "id": 1,
8        "payload": {},
9        "vector": {},
10        "shard_key": "string"
11      }
12    ],
13    "next_page_offset": 1
14  }
15}

Returns all points in a page-by-page manner. By default, all resulting points are sorted by {id}. To query the next page specify the last {id} in the offset field. Additionally, you can specify filters and sorting options.

Was this page helpful?
Previous

Count 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

Pagination and filter parameters
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

offsetuint64 or string or anyOptional
Start ID to read points from.
limitinteger or nullOptional>=1

Page size. Default: 10

filterobject or anyOptional

Look only for points which satisfies this conditions. If not provided - all points.

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
order_bystring or object or anyOptional
Order the records by a payload field.

Response

successful operation
timedouble
Time spent to process this request
statusstring
resultobject
Result of the points read request