Skip to main content

13 docs tagged with "reader"

View all tags

Create Reader Session

Creates a reader session for the mobile app. Returns content URLs needed to render the publication, varying by format (PDF, EPUB, Audiobook). This replaces the API v1 encrypted-token flow by using JWT authentication directly.

Download Content

Returns metadata and file URLs needed to download content for offline reading. The response structure varies by content type.

Integrations

AI-powered reader features: translate, text-to-speech, dictionary, and text analysis (explain/expand/summarize). All endpoints require the reader-token header.

Integrations

AI-powered reader features: translate, text-to-speech, dictionary, and text analysis (explain/expand/summarize). All endpoints use single-tenant mode (require X-Farfalla-Tenant-Id) and require the reader-token header.

Issue Text Content Search

Searches for text within the current issue using SingleStore full-text search. Returns highlighted snippets with location information for navigating to matches. Requires the reader-token header.

Notes

Endpoints for managing user highlights and annotations within the reader. All endpoints require the reader-token header.

Notes

Endpoints for managing user highlights and annotations within the reader. All endpoints use single-tenant mode (require X-Farfalla-Tenant-Id) and require the reader-token header.

Polpo API v1 Overview

Polpo is the internal API used by the Volpe reader. It handles reader session initialization, user notes/highlights, in-reader search, and AI-powered integrations (translate, listen, dictionary, explain/expand/summarize).

Reader API v2 Overview

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.

Save Last Location

Saves the user's reading position. The payload structure varies by content type.

Search

Full-text search within the content of a publication.

Sessions

Reader session management. The POST /sessions endpoint is the entry point for the reader — it initializes the session and returns all the content URLs needed to render the publication.

X

Graph View