Kavita Account API

All Account matters

GitHub OpenAPI

Operations 28

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

GET /api/Account/oidc-authenticated Check if OIDC cookies are present · Returns true if OIDC authentication cookies are present and the… #
Ask an LLM
“Are my OpenID Connect cookies still valid for the current session?”
“Can I tell whether OIDC authentication is set up for me right now?”
Tell an agent
Check whether OIDC authentication cookies are present.
Tell me if I'm currently signed in with OpenID Connect.
GET /api/Account Get my current user account · Returns the current user, as it would from login #
Ask an LLM
“What username and roles does the logged-in user have?”
“Can I see my own user account details after logging in?”
Tell an agent
Show my current user account.
Get the user account details for the user I'm logged in as.
POST /api/Account/reset-password Change my password · Update a user's password #
Ask an LLM
“How do I change my password on Kavita?”
“Can I reset my password without knowing the old one?”
Tell an agent
Reset my password to {password} for user {userName}.
Change the password of {userName} to {password} using old password {oldPassword}.
POST /api/Account/register Register the first admin user · Register the first user (admin) on the server. #
Ask an LLM
“How do I create the first admin account on a new Kavita server?”
“What details are needed to register the initial user?”
Tell an agent
Register admin user {username} with password {password}.
Create the first user {username} on the server with email {email} and password {password}.
POST /api/Account/login Log in and get a JWT token · Perform a login. Will send JWT Token of the logged in user back #
Ask an LLM
“How do I log in and get a JWT token back?”
“Can I log in using an API key instead of a username and password?”
Tell an agent
Log in as {username} with password {password} and return the JWT token.
Log in using API key {apiKey} and return the JWT token.
GET /api/Account/refresh-account Get an up-to-date user account · Returns an up-to-date user account #
Ask an LLM
“How do I refresh my user account details after a change?”
“Can I get the latest user account info without logging out?”
Tell an agent
Refresh my user account with the latest details.
Fetch the most up-to-date user account information.
POST /api/Account/refresh-token Refresh my JWT token · Refreshes the user's JWT token #
Ask an LLM
“How do I get a new JWT token when the old one expires?”
“Can I refresh a JWT token using its refresh token?”
Tell an agent
Refresh my JWT token using refresh token {refreshToken}.
Exchange the expired token {token} for a new JWT.
GET /api/Account/roles List all user roles · Get All Roles back. See Kavita.Models.Constants.PolicyConstants #
Ask an LLM
“What roles can I assign to users?”
“Where do I see the full list of user roles?”
Tell an agent
List all user roles.
Show me every role available for user accounts.
POST /api/Account/update/username Change my username · Initiates the flow to update a user's username #
Ask an LLM
“How do I change my username?”
“Can I rename my account after logging in?”
Tell an agent
Change my username to {username}.
Start the username change flow for the logged-in user to {username}.
POST /api/Account/update/email Change my email address · Initiates the flow to update a user's email address. #
Ask an LLM
“How do I change the email on my account?”
“Can I update my email address and confirm it with a token?”
Tell an agent
Change my email to {email}.
Update my account email to {email} using password {password}.
POST /api/Account/update/age-restriction Change my age rating restriction · Change the Age Rating restriction for the user #
Ask an LLM
“How do I change the age rating restriction on my account?”
“Can I include unknown age ratings when setting my restriction?”
Tell an agent
Set my age rating restriction to {ageRating} with includeUnknowns {includeUnknowns}.
Change my age restriction to {ageRating}, including unknowns: {includeUnknowns}.
POST /api/Account/update Update my user account · Update the user account. #
Ask an LLM
“How do I change my username, roles or libraries on my account?”
“Can I edit a user account that uses OpenID Connect?”
Tell an agent
Update my user account with username {username}, roles {roles} and libraries {libraries}.
Change my account's age restriction to {ageRestriction} and email to {email}.
GET /api/Account/invite-url Get a user invite link · Requests the Invite Url for the AppUserId. #
Ask an LLM
“How do I generate a link to invite a new user?”
“Can the invite link include the base URL?”
Tell an agent
Get the invite URL for user {userId}.
Generate an invite link for user {userId} with base URL {withBaseUrl}.
POST /api/Account/invite Invite a user to the server · Invites a user to the server. Will generate a setup link for continuing setup. #
Ask an LLM
“How do I invite someone to join my Kavita server?”
“Can I set roles and libraries when inviting a new user?”
Tell an agent
Invite {email} to the server.
Invite {email} with roles {roles}, libraries {libraries} and age restriction {ageRestriction}.
POST /api/Account/confirm-email Confirm an email invite · Last step in authentication flow, confirms the email token for email #
Ask an LLM
“How do I finish signing up with an email invite?”
“What do I send to confirm my email token and set a password?”
Tell an agent
Confirm email {email} with token {token} and set password {password} for {username}.
Complete the signup for {username} using email {email}, token {token} and password {password}.
POST /api/Account/confirm-email-update Confirm an email change · Final step in email update change. #
Ask an LLM
“How do I confirm a change to my email address?”
“Will confirming my new email force connected clients to re-authenticate?”
Tell an agent destructive · confirm first
Confirm the email change for {email} with token {token}.
Finish changing my email to {email} using confirmation token {token}.
POST /api/Account/confirm-password-reset Confirm a password reset · Create api account confirm password reset #
Ask an LLM
“How do I finish resetting my password with a token?”
“Can I set a new password after requesting a reset?”
Tell an agent
Confirm the password reset for {email} with token {token} and set password {password}.
Complete the password reset for {email} using token {token} and new password {password}.
POST /api/Account/forgot-password Request a password reset email · Will send user a link to update their password to their email or prompt them if… #
Ask an LLM
“How do I get a link to reset my password?”
“Can I request a password reset for a given email address?”
Tell an agent
Send a password reset email to {email}.
Request a password reset link for {email}.
GET /api/Account/email-confirmed Check if my email is confirmed · Get api account email confirmed #
Ask an LLM
“Is my email address confirmed on my account?”
“How do I verify that I've verified my email?”
Tell an agent
Check whether my email is confirmed.
Tell me if my email address has been verified.
POST /api/Account/confirm-migration-email Confirm an email migration · Create api account confirm migration email #
Ask an LLM
“How do I confirm the email address used to migrate my Kavita account?”
“Can I confirm a migration with a token and email?”
Tell an agent
Confirm the migration email {email} with token {token}.
Finish the account migration using {email} and {token}.
POST /api/Account/resend-confirmation-email Resend a user invite email · Resend an invite to a user already invited #
Ask an LLM
“How do I resend the invite email to a user who was already invited?”
“Can I send a new confirmation email to a user by their ID?”
Tell an agent
Resend the confirmation email to user {userId}.
Send an invite again to the user with ID {userId}.
GET /api/Account/opds-url Get my OPDS feed URL · Returns the OPDS url for this user #
Ask an LLM
“Where is my OPDS feed URL for reading Kavita books on a reader?”
“Can I get the OPDS URL for a specific auth key name?”
Tell an agent
Get my OPDS feed URL.
Get the OPDS URL for auth key {authKeyName}.
GET /api/Account/is-email-valid Check if my email is valid · Is the user's current email valid or not #
Ask an LLM
“Is the email address on my Kavita account still valid?”
“Can I check whether my current email is confirmed?”
Tell an agent
Check if my email is valid.
Confirm that my account email address is still valid.
GET /api/Account/auth-keys List my auth keys · Returns all Auth Keys with the account #
Ask an LLM
“Which API keys have been issued to my Kavita account?”
“What names and expiry dates do my auth keys have?”
Tell an agent
List all auth keys on my account.
Show every API key I've created.
POST /api/Account/rotate-auth-key Rotate an auth key · Rotate the Auth Key #
Ask an LLM
“How do I rotate an existing auth key to a new one?”
“Can I rotate a key and set its expiry date?”
Tell an agent destructive · confirm first
Rotate auth key {authKeyId} to a new {keyLength}-character key named {name}.
Rotate key {authKeyId} named {name} to expire at {expiresUtc}.
POST /api/Account/create-auth-key Create a new auth key · Creates a new Auth Key for a user #
Ask an LLM
“How do I generate a new API key for my Kavita account?”
“Can I create an auth key that expires on a certain date?”
Tell an agent
Create an auth key named {name} with {keyLength} characters.
Create auth key {name} that expires at {expiresUtc}.
DELETE /api/Account/auth-key Delete an auth key · Delete the Auth Key #
Ask an LLM
“How do I delete an API key from my account?”
“Can I remove an auth key by its ID?”
Tell an agent destructive · confirm first
Delete auth key {authKeyId}.
Remove the API key {authKeyId} from my account.

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-account-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-account-api-openapi.yml Raw ↑
openapi: 3.2.0
info:
  title: Kavita Account 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:


# --- truncated at 32 KB (39 KB total) ---
# Full source: https://artifacts.apis.io/kavita/openapi/kavita-account-api-openapi.yml