API reference

​

Generated SDK exports

• Generated operation functions such as getBooks, getBookById, getBookPages, getSeriesById, getLibraries, getLibraryById, getCollections, and getReadLists.
• Generated DTO, search, page, operation response, and operation error types.
• createKomgaClient, AuthConfig, and KomgaClientOptions.
• KomgaResult, KomgaApiError, and unwrap.
• The generated createClient function and GeneratedClientConfig type for advanced integrations.

import { getBookById } from 'komga-sdk';

const result = await getBookById(
  { bookId: 'book-123' },
  { client },
);

if (result.error === undefined) {
  console.log(result.data.metadata.title);
}

​

Read the generated operation contract

import type {
  BookMetadataUpdateDto,
  GetBookByIdError,
  PageBookDto,
} from 'komga-sdk';

const update: BookMetadataUpdateDto = { title: 'New title' };

function render(page: PageBookDto) {
  return page.content?.map((book) => book.metadata.title) ?? [];
}

​

Komga server API

​

Version alignment

​

TypeDoc and source navigation

​

Next steps

• Configure the generated client: Fetch configuration
• Browse operation usage: Generated API operations
• Add consumer-owned validation: Runtime validation
• Handle result and media responses: Result handling