Lore DB | Docs

REST API Reference

All API endpoints require authentication via cookie-based session (Google OAuth). The base URL is https://loredb.dev/api.

Documents

MethodEndpointDescription
GET/api/documentsList documents (paginated)
POST/api/documentsCreate a new document
GET/api/documents/:idGet document details
PUT/api/documents/:idUpdate a document
DELETE/api/documents/:idDelete a document
GET/api/documents/:id/librariesGet libraries containing this document
GET/api/documents/:id/linksGet outgoing links and backlinks
GET/api/documents/:id/verifyMark document as verified
GET/api/documents/search?q=...Hybrid search
GET/api/documents/ask?q=...Ask AI (RAG)
GET/api/documents/graphKnowledge graph (all nodes and edges)

Search parameters

Both /search and /ask accept optional query parameters:

  • q — The search query (required)
  • library_id — Scope to a specific library
  • system_id — Scope to a specific system

Libraries

MethodEndpointDescription
GET/api/librariesList user’s libraries
POST/api/librariesCreate a new library
GET/api/libraries/:idGet library details
PUT/api/libraries/:idUpdate library name/description
DELETE/api/libraries/:idDelete library
GET/api/libraries/:id/documentsList documents in library
POST/api/libraries/:id/documentsAdd document to library
DELETE/api/libraries/:id/documents/:docIdRemove document from library
GET/api/libraries/:id/membersList library members
POST/api/libraries/:id/membersAdd member with role
DELETE/api/libraries/:id/members/:emailRemove member
PUT/api/libraries/:id/activeToggle active/inactive
POST/api/libraries/:id/leaveLeave library
GET/api/libraries/:id/inviteGet/regenerate invite token
GET/api/libraries/join/:tokenResolve invite
POST/api/libraries/join/:tokenJoin via invite
GET/api/libraries/:id/exportExport as JSON
POST/api/libraries/importImport from JSON

Systems

MethodEndpointDescription
GET/api/systemsList user’s systems
POST/api/systemsCreate a new system
GET/api/systems/:idGet system details
PUT/api/systems/:idUpdate system
DELETE/api/systems/:idDelete system
GET/api/systems/:id/librariesList system’s libraries
POST/api/systems/:id/librariesAdd library to system
DELETE/api/systems/:id/libraries/:libIdRemove library from system
GET/api/systems/:id/membersList system members
POST/api/systems/:id/membersAdd member with role
DELETE/api/systems/:id/members/:emailRemove member
PUT/api/systems/:id/activeToggle active/inactive
POST/api/systems/:id/leaveLeave system
GET/api/systems/:id/inviteGet/regenerate invite token
GET/api/systems/join/:tokenResolve invite
POST/api/systems/join/:tokenJoin via invite

User & Settings

MethodEndpointDescription
GET/api/modelsList enabled chat models
GET/api/preferencesGet user preferences
PUT/api/preferencesUpdate chat model preference
DELETE/api/preferences/api-keyRemove stored API key
GET/api/usageUsage summary
GET/api/usage/timeseriesUsage over time
GET/api/planCurrent plan
GET/api/creditsCredit balance
GET/api/sessionsActive sessions
DELETE/api/sessions/:idRevoke session

Billing

MethodEndpointDescription
GET/api/billing/plansAvailable paid plans
POST/api/billing/checkoutCreate Stripe checkout session
POST/api/billing/fulfillComplete checkout
POST/api/stripe/webhookStripe webhook handler

Admin endpoints (/api/admin/*) require admin privileges. See the Access Control reference for details.

For programmatic access, consider using MCP tools instead of the REST API. MCP handles authentication automatically and provides a higher-level interface.