Discovery needs no key. Ratings and market analysis are Pro.
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. See our Privacy Policy and
Terms.
openapi: 3.2.0
info:
title: Kavita Oidc 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: OIDC
paths:
/Oidc/login:
get:
tags:
- OIDC
parameters:
- name: returnUrl
in: query
schema:
type: string
default: /
responses:
'200':
description: OK
summary: Get oidc login
x-summary-source: derived
operationId: getOidcLogin
x-operation-id-source: derived
/Oidc/logout:
get:
tags:
- OIDC
responses:
'200':
description: OK
summary: Get oidc logout
x-summary-source: derived
operationId: getOidcLogout
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