Kavita Book API

openapi: 3.2.0
info:
  title: Kavita Book API
  description: Kavita provides a set of APIs authenticated via an Auth Key passed in the `x-api-key` header. Generate an Auth Key under User Settings → Manage Auth Keys, paste it into the Authorize panel, and all Try It requests will include it. Assume all fields of a payload are required unless marked optional. Built against v0.9.1.15
  license:
    name: GPL-3.0
    url: https://github.com/Kareadita/Kavita/blob/develop/LICENSE
  version: 0.9.1.15
servers:
- url: '{protocol}://{hostpath}'
  variables:
    protocol:
      default: http
      enum:
      - http
      - https
    hostpath:
      default: localhost:5000
security:
- AuthKey: []
tags:
- name: Book
paths:
  /api/Book/{chapterId}/book-info:
    get:
      tags:
      - Book
      summary: Retrieves information for the PDF and Epub reader. This will cache the file
      description: This only applies to Epub or PDF files
      parameters:
      - name: chapterId
        in: path
        description: ''
        required: true
        schema:
          type: integer
          format: int32
      responses:
        '200':
          description: OK
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/BookInfoDto'
            application/json:
              schema:
                $ref: '#/components/schemas/BookInfoDto'
            text/json:
              schema:
                $ref: '#/components/schemas/BookInfoDto'
      operationId: getApiBookByChapterIdBookInfo
      x-operation-id-source: derived
  /api/Book/{chapterId}/book-resources:
    get:
      tags:
      - Book
      summary: This is an entry point to fetch resources from within an epub chapter/book
      parameters:
      - name: chapterId
        in: path
        description: ''
        required: true
        schema:
          type: integer
          format: int32
      - name: file
        in: query
        description: ''
        schema:
          type: string
      responses:
        '200':
          description: OK
      operationId: getApiBookByChapterIdBookResources
      x-operation-id-source: derived
  /api/Book/{chapterId}/chapters:
    get:
      tags:
      - Book
      summary: This will return a list of mappings from ID -> page num.
      description: This is essentially building the table of contents
      parameters:
      - name: chapterId
        in: path
        description: ''
        required: true
        schema:
          type: integer
          format: int32
      responses:
        '200':
          description: OK
          content:
            text/plain:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/BookChapterItem'
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/BookChapterItem'
            text/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/BookChapterItem'
      operationId: getApiBookByChapterIdChapters
      x-operation-id-source: derived
  /api/Book/{chapterId}/book-page:
    get:
      tags:
      - Book
      summary: This returns a single page within the epub book.
      parameters:
      - name: chapterId
        in: path
        description: ''
        required: true
        schema:
          type: integer
          format: int32
      - name: page
        in: query
        description: ''
        schema:
          type: integer
          format: int32
      responses:
        '200':
          description: OK
          content:
            text/plain:
              schema:
                type: string
            application/json:
              schema:
                type: string
            text/json:
              schema:
                type: string
      operationId: getApiBookByChapterIdBookPage
      x-operation-id-source: derived
components:
  schemas:
    BookChapterItem:
      type: object
      properties:
        title:
          type:
          - string
          - 'null'
        part:
          type:
          - string
          - 'null'
        page:
          type: integer
          format: int32
        children:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/BookChapterItem'
      additionalProperties: false
    MangaFormat:
      enum:
      - 0
      - 1
      - 2
      - 3
      - 4
      type: integer
      description: 'Members:

        - `0` — Image

        - `1` — Archive

        - `2` — Unknown

        - `3` — EPUB (Epub)

        - `4` — PDF (Pdf)'
      format: int32
      x-enum-varnames:
      - Image
      - Archive
      - Unknown
      - Epub
      - Pdf
      x-enum-descriptions:
      - Image
      - Archive
      - Unknown
      - EPUB
      - PDF
    BookInfoDto:
      type: object
      properties:
        bookTitle:
          type:
          - string
          - 'null'
        seriesId:
          type: integer
          format: int32
        volumeId:
          type: integer
          format: int32
        seriesFormat:
          $ref: '#/components/schemas/MangaFormat'
        seriesName:
          type:
          - string
          - 'null'
        chapterNumber:
          type:
          - string
          - 'null'
        volumeNumber:
          type:
          - string
          - 'null'
        libraryId:
          type: integer
          format: int32
        pages:
          type: integer
          format: int32
        isSpecial:
          type: boolean
        chapterTitle:
          type:
          - string
          - 'null'
      additionalProperties: false
  securitySchemes:
    AuthKey:
      type: apiKey
      description: Auth Key authentication. Enter your Auth key from your user settings
      name: x-api-key
      in: header