Komga API Client

Komga offers 2 APIs: REST and OPDS.

Both APIs are secured using HTTP Basic Authentication.

This Dart package is automatically generated by the OpenAPI Generator project:

API version: v37.0
Build package: org.openapitools.codegen.languages.DartDioClientCodegen

Requirements

Dart 1.20.0 or later OR Flutter 0.0.20 or later

Installation & Usage

Github

If this Dart package is published to Github, please include the following in pubspec.yaml

name: Komga API Client
version: 37
description: Generated dart package for interacting with Komga's API in Dart with Dio
dependencies:
  Komga API Client:
    git: https://github.com/frameset/komga_api_client.git
      version: 'any'

Local

To use the package in your local drive, please include the following in pubspec.yaml

dependencies:
  Komga API Client:
    path: /path/to/Komga API Client

Getting Started

Please follow the installation procedure and then run the following:

import 'package:Komga API Client/api.dart';


var api_instance = new BookControllerApi();
var bookId = 789; // int | 

try {
    api_instance.analyze(bookId);
} catch (e) {
    print("Exception when calling BookControllerApi->analyze: $e\n");
}

Documentation for API Endpoints

All URIs are relative to https://demo.komga.org

Class	Method	HTTP request
BookControllerApi	analyze	post /api/v1/books/{bookId}/analyze
BookControllerApi	deleteReadProgress	delete /api/v1/books/{bookId}/read-progress
BookControllerApi	getAllBooks	get /api/v1/books
BookControllerApi	getBookFile	get /api/v1/books/{bookId}/file
BookControllerApi	getBookFile1	get /api/v1/books/{bookId}/file/*
BookControllerApi	getBookPage	get /api/v1/books/{bookId}/pages/{pageNumber}
BookControllerApi	getBookPageThumbnail	get /api/v1/books/{bookId}/pages/{pageNumber}/thumbnail
BookControllerApi	getBookPages	get /api/v1/books/{bookId}/pages
BookControllerApi	getBookSiblingNext	get /api/v1/books/{bookId}/next
BookControllerApi	getBookSiblingPrevious	get /api/v1/books/{bookId}/previous
BookControllerApi	getBookThumbnail	get /api/v1/books/{bookId}/thumbnail
BookControllerApi	getBooksOnDeck	get /api/v1/books/ondeck
BookControllerApi	getLatestBooks	get /api/v1/books/latest
BookControllerApi	getOneBook	get /api/v1/books/{bookId}
BookControllerApi	markReadProgress	patch /api/v1/books/{bookId}/read-progress
BookControllerApi	refreshMetadata	post /api/v1/books/{bookId}/metadata/refresh
BookControllerApi	updateMetadata	patch /api/v1/books/{bookId}/metadata
ClaimControllerApi	claimAdmin	post /api/v1/claim
FileSystemControllerApi	getDirectoryListing	post /api/v1/filesystem
LibraryControllerApi	addOne	post /api/v1/libraries
LibraryControllerApi	analyze1	post /api/v1/libraries/{libraryId}/analyze
LibraryControllerApi	deleteOne	delete /api/v1/libraries/{id}
LibraryControllerApi	getAll	get /api/v1/libraries
LibraryControllerApi	getOne	get /api/v1/libraries/{id}
LibraryControllerApi	refreshMetadata1	post /api/v1/libraries/{libraryId}/metadata/refresh
LibraryControllerApi	scan	post /api/v1/libraries/{libraryId}/scan
ReferentialControllerApi	getAuthors	get /api/v1/authors
SeriesControllerApi	analyze2	post /api/v1/series/{seriesId}/analyze
SeriesControllerApi	getAllBooksBySeries	get /api/v1/series/{seriesId}/books
SeriesControllerApi	getAllSeries	get /api/v1/series
SeriesControllerApi	getLatestSeries	get /api/v1/series/latest
SeriesControllerApi	getNewSeries	get /api/v1/series/new
SeriesControllerApi	getOneSeries	get /api/v1/series/{seriesId}
SeriesControllerApi	getSeriesThumbnail	get /api/v1/series/{seriesId}/thumbnail
SeriesControllerApi	getUpdatedSeries	get /api/v1/series/updated
SeriesControllerApi	markAsRead	post /api/v1/series/{seriesId}/read-progress
SeriesControllerApi	markAsUnread	delete /api/v1/series/{seriesId}/read-progress
SeriesControllerApi	refreshMetadata2	post /api/v1/series/{seriesId}/metadata/refresh
SeriesControllerApi	updateMetadata1	patch /api/v1/series/{seriesId}/metadata
UserControllerApi	addOne1	post /api/v1/users
UserControllerApi	delete	delete /api/v1/users/{id}
UserControllerApi	getAll1	get /api/v1/users
UserControllerApi	getMe	get /api/v1/users/me
UserControllerApi	updatePassword	patch /api/v1/users/me/password
UserControllerApi	updateSharesLibraries	patch /api/v1/users/{id}/shared-libraries
UserControllerApi	updateUserRoles	patch /api/v1/users/{id}

Documentation For Models

Documentation For Authorization

basicAuth

Type: HTTP basic authentication

Author

Libraries

api_key_auth
api_util
auth
author_dto
author_update_dto
basic_auth
book_controller_api
book_dto
book_metadata_dto
book_metadata_update_dto
claim_controller_api
collection_creation_dto
collection_dto
collection_update_dto
directory_listing_dto
directory_request_dto
file_system_controller_api
komga_api_client.api
library_controller_api
library_creation_dto
library_dto
local_date_serializer
media_dto
oauth
opds_author
opds_controller_api
opds_entry
opds_feed
opds_link
open_search_description
open_search_url
page_book_dto
page_collection_dto
page_dto
page_series_dto
pageable
password_update_dto
path_dto
read_progress_dto
read_progress_update_dto
referential_controller_api
roles_update_dto
serializers
series_collection_controller_api
series_controller_api
series_dto
series_metadata_dto
series_metadata_update_dto
shared_libraries_update_dto
shared_library_dto
sort
user_controller_api
user_creation_dto
user_dto
user_with_shared_libraries_dto

komga_api_client package