Documentation Index
Fetch the complete documentation index at: https://docs.discovr.media/llms.txt
Use this file to discover all available pages before exploring further.
AddHistoryPayload
| Property | Type | Required | Description |
|---|
| mediaId | string | Yes | The media ID with prefix (MV_TMDBID for movies, TV_TMDBID for TV shows) |
| updatedAt | string | No | ISO 8601 timestamp indicating when the history entry was last updated |
| progress | number | No | Playback progress percentage (0-100) |
| season | integer | No | Season number (required for TV shows) |
| episode | integer | No | Episode number (optional for TV shows). When omitted, creates a “Default for Episode” entry that applies to all episodes in the season where episode.air_date < historyItem.updatedAt. This allows updating multiple episodes with a single history entry. Overriding Season Defaults: When provided, creates an explicit episode entry that takes precedence over any season default entries. To unmark an episode completed via season default, create an explicit entry with progress < 80% (which will not be marked as completed). |
| imported | string | No | Source of import (e.g., “trakt”) if this item was imported |
AddPlaybackPayload
| Property | Type | Required | Description |
|---|
| mediaId | string | Yes | The media ID with prefix (MV_TMDBID for movies, TV_TMDBID for TV shows) |
| progress | number | No | Initial playback progress percentage (0-100) |
| updatedAt | string | No | ISO 8601 timestamp for when playback was last updated |
AddSimpleListItemPayload
| Property | Type | Required | Description |
|---|
| mediaId | string | Yes | The media ID with prefix (MV_TMDBID for movies, TV_TMDBID for TV shows) |
EditPlaybackPayload
| Property | Type | Required | Description |
|---|
| mediaId | string | Yes | The media ID with prefix (MV_TMDBID for movies, TV_TMDBID for TV shows) |
| progress | number | No | New playback progress percentage (0-100) |
| updatedAt | string | No | ISO 8601 timestamp for when playback was last updated |
| season | integer | No | Season number (only for TV shows) |
| episode | integer | No | Episode number (only for TV shows) |
HistoryItem
| Property | Type | Required | Description |
|---|
| id | string | Yes | The DiscovrID (TV_<tmdbId> or MV_<tmdbId>) |
| mediaType | "movie" | "tv" | Yes | The type of media |
| title | string | Yes | The title of the media |
| poster_path | string | Yes | Full URL to the poster image (original size) |
| backdrop_path | string | Yes | Full URL to the backdrop image (original size) |
| updatedAt | string | Yes | ISO 8601 timestamp indicating when the history entry was last updated |
| progress | number | No | Playback progress percentage (0-100) |
| completed | boolean | No | Whether the media is considered completed (progress >= 80%) |
| watched_count | integer | Yes | The number of times this history entry has been updated |
| season | integer | No | Season number (required for TV shows) |
| episode | integer | No | Episode number (required for TV shows) |
| imported | string | No | Source of import (e.g., “trakt”) if this item was imported |
| createdAt | string | Yes | ISO 8601 timestamp indicating when the item was added to the list |
HistoryListResponse
| Property | Type | Required | Description |
|---|
| items | HistoryItem[] | Yes | Array of history items |
| hasMore | boolean | Yes | Whether there are more items available |
| nextPageToken | string | No | Opaque token to fetch the next page of results |
PatchHistoryPayload
| Property | Type | Required | Description |
|---|
| progress | number | Yes | Playback progress percentage (0-100). Values >= 80% are considered completed, values < 80% are not completed. Use progress: 0 to unmark an episode that was completed via season default. |
PlaybackItem
| Property | Type | Required | Description |
|---|
| id | string | Yes | The DiscovrID (TV_<tmdbId> or MV_<tmdbId>) |
| mediaType | "movie" | "tv" | Yes | The type of media |
| title | string | Yes | The title of the media |
| poster_path | string | Yes | Full URL to the poster image (original size) |
| backdrop_path | string | Yes | Full URL to the backdrop image (original size) |
| episode_image | string | No | Full URL to the episode still image (only present for episode-level playback items) |
| episode_title | string | No | The title of the episode (only present for episode-level playback items) |
| progress | number | No | Playback progress percentage (0-100) |
| updatedAt | string | No | ISO 8601 timestamp indicating when playback was last updated |
| season | integer | No | Season number (only for TV shows) |
| episode | integer | No | Episode number (only for TV shows) |
| createdAt | string | Yes | ISO 8601 timestamp indicating when the item was first added to the list |
PlaybackListResponse
| Property | Type | Required | Description |
|---|
| items | PlaybackItem[] | Yes | Array of playback items |
| hasMore | boolean | Yes | Whether there are more items available |
| nextPageToken | string | No | Opaque token to fetch the next page of results |
SimpleListItem
| Property | Type | Required | Description |
|---|
| id | string | Yes | The DiscovrID (TV_<tmdbId> or MV_<tmdbId>) |
| mediaType | "movie" | "tv" | Yes | The type of media |
| title | string | Yes | The title of the media |
| poster_path | string | Yes | Full URL to the poster image (original size) |
| backdrop_path | string | Yes | Full URL to the backdrop image (original size) |
| createdAt | string | Yes | ISO 8601 timestamp indicating when the item was added to the list |
SimpleListResponse
| Property | Type | Required | Description |
|---|
| items | SimpleListItem[] | Yes | Array of list items |
| hasMore | boolean | Yes | Whether there are more items available |
| nextPageToken | string | No | Opaque token to fetch the next page of results |
SuccessMessage
| Property | Type | Required | Description |
|---|
| message | string | Yes | Success message |
| added | string | No | The list type the item was added to (for exclusive lists) |
| removed | string | No | The list type the item was removed from, if any (for exclusive lists) |
