Kavita Scrobbling API

The Scrobbling API from Kavita — 19 operation(s) for scrobbling.

GitHub OpenAPI

Operations 19

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/Scrobbling/scrobble-settings List my scrobble providers · Returns all scrobble providers for a user. #
Ask an LLM
“Which scrobble providers are set up for my Kavita account?”
“Can I see the progress and rating scrobbling settings for each provider?”
Tell an agent
Show my scrobble provider settings.
List every scrobble provider and its settings.
POST /api/Scrobbling/update-scrobble-settings Update scrobble settings for a provider · Updates the scrobble settings for a given provider. #
Ask an LLM
“How do I sync my Kavita progress with a specific scrobble provider?”
“Can I change which libraries and age ratings are scrobbled to a provider?”
Tell an agent
Update scrobble settings for provider {provider} to sync progress {progressScrobbling}.
Set scrobble settings for {provider} to sync ratings {ratingScrobbling} and reviews {reviewsScrobbling}.
POST /api/Scrobbling/update-user-scrobble-provider Authenticate a scrobble provider · Update authentication details for the given provider #
Ask an LLM
“How do I connect my AniList or MyAnimeList account to Kavita?”
“Can I refresh the token for a scrobble provider I already linked?”
Tell an agent
Connect scrobble provider {provider} with username {userName}.
Set the refresh token for scrobble provider {provider} to {refreshToken}.
POST /api/Scrobbling/generate-scrobble-events Generate scrobble events for one provider · Generate scrobble events from history. Should only be ran once per user #
Ask an LLM
“Can I generate scrobble events from my history for just one provider?”
“How do I kick off a scrobble sync for a single provider?”
Tell an agent
Generate scrobble events for provider {scrobbleProvider}.
Sync my history into scrobble events for {scrobbleProvider}.
POST /api/Scrobbling/generate-scrobble-events-all Generate scrobble events for all providers · Generate scrobble events from history for all valid providers #
Ask an LLM
“How do I generate scrobble events for every scrobble provider at once?”
“Can I sync my history across all linked providers in one request?”
Tell an agent
Generate scrobble events for all valid scrobble providers.
Sync my history into scrobble events for every provider.
GET /api/Scrobbling/token-expired Check if a scrobble provider token has expired · Checks if the current Scrobbling token for the given Provider has expired for… #
Ask an LLM
“Has my AniList token expired?”
“Can I check the validity of a single scrobble provider's token?”
Tell an agent
Check whether the scrobble token for provider {provider} has expired.
Tell me if {provider}'s scrobble token is still valid.
GET /api/Scrobbling/expired-tokens List my expired scrobble tokens · Returns all expired tokens for the current user #
Ask an LLM
“Which scrobble provider tokens have expired for my account?”
“Can I see every expired scrobble token at once?”
Tell an agent
List all expired scrobble tokens for my account.
Show which scrobble provider tokens are no longer valid.
GET /api/Scrobbling/scrobble-errors List scrobbling errors · Returns all scrobbling errors for the instance #
Ask an LLM
“What scrobbling errors have happened on my Kavita instance?”
“Can an admin see every scrobble sync error?”
Tell an agent
Show all scrobbling errors for the instance.
List every error that occurred during a scrobble sync.
POST /api/Scrobbling/clear-errors Clear scrobbling errors · Clears the scrobbling errors table #
Ask an LLM
“How do I clear the scrobbling error table?”
“Can I wipe all scrobble sync errors at once?”
Tell an agent destructive · confirm first
Clear the scrobbling errors table.
Reset all scrobble sync errors.
POST /api/Scrobbling/scrobble-events List my scrobble history · Returns the scrobbling history for the user #
Ask an LLM
“What has been synced to my scrobble providers?”
“Can I filter my scrobble history by series or page?”
Tell an agent
Show my scrobble history.
List scrobble events matching {query}, sorted by {field}.
GET /api/Scrobbling/holds List my scrobble holds · Returns all scrobble holds for the current user #
Ask an LLM
“Which series am I currently holding from scrobbling?”
“Can I see every scrobble hold on my account?”
Tell an agent
List all my scrobble holds.
Show the series I'm holding back from syncing.
GET /api/Scrobbling/has-hold Check if a series is on hold · If there is an active hold on the series #
Ask an LLM
“Is a particular series currently on hold from scrobbling?”
“Can I check whether one series is being held back?”
Tell an agent
Check if series {seriesId} is on hold.
Tell me whether scrobbling is currently held for series {seriesId}.
GET /api/Scrobbling/library-allows-scrobbling Check if a library allows scrobbling · Does the library the series is in allow scrobbling? #
Ask an LLM
“Does the library a series is in allow scrobbling?”
“Can I check scrobble permissions for a series before syncing it?”
Tell an agent
Check whether scrobbling is allowed for the library of series {seriesId}.
Tell me if series {seriesId} can be scrobbled.
POST /api/Scrobbling/add-hold Hold a series from scrobbling · Adds a hold against the Series for user's scrobbling #
Ask an LLM
“How do I stop a series from being synced to my scrobble provider?”
“Can I put a series on hold until I'm ready to sync it?”
Tell an agent
Add a scrobble hold on series {seriesId}.
Hold series {seriesId} from scrobbling.
DELETE /api/Scrobbling/remove-hold Remove a scrobble hold · Remove a hold against the Series for user's scrobbling #
Ask an LLM
“How do I lift a hold on a series?”
“Can I resume syncing a series I previously held back?”
Tell an agent destructive · confirm first
Remove the scrobble hold on series {seriesId}.
Unhold series {seriesId} so it can sync again.
POST /api/Scrobbling/bulk-remove-events Delete my scrobble events · Delete the given scrobble events if they belong to that user #
Ask an LLM
“How do I delete several scrobble events at once?”
“Can I bulk remove scrobble events I no longer want?”
Tell an agent destructive · confirm first
Bulk remove the scrobble events I've selected.
Delete these scrobble events from my history.
DELETE /api/Scrobbling/remove-error/{id} Delete a scrobble error · Delete api scrobbling remove error by id #
Ask an LLM
“How do I clear one scrobble sync error by its ID?”
“Can I remove a single scrobble error record?”
Tell an agent destructive · confirm first
Delete scrobble error {id}.
Remove scrobble sync error {id} from the table.
POST /api/Scrobbling/retry-scrobble Retry a failed scrobble event · Attempts to retry Scrobble Events for the current authenticated user (or… #
Ask an LLM
“How do I retry a scrobble event that failed?”
“Can I retry a scrobble event for a specific series?”
Tell an agent
Retry scrobble event {id}.
Retry the scrobble event for series {seriesName} with details {scrobbleDetails}.
GET /api/Scrobbling/next-scrobble-time Check when scrobbling runs next · Returns when Scrobbling upload will next execute #
Ask an LLM
“When will my scrobble sync run again?”
“What time does scrobbling upload execute next?”
Tell an agent
Show when scrobbling upload will next execute.
Tell me the next scrobble time.

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-scrobbling-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-scrobbling-api-openapi.yml Raw ↑
openapi: 3.2.0
info:
  title: Kavita Scrobbling 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 (37 KB total) ---
# Full source: https://artifacts.apis.io/kavita/openapi/kavita-scrobbling-api-openapi.yml