Skip to main content

Reader

Endpoints for reader sessions, configuration, reading position persistence, text search, and content download. All endpoints use single-tenant mode and require the X-Farfalla-Tenant-Id header.

Endpoints

MethodEndpointDescription
POST/api/v2/reader/{issue_id}/sessionsCreate a reader session
GET/api/v2/reader/settings/{issue_id}Get reader settings
PUT/api/v2/reader/settingsUpdate reader settings
PUT/api/v2/reader/{issue_id}/last-locationSave last reading position
GET/api/v2/content/{issue_id}/downloadDownload content for offline
GET/api/v2/reader/issue-text-contentSearch text within issue
  • Notes - Highlights and annotations within the reader
  • Integrations - AI, translate, dictionary, text-to-speech
  • Library - Browse and discover content
  • Search - Find specific content
  • User - Continue reading across tenants
X

Graph View