Skip to main content
POST

Authorizations

client_id
string
query
default:YOUR_CLIENT_ID
required

Preferred form: your client_id as a URL query parameter on every request. Self-describing in logs and curl commands. See Headers and required parameters.

Authorization
string
header
default:YOUR_ACCESS_TOKEN
required

A user access_token, sent as Authorization: Bearer .... Required for endpoints that read or modify the user's library, scrobble session, ratings, settings, or playbacks. Every flow returns the same kind of token. See Set up authentication.

Headers

User-Agent
string
required

Descriptive identifier for your app, ideally name/version. Examples: PlexMediaServer/1.43.1.10540, kodi-simkl/0.9.2, MyApp/2.4.1 (https://myapp.com).

Query Parameters

client_id
string
required

Your client_id from your Simkl developer settings. Required on every request.

app-name
string
required

Short, lowercase identifier for your app (e.g. plex-scrobbler, kodi-bridge). Helps Simkl identify which apps are using the API.

app-version
string
required

Your app's current version (e.g. 1.0, 2.4.1). Helps Simkl debug issues you report.

Body

application/json

Body for /sync/history/remove — the same shape as /sync/history, plus an optional rewatch_id on an item to remove from that rewatch session only. Items go under movies[], shows[] or anime[].

movies
object[]

Standard movie object. See the Standard Media Objects guide. Identify the title by ids, or — in a request — by title (with year to tell remakes apart).

shows
object[]

Standard show object. May include nested seasons/episodes for partial sync. Identify the title by ids, or — in a request — by title (with year to tell remakes apart).

anime
object[]

Array of anime entries (same shape as shows[]).

Standard show object. May include nested seasons/episodes for partial sync. Identify the title by ids, or — in a request — by title (with year to tell remakes apart).

episodes
object[]

Top-level convenience array for marking episode-level history without nesting. The server wraps each entry into a synthetic single-season show. Each item carries the same shape as items under shows[].seasons[].episodes[] plus the parent show reference.

Response

Counts of items affected, plus any IDs Simkl could not match.

Counts of items removed plus any IDs Simkl could not match.

deleted
object
required
not_found
object
required

Per-type lists of input items Simkl could not match. episodes holds shows Simkl did match, each with only the episode numbers that don't exist.