Kavita Opds API

The Opds API from Kavita — 21 operation(s) for opds.

GitHub OpenAPI

Operations 22

Each operation below carries the questions people ask an LLM about it and the instructions they give an agent to run it. Generated by API Evangelist overlay

POST /api/Opds/{apiKey} Post to the OPDS catalogue · Returns the Catalogue for Kavita's OPDS Service #
Ask an LLM
“Is there a POST form of the OPDS catalogue?”
“Can I send a POST request to fetch OPDS items?”
Tell an agent
Post to the OPDS catalogue for API key {apiKey}.
Send an OPDS POST request with {apiKey}.
GET /api/Opds/{apiKey} Get the OPDS catalogue · Returns the Catalogue for Kavita's OPDS Service #
Ask an LLM
“How do I get the OPDS catalogue for my Kavita library?”
“Can I fetch the full OPDS feed for a library API key?”
Tell an agent
Get the OPDS catalogue for API key {apiKey}.
Fetch the OPDS feed using {apiKey}.
GET /api/Opds/{apiKey}/smart-filters/{filterId} Get one smart filter · Get the User's Smart Filter - Supports Pagination #
Ask an LLM
“How do I fetch a single smart filter by its ID?”
“Can I page through one smart filter's results?”
Tell an agent
Get smart filter {filterId} for API key {apiKey}.
Show page {pageNumber} of smart filter {filterId} using {apiKey}.
GET /api/Opds/{apiKey}/smart-filters List smart filters · Get the User's Smart Filters (Dashboard Context) - Supports Pagination #
Ask an LLM
“What smart filters have I saved?”
“Can I see all my smart filters at once?”
Tell an agent
List my smart filters for API key {apiKey}.
Show all saved smart filters with {apiKey}.
GET /api/Opds/{apiKey}/libraries List OPDS libraries · Get the User's Libraries - No Pagination Support #
Ask an LLM
“Which libraries are available through OPDS?”
“Can I get every library without pagination?”
Tell an agent
List OPDS libraries for API key {apiKey}.
Show all my OPDS libraries using {apiKey}.
GET /api/Opds/{apiKey}/want-to-read Get OPDS want-to-read list · Get the User's Want to Read list - Supports Pagination #
Ask an LLM
“What do I have on my want-to-read list?”
“Can I page through want-to-read items?”
Tell an agent
Get my want-to-read list for API key {apiKey}.
Show want-to-read page {pageNumber} with {apiKey}.
GET /api/Opds/{apiKey}/collections List OPDS collections · Get all Collections - Supports Pagination #
Ask an LLM
“Which collections do I have in OPDS?”
“Can I page through all my OPDS collections?”
Tell an agent
List OPDS collections for API key {apiKey}.
Show collection page {pageNumber} using {apiKey}.
GET /api/Opds/{apiKey}/collections/{collectionId} List series in an OPDS collection · Get Series for a given Collection - Supports Pagination #
Ask an LLM
“What series are in a particular OPDS collection?”
“Can I page through one collection's series?”
Tell an agent
List series in collection {collectionId} for API key {apiKey}.
Show page {pageNumber} of collection {collectionId} with {apiKey}.
GET /api/Opds/{apiKey}/reading-list List OPDS reading lists · Get a User's Reading Lists - Supports Pagination #
Ask an LLM
“What reading lists do I have in OPDS?”
“Can I page through all my OPDS reading lists?”
Tell an agent
List OPDS reading lists for API key {apiKey}.
Show reading list page {pageNumber} using {apiKey}.
GET /api/Opds/{apiKey}/reading-list/{readingListId} List chapters in an OPDS reading list · Returns individual items (chapters) from Reading List by ID - Supports… #
Ask an LLM
“What chapters are in a specific OPDS reading list?”
“Can I page through one reading list's chapters?”
Tell an agent
List chapters in reading list {readingListId} for API key {apiKey}.
Show page {pageNumber} of reading list {readingListId} with {apiKey}.
GET /api/Opds/{apiKey}/libraries/{libraryId} List series in an OPDS library · Returns Series from the Library - Supports Pagination #
Ask an LLM
“What series are in a particular OPDS library?”
“Can I page through one library's series?”
Tell an agent
List series in library {libraryId} for API key {apiKey}.
Show page {pageNumber} of library {libraryId} with {apiKey}.
GET /api/Opds/{apiKey}/recently-added Get recently added OPDS items · Returns Recently Added (Dashboard Feed) - Supports Pagination #
Ask an LLM
“What has been added to my OPDS feed recently?”
“Can I page through the recently added OPDS items?”
Tell an agent
Get recently added items for API key {apiKey}.
Show page {pageNumber} of recently added with {apiKey}.
GET /api/Opds/{apiKey}/recently-updated Get recently updated OPDS series · Get the Recently Updated Series (Dashboard) - Pagination available, total pages… #
Ask an LLM
“Which OPDS series were updated most recently?”
“Can I page through recently updated OPDS series?”
Tell an agent
Get recently updated OPDS series for API key {apiKey}.
Show page {pageNumber} of recently updated OPDS with {apiKey}.
GET /api/Opds/{apiKey}/on-deck Get OPDS on-deck items · Get the On Deck (Dashboard) - Supports Pagination #
Ask an LLM
“What is on my OPDS on-deck list?”
“Can I page through OPDS on-deck items?”
Tell an agent
Get OPDS on-deck items for API key {apiKey}.
Show page {pageNumber} of OPDS on-deck with {apiKey}.
GET /api/Opds/{apiKey}/series Search OPDS series · OPDS Search endpoint #
Ask an LLM
“How do I search OPDS series by keyword?”
“Can I search the OPDS catalogue for a series?”
Tell an agent
Search OPDS series for {query} with API key {apiKey}.
Find OPDS series matching {query}.
GET /api/Opds/{apiKey}/search Search OPDS items · Get api opds by api key search #
Ask an LLM
“Can I search the OPDS catalogue for any item?”
“What does the OPDS search endpoint return?”
Tell an agent
Search the OPDS catalogue for API key {apiKey}.
Run an OPDS search using {apiKey}.
GET /api/Opds/{apiKey}/series/{seriesId} Get chapters of an OPDS series · Returns the items within a Series (Series Detail) #
Ask an LLM
“How do I get all chapters of a series in OPDS?”
“What does the OPDS series detail page return?”
Tell an agent
Get chapters of series {seriesId} for API key {apiKey}.
Show OPDS series {seriesId} detail with {apiKey}.
GET /api/Opds/{apiKey}/series/{seriesId}/volume/{volumeId} Get chapters of an OPDS volume · Returns items for a given Volume #
Ask an LLM
“How do I get the chapters of one volume in OPDS?”
“Can I read a single volume of a series through OPDS?”
Tell an agent
Get chapters of volume {volumeId} in series {seriesId} for API key {apiKey}.
Show OPDS volume {volumeId} of series {seriesId} with {apiKey}.
GET /api/Opds/{apiKey}/series/{seriesId}/volume/{volumeId}/chapter/{chapterId} Get one OPDS chapter · Gets items for a given Chapter #
Ask an LLM
“How do I read a single chapter of a series through OPDS?”
“Can I fetch one chapter by its ID?”
Tell an agent
Get chapter {chapterId} of volume {volumeId} in series {seriesId} for API key {apiKey}.
Show OPDS chapter {chapterId} with {apiKey}.
GET /api/Opds/{apiKey}/series/{seriesId}/volume/{volumeId}/chapter/{chapterId}/download/{filename} Download an OPDS chapter · Downloads a file (user must have download permission) #
Ask an LLM
“How do I download a chapter from OPDS?”
“Do I need a filename to download an OPDS chapter?”
Tell an agent
Download chapter {chapterId} of volume {volumeId} in series {seriesId} for API key {apiKey}.
Download {filename} from OPDS chapter {chapterId} with {apiKey}.
GET /api/Opds/{apiKey}/image Get an OPDS image for a library · This returns a streamed image following OPDS-PS v1.2 #
Ask an LLM
“Can I get a cover image for a series or volume through OPDS?”
“Is there a way to save progress when fetching an OPDS image?”
Tell an agent
Get the OPDS image for library {libraryId} using API key {apiKey}.
Fetch page {pageNumber} of the OPDS image for series {seriesId}, saving progress {saveProgress}.
GET /api/Opds/{apiKey}/favicon Get the OPDS feed icon for an API key · Get api opds by api key favicon #
Ask an LLM
“Where can I get the icon Kavita uses for OPDS feeds?”
“Can I fetch the favicon for an OPDS API key?”
Tell an agent
Get the OPDS favicon for API key {apiKey}.
Fetch the icon Kavita serves for OPDS feed {apiKey}.

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API
curl "https://apis.io/api/v1/apis/kavita:kavita-opds-api"
All apis
curl "https://apis.io/api/v1/apis?limit=25"

Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. By signing up you are subscribing to the APIs.io and API Evangelist newsletters — you can unsubscribe from any issue. See our Privacy Policy and Terms.

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

kavita-opds-api-openapi.yml Raw ↑
openapi: 3.2.0
info:
  title: Kavita Opds 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: Opds
paths:
  /api/Opds/{apiKey}:
    post:
      tags:
      - Opds
      summary: Returns the Catalogue for Kavita's OPDS Service
      parameters:
      - name: apiKey
        in: path
        description: ''
        required: true
        schema:
          type: string
      responses:
        '200':
          description: OK
      operationId: postApiOpdsByApiKey
      x-operation-id-source: derived
    get:
      tags:
      - Opds
      summary: Returns the Catalogue for Kavita's OPDS Service
      parameters:
      - name: apiKey
        in: path
        description: ''
        required: true
        schema:
          type: string
      responses:
        '200':
          description: OK
      operationId: getApiOpdsByApiKey
      x-operation-id-source: derived
  /api/Opds/{apiKey}/smart-filters/{filterId}:
    get:
      tags:
      - Opds
      summary: Get the User's Smart Filter - Supports Pagination
      description: Smart filters have different entity types, this will resolve to the underlying entity
      parameters:
      - name: apiKey
        in: path
        required: true
        schema:
          type: string
      - name: filterId
        in: path
        required: true
        schema:
          type: integer
          format: int32
      - name: pageNumber
        in: query
        schema:
          type: integer
          format: int32
          default: 1
      responses:
        '200':
          description: OK
      operationId: getApiOpdsByApiKeySmartFiltersByFilterId
      x-operation-id-source: derived
  /api/Opds/{apiKey}/smart-filters:
    get:
      tags:
      - Opds
      summary: Get the User's Smart Filters (Dashboard Context) - Supports Pagination
      parameters:
      - name: apiKey
        in: path
        description: ''
        required: true
        schema:
          type: string
      - name: pageNumber
        in: query
        description: ''
        schema:
          type: integer
          format: int32
          default: 1
      responses:
        '200':
          description: OK
      operationId: getApiOpdsByApiKeySmartFilters
      x-operation-id-source: derived
  /api/Opds/{apiKey}/libraries:
    get:
      tags:
      - Opds
      summary: Get the User's Libraries - No Pagination Support
      parameters:
      - name: apiKey
        in: path
        description: ''
        required: true
        schema:
          type: string
      - name: pageNumber
        in: query
        description: ''
        schema:
          type: integer
          format: int32
          default: 1
      responses:
        '200':
          description: OK
      operationId: getApiOpdsByApiKeyLibraries
      x-operation-id-source: derived
  /api/Opds/{apiKey}/want-to-read:
    get:
      tags:
      - Opds
      summary: Get the User's Want to Read list - Supports Pagination
      parameters:
      - name: apiKey
        in: path
        description: ''
        required: true
        schema:
          type: string
      - name: pageNumber
        in: query
        description: ''
        schema:
          type: integer
          format: int32
          default: 1
      responses:
        '200':
          description: OK
      operationId: getApiOpdsByApiKeyWantToRead
      x-operation-id-source: derived
  /api/Opds/{apiKey}/collections:
    get:
      tags:
      - Opds
      summary: Get all Collections - Supports Pagination
      parameters:
      - name: apiKey
        in: path
        description: ''
        required: true
        schema:
          type: string
      - name: pageNumber
        in: query
        description: ''
        schema:
          type: integer
          format: int32
          default: 1
      responses:
        '200':
          description: OK
      operationId: getApiOpdsByApiKeyCollections
      x-operation-id-source: derived
  /api/Opds/{apiKey}/collections/{collectionId}:
    get:
      tags:
      - Opds
      summary: Get Series for a given Collection - Supports Pagination
      parameters:
      - name: collectionId
        in: path
        description: ''
        required: true
        schema:
          type: integer
          format: int32
      - name: apiKey
        in: path
        description: ''
        required: true
        schema:
          type: string
      - name: pageNumber
        in: query
        description: ''
        schema:
          type: integer
          format: int32
          default: 1
      responses:
        '200':
          description: OK
      operationId: getApiOpdsByApiKeyCollectionsByCollectionId
      x-operation-id-source: derived
  /api/Opds/{apiKey}/reading-list:
    get:
      tags:
      - Opds
      summary: Get a User's Reading Lists - Supports Pagination
      parameters:
      - name: apiKey
        in: path
        description: ''
        required: true
        schema:
          type: string
      - name: pageNumber
        in: query
        description: ''
        schema:
          type: integer
          format: int32
          default: 1
      responses:
        '200':
          description: OK
      operationId: getApiOpdsByApiKeyReadingList
      x-operation-id-source: derived
  /api/Opds/{apiKey}/reading-list/{readingListId}:
    get:
      tags:
      - Opds
      summary: Returns individual items (chapters) from Reading List by ID - Supports…
      parameters:
      - name: readingListId
        in: path
        description: ''
        required: true
        schema:
          type: integer
          format: int32
      - name: apiKey
        in: path
        description: ''
        required: true
        schema:
          type: string
      - name: pageNumber
        in: query
        description: ''
        schema:
          type: integer
          format: int32
          default: 1
      responses:
        '200':
          description: OK
      operationId: getApiOpdsByApiKeyReadingListByReadingListId
      x-operation-id-source: derived
  /api/Opds/{apiKey}/libraries/{libraryId}:
    get:
      tags:
      - Opds
      summary: Returns Series from the Library - Supports Pagination
      parameters:
      - name: libraryId
        in: path
        description: ''
        required: true
        schema:
          type: integer
          format: int32
      - name: apiKey
        in: path
        description: ''
        required: true
        schema:
          type: string
      - name: pageNumber
        in: query
        description: ''
        schema:
          type: integer
          format: int32
          default: 1
      responses:
        '200':
          description: OK
      operationId: getApiOpdsByApiKeyLibrariesByLibraryId
      x-operation-id-source: derived
  /api/Opds/{apiKey}/recently-added:
    get:
      tags:
      - Opds
      summary: Returns Recently Added (Dashboard Feed) - Supports Pagination
      parameters:
      - name: apiKey
        in: path
        description: ''
        required: true
        schema:
          type: string
      - name: pageNumber
        in: query
        description: ''
        schema:
          type: integer
          format: int32
          default: 1
      responses:
        '200':
          description: OK
      operationId: getApiOpdsByApiKeyRecentlyAdded
      x-operation-id-source: derived
  /api/Opds/{apiKey}/recently-updated:
    get:
      tags:
      - Opds
      summary: Get the Recently Updated Series (Dashboard) - Pagination available, total pages…
      parameters:
      - name: apiKey
        in: path
        description: ''
        required: true
        schema:
          type: string
      - name: pageNumber
        in: query
        description: ''
        schema:
          type: integer
          format: int32
          default: 1
      responses:
        '200':
          description: OK
      operationId: getApiOpdsByApiKeyRecentlyUpdated
      x-operation-id-source: derived
  /api/Opds/{apiKey}/on-deck:
    get:
      tags:
      - Opds
      summary: Get the On Deck (Dashboard) - Supports Pagination
      parameters:
      - name: apiKey
        in: path
        description: ''
        required: true
        schema:
          type: string
      - name: pageNumber
        in: query
        description: ''
        schema:
          type: integer
          format: int32
          default: 1
      responses:
        '200':
          description: OK
      operationId: getApiOpdsByApiKeyOnDeck
      x-operation-id-source: derived
  /api/Opds/{apiKey}/series:
    get:
      tags:
      - Opds
      summary: OPDS Search endpoint
      parameters:
      - name: apiKey
        in: path
        description: ''
        required: true
        schema:
          type: string
      - name: query
        in: query
        description: ''
        schema:
          type: string
      responses:
        '200':
          description: OK
      operationId: getApiOpdsByApiKeySeries
      x-operation-id-source: derived
  /api/Opds/{apiKey}/search:
    get:
      tags:
      - Opds
      parameters:
      - name: apiKey
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: OK
      summary: Get api opds by api key search
      x-summary-source: derived
      operationId: getApiOpdsByApiKeySearch
      x-operation-id-source: derived
  /api/Opds/{apiKey}/series/{seriesId}:
    get:
      tags:
      - Opds
      summary: Returns the items within a Series (Series Detail)
      parameters:
      - name: apiKey
        in: path
        description: ''
        required: true
        schema:
          type: string
      - name: seriesId
        in: path
        description: ''
        required: true
        schema:
          type: integer
          format: int32
      responses:
        '200':
          description: OK
      operationId: getApiOpdsByApiKeySeriesBySeriesId
      x-operation-id-source: derived
  /api/Opds/{apiKey}/series/{seriesId}/volume/{volumeId}:
    get:
      tags:
      - Opds
      summary: Returns items for a given Volume
      parameters:
      - name: apiKey
        in: path
        description: ''
        required: true
        schema:
          type: string
      - name: seriesId
        in: path
        description: ''
        required: true
        schema:
          type: integer
          format: int32
      - name: volumeId
        in: path
        description: ''
        required: true
        schema:
          type: integer
          format: int32
      responses:
        '200':
          description: OK
      operationId: getApiOpdsByApiKeySeriesBySeriesIdVolumeByVolumeId
      x-operation-id-source: derived
  /api/Opds/{apiKey}/series/{seriesId}/volume/{volumeId}/chapter/{chapterId}:
    get:
      tags:
      - Opds
      summary: Gets items for a given Chapter
      parameters:
      - name: apiKey
        in: path
        description: ''
        required: true
        schema:
          type: string
      - name: seriesId
        in: path
        description: ''
        required: true
        schema:
          type: integer
          format: int32
      - name: volumeId
        in: path
        description: ''
        required: true
        schema:
          type: integer
          format: int32
      - name: chapterId
        in: path
        description: ''
        required: true
        schema:
          type: integer
          format: int32
      responses:
        '200':
          description: OK
      operationId: getApiOpdsByApiKeySeriesBySeriesIdVolumeByVolumeIdChapterByChapterId
      x-operation-id-source: derived
  /api/Opds/{apiKey}/series/{seriesId}/volume/{volumeId}/chapter/{chapterId}/download/{filename}:
    get:
      tags:
      - Opds
      summary: Downloads a file (user must have download permission)
      parameters:
      - name: apiKey
        in: path
        description: User's API Key
        required: true
        schema:
          type: string
      - name: seriesId
        in: path
        description: ''
        required: true
        schema:
          type: integer
          format: int32
      - name: volumeId
        in: path
        description: ''
        required: true
        schema:
          type: integer
          format: int32
      - name: chapterId
        in: path
        description: ''
        required: true
        schema:
          type: integer
          format: int32
      - name: filename
        in: path
        description: Not used. Only for Chunky to allow download links
        required: true
        schema:
          type: string
      responses:
        '200':
          description: OK
      operationId: getApiOpdsByApiKeySeriesBySeriesIdVolumeByVolumeIdChapterByChapterIdDownloadByFilename
      x-operation-id-source: derived
  /api/Opds/{apiKey}/image:
    get:
      tags:
      - Opds
      summary: This returns a streamed image following OPDS-PS v1.2
      parameters:
      - name: apiKey
        in: path
        description: ''
        required: true
        schema:
          type: string
      - name: libraryId
        in: query
        description: ''
        schema:
          type: integer
          format: int32
      - name: seriesId
        in: query
        description: ''
        schema:
          type: integer
          format: int32
      - name: volumeId
        in: query
        description: ''
        schema:
          type: integer
          format: int32
      - name: chapterId
        in: query
        description: ''
        schema:
          type: integer
          format: int32
      - name: pageNumber
        in: query
        description: ''
        schema:
          type: integer
          format: int32
      - name: saveProgress
        in: query
        description: Optional parameter. Can pass false and progress saving will be suppressed
        schema:
          type: boolean
          default: true
      responses:
        '200':
          description: OK
      operationId: getApiOpdsByApiKeyImage
      x-operation-id-source: derived
  /api/Opds/{apiKey}/favicon:
    get:
      tags:
      - Opds
      parameters:
      - name: apiKey
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: OK
      summary: Get api opds by api key favicon
      x-summary-source: derived
      operationId: getApiOpdsByApiKeyFavicon
      x-operation-id-source: derived
components:
  securitySchemes:
    AuthKey:
      type: apiKey
      description: Auth Key authentication. Enter your Auth key from your user settings
      name: x-api-key
      in: header