Suggestions

Generated suggestions operations.

GET/v1/suggestionsRead suggestionsread

Audience: Clients · Native API
Authorization: API key or personal access token with the read scope, or a signed-in session
OpenAPI operation ID: get_suggestions

Parameters

Name	In	Type	Description
`limit`	query	`integer \| ""`≥ 1

Responses

200Successapplication/json

Example

{
  "generatedAt": "2026-10-18T19:30:00Z",
  "items": [
    {
      "entry": {
        "absoluteNumber": 0,
        "activeBeginYear": 0,
        "activeEndYear": 0,
        "addedAt": "2026-10-18T19:30:00Z",
        "airDate": "string",
        "album": {
          "id": "id_8h2k4q",
          "name": "Fargo"
        },
        "albumCount": 0,
        "albumType": "string",
        "artist": {
          "id": "id_8h2k4q",
          "name": "Fargo"
        },
        "artistType": "string",
        "artworkPaths": [
          "string"
        ],
        "audioFacts": {
          "atmos": true,
          "bitDepth": 0,
          "channels": 0,
          "codec": "string",
          "layout": "string",
          "lossless": true,
          "sampleRate": 0
        },
        "author": "string",
        "available": true,
        "backdropUrl": "https://example.com/…",
        "badges": [
          {}
        ],
        "bookProgress": {
          "bookId": "id_8h2k4q",
          "chapter": {},
          "durationMs": 1800000,
          "itemId": "id_8h2k4q",
          "partPositionMs": 1800000,
          "positionMs": 1800000,
          "remainingMs": 1800000
        },
        "contentRating": "string",
        "count": 0,
        "country": "string",
        "dateBased": true,
        "discNumber": 0,
        "displayTitle": "Fargo",
        "durationMs": 1800000,
        "edition": "string",
        "episodeNumber": 0,
        "favorite": true,
        "genres": [
          "string"
        ],
        "hidden": true,
        "homeActions": {
          "collection": true,
          "delete": true,
          "details": true,
          "download": true,
          "editMetadata": true,
          "favorite": true,
          "myList": true,
          "notInterested": true,
          "play": true,
          "played": true,
          "playlist": true,
          "queue": true,
          "rating": true,
          "refreshMetadata": true,
          "removeFromContinue": true,
          "selection": {},
          "state": {},
          "watched": true
        },
        "homeTitleContext": {
          "genres": [],
          "kind": "string",
          "seasonCount": 0,
          "year": 0
        },
        "id": "id_8h2k4q",
        "kind": "string",
        "label": "string",
        "language": "en",
        "lastChanged": "string",
        "latestEpisode": {
          "airDate": "string",
          "count": 0,
          "episodeNumber": 0,
          "seasonNumber": 0,
          "title": "Fargo"
        },
        "libraryId": "id_8h2k4q",
        "media": {
          "absoluteNumber": 0,
          "activeBeginYear": 0,
          "activeEndYear": 0,
          "addedAt": "2026-10-18T19:30:00Z",
          "airDate": "string",
          "album": {},
          "albumCount": 0,
          "albumType": "string",
          "artist": {},
          "artistType": "string",
          "artworkPaths": [],
          "audioFacts": {},
          "author": "string",
          "available": true,
          "backdropUrl": "https://example.com/…",
          "badges": [],
          "bookProgress": {},
          "contentRating": "string",
          "count": 0,
          "country": "string",
          "dateBased": true,
          "discNumber": 0,
          "displayTitle": "Fargo",
          "durationMs": 1800000,
          "edition": "string",
          "episodeNumber": 0,
          "favorite": true,
          "genres": [],
          "homeActions": {},
          "homeTitleContext": {},
          "id": "id_8h2k4q",
          "kind": "string",
          "label": "string",
          "language": "en",
          "lastChanged": "string",
          "latestEpisode": {},
          "libraryId": "id_8h2k4q",
          "missing": true,
          "narrators": [],
          "navigation": {},
          "new": true,
          "origin": "string",
          "overview": "string",
          "overviewSource": "string",
          "overviewSourceUrl": "https://example.com/…",
          "pageCount": 0,
          "pinned": true,
          "playback": {},
          "plays": 0,
          "posterUrl": "https://example.com/…",
          "progressMs": 1800000,
          "publicationType": "book",
          "publishedYear": 0,
          "publisher": "string",
          "radioSeed": {},
          "rating": 0,
          "readingMark": {},
          "releaseDate": "string",
          "removed": true,
          "resolution": "string",
          "role": "string",
          "seasonCount": 0,
          "seasonNumber": 0,
          "series": [],
          "show": {},
          "sortLetter": "string",
          "special": true,
          "stillUrl": "https://example.com/…",
          "subtitle": "Fargo",
          "title": "Fargo",
          "totalAtLeast": 0,
          "trackNumber": 0,
          "unwatchedCount": 0,
          "userRating": 0,
          "watched": true,
          "watchedCount": 0,
          "watchlisted": true,
          "year": 0,
          "yearMax": 0,
          "yearMin": 0
        },
        "missing": true,
        "narrators": [
          "string"
        ],
        "navigation": {
          "browse": {},
          "category": "string",
          "channelId": "id_8h2k4q",
          "entityId": "id_8h2k4q",
          "provenance": "string",
          "sourceId": "id_8h2k4q",
          "view": "string"
        },
        "new": true,
        "origin": "string",
        "overview": "string",
        "overviewSource": "string",
        "overviewSourceUrl": "https://example.com/…",
        "pageCount": 0,
        "pinned": true,
        "playback": {
          "itemId": "id_8h2k4q",
          "startMs": 1800000
        },
        "plays": 0,
        "posterUrl": "https://example.com/…",
        "progressMs": 1800000,
        "publicationType": "book",
        "publishedYear": 0,
        "publisher": "string",
        "radioSeed": {
          "id": "id_8h2k4q",
          "kind": "string"
        },
        "rating": 0,
        "readingMark": {
          "itemId": "id_8h2k4q",
          "read": true,
          "revision": 0
        },
        "releaseDate": "string",
        "removed": true,
        "resolution": "string",
        "role": "string",
        "seasonCount": 0,
        "seasonNumber": 0,
        "series": [
          {}
        ],
        "show": {
          "id": "id_8h2k4q",
          "name": "Fargo"
        },
        "sortLetter": "string",
        "special": true,
        "stillUrl": "https://example.com/…",
        "subtitle": "Fargo",
        "title": "Fargo",
        "totalAtLeast": 0,
        "trackNumber": 0,
        "unwatchedCount": 0,
        "userRating": 0,
        "watched": true,
        "watchedCount": 0,
        "watchlisted": true,
        "year": 0,
        "yearMax": 0,
        "yearMin": 0
      },
      "reason": "string",
      "score": 0,
      "source": "string"
    }
  ],
  "revision": {
    "catalog": 0,
    "viewer": 0
  },
  "total": 0
}

Schema

generatedAtstringrequired
itemsarray of objectrequired
- entryobjectrequired
  - absoluteNumberinteger
  - activeBeginYearinteger
  - activeEndYearinteger
  - addedAtstring | any | null
  - airDatestring
  - albumobject
    idstringrequired
    namestringrequired
  - albumCountinteger
  - albumTypestring
  - artistobject
    idstringrequired
    namestringrequired
  - artistTypestring
  - artworkPathsarray of string
  - audioFactsobject
    atmosboolean
    bitDepthinteger
    channelsinteger
    codecstringrequired
    layoutstring
    losslessboolean
    sampleRateinteger
  - authorstring
  - availableboolean
  - backdropUrlstring
  - badgesarray of object0–2 items
    bitDepthintegerrequired≥ 17
    codecstringrequiredpattern ^[A-Za-z0-9_.+-]{1,64}$
    sampleRateintegerrequired≥ 1
    variant"lossless"required
  - bookProgressobject
    bookIdstringrequired
    chapterobject
    endMsintegerrequired
    indexintegerrequired
    startMsintegerrequired
    titlestringrequired
    durationMsinteger
    itemIdstringrequired
    partPositionMsintegerrequired
    positionMsinteger
    remainingMsinteger
  - contentRatingstring
  - countinteger
  - countrystring
  - dateBasedboolean
  - discNumberinteger
  - displayTitlestring
  - durationMsinteger≥ 0
  - editionstring
  - episodeNumberinteger
  - favoriteboolean
  - genresarray of string
  - hiddenboolean | any | null
  - homeActionsobject
    collectionbooleanrequired
    deletebooleanrequired
    detailsbooleanrequired
    downloadbooleanrequired
    editMetadatabooleanrequired
    favoritebooleanrequired
    myListbooleanrequired
    notInterestedboolean
    playbooleanrequired
    playedbooleanrequired
    playlistbooleanrequired
    queuebooleanrequired
    ratingbooleanrequired
    refreshMetadatabooleanrequired
    removeFromContinueboolean
    selectionobjectrequired
    collectionbooleanrequired
    deletebooleanrequired
    downloadbooleanrequired
    editbooleanrequired
    favoritebooleanrequired
    myListbooleanrequired
    playbooleanrequired
    playlistbooleanrequired
    queuebooleanrequired
    refreshbooleanrequired
    watchedbooleanrequired
    stateobjectrequired
    containerRevisionintegerrequired
    favoritebooleanrequired
    personalRevisionintegerrequired
    ratingnumber | any | nullrequired
    watchedbooleanrequired
    watchlistedbooleanrequired
    watchedbooleanrequired
  - homeTitleContextobject
    genresarray of stringrequired
    kindstringrequired
    seasonCountinteger
    yearinteger
  - idstringrequired
  - kindstringrequired
  - labelstring
  - languagestring
  - lastChangedstring
  - latestEpisodeobject
    airDatestringrequired
    countintegerrequired
    episodeNumberintegerrequired
    seasonNumberinteger
    titlestring
  - libraryIdstring
  - mediaobject
    absoluteNumberinteger
    activeBeginYearinteger
    activeEndYearinteger
    addedAtstring | any | nullrequired
    airDatestring
    albumobject
    idstringrequired
    namestringrequired
    albumCountinteger
    albumTypestring
    artistobject
    idstringrequired
    namestringrequired
    artistTypestring
    artworkPathsarray of string
    audioFactsobject
    atmosboolean
    bitDepthinteger
    channelsinteger
    codecstringrequired
    layoutstring
    losslessboolean
    sampleRateinteger
    authorstring
    availableboolean
    backdropUrlstring
    badgesarray of object0–2 items
    bitDepthintegerrequired≥ 17
    codecstringrequiredpattern ^[A-Za-z0-9_.+-]{1,64}$
    sampleRateintegerrequired≥ 1
    variant"lossless"required
    bookProgressobject
    bookIdstringrequired
    chapterobject
    endMsintegerrequired
    indexintegerrequired
    startMsintegerrequired
    titlestringrequired
    durationMsinteger
    itemIdstringrequired
    partPositionMsintegerrequired
    positionMsinteger
    remainingMsinteger
    contentRatingstring
    countinteger
    countrystring
    dateBasedboolean
    discNumberinteger
    displayTitlestring
    durationMsinteger≥ 0
    editionstring
    episodeNumberinteger
    favoriteboolean
    genresarray of string
    homeActionsobject
    collectionbooleanrequired
    deletebooleanrequired
    detailsbooleanrequired
    downloadbooleanrequired
    editMetadatabooleanrequired
    favoritebooleanrequired
    myListbooleanrequired
    notInterestedboolean
    playbooleanrequired
    playedbooleanrequired
    playlistbooleanrequired
    queuebooleanrequired
    ratingbooleanrequired
    refreshMetadatabooleanrequired
    removeFromContinueboolean
    selectionobjectrequired
    collectionbooleanrequired
    deletebooleanrequired
    downloadbooleanrequired
    editbooleanrequired
    favoritebooleanrequired
    myListbooleanrequired
    playbooleanrequired
    playlistbooleanrequired
    queuebooleanrequired
    refreshbooleanrequired
    watchedbooleanrequired
    stateobjectrequired
    containerRevisionintegerrequired
    favoritebooleanrequired
    personalRevisionintegerrequired
    ratingnumber | any | nullrequired
    watchedbooleanrequired
    watchlistedbooleanrequired
    watchedbooleanrequired
    homeTitleContextobject
    genresarray of stringrequired
    kindstringrequired
    seasonCountinteger
    yearinteger
    idstringrequired
    kindstringrequired
    labelstring
    languagestring
    lastChangedstring
    latestEpisodeobject
    airDatestringrequired
    countintegerrequired
    episodeNumberintegerrequired
    seasonNumberinteger
    titlestring
    libraryIdstring
    missingbooleanrequired
    narratorsarray of string
    navigationobject
    browseobject
    pivotstringrequiredlength 1–256
    queryobject
    sortarray of objectrequired0–1 items
    directionstringrequiredone of "asc", "desc"
    fieldstringrequired
    categorystring
    channelIdstring
    entityIdstring
    provenancestring
    sourceIdstring
    viewstringrequired
    newboolean
    originstring
    overviewstring
    overviewSourcestring
    overviewSourceUrlstring
    pageCountinteger
    pinnedboolean
    playbackobject
    itemIdstringrequired
    startMsinteger≥ 0
    playsinteger
    posterUrlstring
    progressMsinteger≥ 0
    publicationTypestringone of "book", "magazine", "newspaper"
    publishedYearinteger
    publisherstring
    radioSeedobject
    idstringrequired
    kindstringrequired
    ratingnumber
    readingMarkobject
    itemIdstringrequired
    readbooleanrequired
    revisionintegerrequired
    releaseDatestring
    removedboolean
    resolutionstring
    rolestring
    seasonCountinteger
    seasonNumberinteger
    seriesarray of object
    namestringrequired
    positionstring
    showobject
    idstringrequired
    namestringrequired
    sortLetterstring
    specialboolean
    stillUrlstring
    subtitlestring
    titlestringrequired
    totalAtLeastinteger
    trackNumberinteger
    unwatchedCountinteger
    userRatinginteger | any | null
    watchedboolean
    watchedCountinteger
    watchlistedboolean
    yearinteger
    yearMaxinteger
    yearMininteger
  - missingboolean
  - narratorsarray of string
  - navigationobject
    browseobject
    pivotstringrequiredlength 1–256
    queryobject
    sortarray of objectrequired0–1 items
    directionstringrequiredone of "asc", "desc"
    fieldstringrequired
    categorystring
    channelIdstring
    entityIdstring
    provenancestring
    sourceIdstring
    viewstringrequired
  - newboolean
  - originstring
  - overviewstring
  - overviewSourcestring
  - overviewSourceUrlstring
  - pageCountinteger
  - pinnedboolean
  - playbackobject
    itemIdstringrequired
    startMsinteger≥ 0
  - playsinteger
  - posterUrlstring
  - progressMsinteger≥ 0
  - publicationTypestringone of "book", "magazine", "newspaper"
  - publishedYearinteger
  - publisherstring
  - radioSeedobject
    idstringrequired
    kindstringrequired
  - ratingnumber
  - readingMarkobject
    itemIdstringrequired
    readbooleanrequired
    revisionintegerrequired
  - releaseDatestring
  - removedboolean
  - resolutionstring
  - rolestring
  - seasonCountinteger
  - seasonNumberinteger
  - seriesarray of object
    namestringrequired
    positionstring
  - showobject
    idstringrequired
    namestringrequired
  - sortLetterstring
  - specialboolean
  - stillUrlstring
  - subtitlestring
  - titlestring
  - totalAtLeastinteger
  - trackNumberinteger
  - unwatchedCountinteger
  - userRatinginteger | any | null
  - watchedboolean
  - watchedCountinteger
  - watchlistedboolean
  - yearinteger
  - yearMaxinteger
  - yearMininteger
- reasonstringrequired
- scorenumberrequired
- sourcestringrequired
revisionobjectrequired
- catalogintegerrequired
- viewerintegerrequired
totalintegerrequired

defaultRequest refused or unavailableapplication/json

Example

{
  "error": {
    "code": "string",
    "message": "string"
  }
}

Schema

errorobjectrequired
- codestringrequired
- messagestringrequired

Error codesinvalid_requestunauthorizednot_permittednot_foundinternaldatabase_busy

Example request

curl -X GET "http://127.0.0.1:32500/v1/suggestions" \
  -H "Authorization: Bearer $PORTICO_API_KEY"