Skip to main content

Collections

Collections are the storage spaces for organizing your documents in the vector store. Each collection is associated with a specific embedding model and contains documents that are processed into searchable chunks.

Collection Properties​

  • name: Collection name (required)
  • description: Collection description (optional)
  • visibility: Collection visibility - private or public (default: private)
    • Private: Only accessible by the owner
    • Public: Accessible by all users for reading

Public Collections​

Public collections allow you to share documents with all users in your OpenGateLLM instance. When a collection is marked as public:

  • The owner can read, write, update, and delete the collection and its documents
  • Other users can only read the collection and search within it
  • Other users cannot modify or delete public collections they don't own
info

Creating public collections requires the create_public_collection permission. For more information about permissions, see Roles and Permissions documentation.

Managing Collections​

curl -X POST http://localhost:8000/v1/collections \
  -H "Authorization: Bearer <api_key>" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "My Collection",
    "description": "A collection for my documents",
    "visibility": "private"
  }'

Next Steps​