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 Locale 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: Locale
paths:
/api/Locale:
get:
tags:
- Locale
summary: Returns all applicable locales on the server
description: This can be cached as it will not change per version.
responses:
'200':
description: OK
content:
text/plain:
schema:
type: array
items:
$ref: '#/components/schemas/KavitaLocale'
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/KavitaLocale'
text/json:
schema:
type: array
items:
$ref: '#/components/schemas/KavitaLocale'
operationId: getApiLocale
x-operation-id-source: derived
components:
schemas:
KavitaLocale:
type: object
properties:
fileName:
type:
- string
- 'null'
renderName:
type:
- string
- 'null'
translationCompletion:
type: number
format: float
isRtL:
type: boolean
hash:
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