List documents in collection

GET

Get all documents in a collection with pagination and sorting options.

This endpoint retrieves a paginated list of documents associated with a specific collection. It supports sorting options to customize the order of returned documents.

Path parameters

idstringRequired

The unique identifier of the collection

Query parameters

offsetintegerOptional

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

limitintegerOptional

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

Errors

GET

1 from r2r import R2RClient
2 
3 client = R2RClient("http://localhost:7272")
4 # when using auth, do client.login(...)
5 
6 result = client.collections.list_documents(
7     "123e4567-e89b-12d3-a456-426614174000",
8     offset=0,
9     limit=10,
10 )

1 {
2   "results": [
3     {
4       "id": "id",
5       "collection_ids": [
6         "collection_ids"
7       ],
8       "owner_id": "owner_id",
9       "document_type": "mp3",
10       "metadata": {
11         "key": "value"
12       },
13       "version": "version",
14       "title": "title",
15       "size_in_bytes": 1,
16       "ingestion_status": "pending",
17       "extraction_status": "pending",
18       "created_at": "2024-01-15T09:30:00Z",
19       "updated_at": "2024-01-15T09:30:00Z",
20       "ingestion_attempt_number": 1,
21       "summary": "summary",
22       "summary_embedding": [
23         1.1
24       ]
25     }
26   ],
27   "total_entries": 1
28 }

Built with

1	from r2r import R2RClient
2
3	client = R2RClient("http://localhost:7272")
4	# when using auth, do client.login(...)
5
6	result = client.collections.list_documents(
7	"123e4567-e89b-12d3-a456-426614174000",
8	offset=0,
9	limit=10,
10	)

1	{
2	"results": [
3	{
4	"id": "id",
5	"collection_ids": [
6	"collection_ids"
7	],
8	"owner_id": "owner_id",
9	"document_type": "mp3",
10	"metadata": {
11	"key": "value"
12	},
13	"version": "version",
14	"title": "title",
15	"size_in_bytes": 1,
16	"ingestion_status": "pending",
17	"extraction_status": "pending",
18	"created_at": "2024-01-15T09:30:00Z",
19	"updated_at": "2024-01-15T09:30:00Z",
20	"ingestion_attempt_number": 1,
21	"summary": "summary",
22	"summary_embedding": [
23	1.1
24	]
25	}
26	],
27	"total_entries": 1
28	}