Sign in

v1

latestOpenAPI 3.0.3BSL2026-07-17133415718.8 KB
Chunk

Scroll Chunks

Get paginated chunks from your dataset with filters and custom sorting. If sort by is not specified, the results will sort by the id's of the chunks in ascending order. Sort by and offset_chunk_id cannot be used together; if you want to scroll with a sort by then you need to use a must_not filter with the ids you have already seen. There is a limit of 1000 id's in a must_not filter at a time.

post/api/chunks/scroll

Headers

TR-Datasetstring uuid required

The dataset id or tracking_id to use for the request. We assume you intend to use an id if the value is a valid uuid.

Request body

offset_chunk_idstring uuid nullable

Offset chunk id is the id of the chunk to start the page from. If not specified, this defaults to the first chunk in the dataset sorted by id ascending.

page_sizeinteger nullable

Page size is the number of chunks to fetch. This can be used to fetch more than 10 chunks at a time.

Example request

{
  "filters": {
    "must": [
      {
        "field": "tag_set",
        "match_all": [
          "A",
          "B"
        ]
      },
      {
        "field": "num_value",
        "range": {
          "gte": 10,
          "lte": 25
        }
      }
    ]
  }
}

Response

Number of chunks equivalent to page_size starting from offset_chunk_id

Example response

{
  "chunks": [
    {
      "chunk_html": "<p>Hello, world!</p>",
      "created_at": "2021-01-01 00:00:00.000",
      "dataset_id": "e3e3e3e3-e3e3-e3e3-e3e3-e3e3e3e3e3e3",
      "id": "e3e3e3e3-e3e3-e3e3-e3e3-e3e3e3e3e3e3",
      "link": "https://trieve.ai",
      "metadata": {
        "key": "value"
      },
      "tag_set": "[tag1,tag2]",
      "time_stamp": "2021-01-01 00:00:00.000",
      "tracking_id": "e3e3e3e3-e3e3-e3e3-e3e3-e3e3e3e3e3e3",
      "updated_at": "2021-01-01 00:00:00.000",
      "weight": 0.5
    }
  ]
}