buzz.bookhive.getPersonalBookFile

Download the raw ebook file for a book in the authenticated user's personal library. Responds with the stored bytes, a strong ETag equal to the content hash, and a `Content-Disposition: attachment` filename. Honours `If-None-Match` with a 304, so an e-reader syncing on a schedule does not re-download every book. The XRPC equivalent of GET /opds/books/{hash}/download/{name}.ext.

Repository @bookhive.buzz did:plc:enu2j5xjlqsjaylv3du4myh4 namespace authority
Details · query
Kindquery
Authoritybookhive.buzz
Commit rev3n2mntoox522e
Indexed
cid bafyreihktkv337kyi4yyla5uupbs4eswqkpjq4ftex3hjaydtrs5xlylxm

Checks

Valid
  • unlimited-string defs.main.parameters.properties.contentHashNo maxLength, maxGraphemes or format limits this string.
JSONDownload
{
  "$type": "com.atproto.lexicon.schema",
  "defs": {
    "main": {
      "description": "Download the raw ebook file for a book in the authenticated user's personal library. Responds with the stored bytes, a strong ETag equal to the content hash, and a `Content-Disposition: attachment` filename. Honours `If-None-Match` with a 304, so an e-reader syncing on a schedule does not re-download every book. The XRPC equivalent of GET /opds/books/{hash}/download/{name}.ext.",
      "errors": [
        {
          "description": "No such book in the caller's library, or its file is missing from disk",
          "name": "NotFound"
        }
      ],
      "output": {
        "encoding": "application/epub+zip,application/x-mobipocket-ebook,application/x-fictionbook+xml,application/vnd.comicbook+zip,application/octet-stream"
      },
      "parameters": {
        "properties": {
          "contentHash": {
            "description": "Content hash identifying the book, as returned by getPersonalLibrary",
            "type": "string"
          }
        },
        "required": [
          "contentHash"
        ],
        "type": "params"
      },
      "type": "query"
    }
  },
  "id": "buzz.bookhive.getPersonalBookFile",
  "lexicon": 1
}