Collections

A Collection in R2R is a logical grouping mechanism that enables organization and access control for documents and their associated chunks. Collections serve as a fundamental unit for managing permissions, sharing content, and organizing related documents across users and teams.

Collections in R2R provide:

  • Organizational structure for documents
  • Access control and permissions management
  • Group-based content sharing
  • Document categorization and management
  • User collaboration capabilities

Available Endpoints

MethodEndpointDescription
POST/collectionsCreate a new collection
GET/collectionsList collections with pagination and filtering
GET/collections/{id}Get details of a specific collection
POST/collections/{id}Update an existing collection
DELETE/collections/{id}Delete an existing collection
GET/collections/{id}/documentsList documents in a collection
POST/collections/{id}/documents/{document_id}Add a document to a collection
POST/collections/{id}/extractExtracts entities and relationships for all unextracted documents in the collection
DELETE/collections/{id}/documents/{document_id}Remove a document from a collection
GET/collections/{id}/usersList users with access to a collection
POST/collections/{id}/users/{user_id}Add a user to a collection
DELETE/collections/{id}/users/{user_id}Remove a user from a collection
Was this page helpful?
Built with