List Chunks

List chunks with pagination support.

Returns a paginated list of chunks that the user has access to. Results can be filtered and sorted based on various parameters. Vector embeddings are only included if specifically requested.

Regular users can only list chunks they own or have access to through collections. Superusers can list all chunks in the system.

Query parameters

metadata_filterstringOptional

Filter by metadata

include_vectorsbooleanOptionalDefaults to false

Include vector data in response

offsetintegerOptional>=0Defaults to 0

Specifies the number of objects to skip. Defaults to 0.

limitintegerOptional>=1<=1000Defaults to 100

Specifies a limit on the number of objects to return, ranging between 1 and 100. Defaults to 100.

Response

Successful Response

resultslist of objects

total_entriesinteger

1	from r2r import R2RClient
2
3	client = R2RClient()
4	response = client.chunks.list(
5	metadata_filter={"key": "value"},
6	include_vectors=False,
7	offset=0,
8	limit=10,
9	)

1	{
2	"results": [
3	{
4	"id": "id",
5	"document_id": "document_id",
6	"owner_id": "owner_id",
7	"collection_ids": [
8	"collection_ids"
9	],
10	"text": "text",
11	"metadata": {
12	"key": "value"
13	},
14	"vector": [
15	1.1
16	]
17	}
18	],
19	"total_entries": 1
20	}

Headers

Query parameters

Response

Errors