Reader Settings

Get Reader Settings

GET /api/v2/reader/settings/{issue_id}

Returns the complete reader configuration needed to initialize Volpe (the reader engine) for a specific issue.

Request:

curl "https://app.publica.la/api/v2/reader/settings/440317" \
  -H "Authorization: Bearer {access_token}" \
  -H "X-Farfalla-Tenant-Id: 42" \
  -H "Accept: application/json"

Optional Headers:

Header	Description
reader-token	Previously assigned reader session token (for downloaded content)

Optional Query Parameters:

Parameter	Type	Description
location	string	Current reading location
lang	string	User language preference

Response: 200 OK

{
  "token": "reader-session-token",
  "coniglio_track_token": "analytics-token",
  "features": {
    "tts": false,
    "search": false,
    "concurrency_limit": false,
    "chinese_voice": false
  },
  "settings": {
    "tenant": {
      "lang": "es",
      "reader_token_session_url": "https://planeta.publica.la/api/v1/reader/session",
      "exit_url": "https://planeta.publica.la/library",
      "reader": {
        "pdf": { "layout": "single" },
        "tts": false,
        "theme": "light",
        "elefante": [],
        "customStyles": null
      },
      "preview": true
    },
    "user": {
      "pdf": { "layout": null },
      "epub": { "zoom": null, "layout": null },
      "theme": "light"
    }
  },
  "issue": {
    "name": "Book Title",
    "description": "Book description...",
    "file_type": "epub",
    "tags": {
      "author": ["Author Name"],
      "keyword": ["Fiction", "History"],
      "edition": ["First Edition"]
    },
    "issue_url": "https://planeta.publica.la/reader/book-slug",
    "issue_full_url": "https://planeta.publica.la/api/v2/reader/settings/440317",
    "issue_tenant_id": 42,
    "publication_date": "2024",
    "user": {
      "issue_is_favorite": false,
      "last_location": { "page": 4 }
    },
    "twitter_user": "planeta"
  },
  "volpe_url": "https://volpe.publica.la",
  "volpe_url_proxied": "https://volpe.publica.la"
}

---

Update Reader Settings

PUT /api/v2/reader/settings

Saves the user's reader preferences (theme, layout, zoom). These settings apply across all issues.

Request:

curl -X PUT https://app.publica.la/api/v2/reader/settings \
  -H "Authorization: Bearer {access_token}" \
  -H "X-Farfalla-Tenant-Id: 42" \
  -H "Content-Type: application/json" \
  -H "Accept: application/json" \
  -d '{
    "userReaderSettings": {
      "theme": "dark",
      "epub": {
        "zoom": 140,
        "layout": "scroll"
      },
      "pdf": {
        "layout": "single"
      }
    }
  }'

Field	Type	Description
userReaderSettings.theme	string, nullable	light, dark, auto, etc.
userReaderSettings.epub.zoom	integer, nullable	Zoom level for EPUB
userReaderSettings.epub.layout	string, nullable	EPUB layout mode
userReaderSettings.pdf.layout	string, nullable	single, double, continuous

Response: 200 OK

{
  "user_reader_settings": {
    "theme": "dark",
    "epub": { "zoom": 140, "layout": "scroll" },
    "pdf": { "layout": "single" }
  }
}