Saved Resources

Generated saved resources operations.

GET/v1/saved-resourcesRead saved resourcesread

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

Parameters

Name	In	Type
`cursor`	query	`string`
`kind`	query	`string`
`pinned`	query	`string`
`shape`	query	`string`
`limit`	query	`integer`1–100

Responses

200Successapplication/json

Example

{
  "nextCursor": "eyJvIjoyMH0",
  "resources": [
    {
      "actions": [
        "string"
      ],
      "artworkPaths": [
        "string"
      ],
      "definition": {
        "libraryId": "id_8h2k4q",
        "pivot": "string",
        "presentation": "string",
        "query": {
          "field": "releaseDate",
          "operator": "within-last-days",
          "value": 1,
          "variant": "relative"
        },
        "sort": [
          {}
        ]
      },
      "entryCount": 0,
      "id": "id_8h2k4q",
      "invalidComponents": [
        "string"
      ],
      "kind": "string",
      "name": "Fargo",
      "onHome": true,
      "pinRevision": 0,
      "pinned": true,
      "revision": 0,
      "role": "string",
      "samples": [
        {
          "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": [],
          "hidden": true,
          "homeActions": {},
          "homeTitleContext": {},
          "id": "id_8h2k4q",
          "kind": "string",
          "label": "string",
          "language": "en",
          "lastChanged": "string",
          "latestEpisode": {},
          "libraryId": "id_8h2k4q",
          "media": {},
          "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
        }
      ],
      "serverId": "id_8h2k4q",
      "shape": "string",
      "shares": [
        {
          "accountId": "id_8h2k4q",
          "authority": "string",
          "displayName": "Fargo",
          "profileId": "id_8h2k4q",
          "role": "string"
        }
      ],
      "status": "string",
      "summary": "string",
      "totalIsLowerBound": true,
      "viewerFence": "string",
      "visibility": "string"
    }
  ],
  "revision": 0,
  "serverId": "id_8h2k4q",
  "shapeCounts": {
    "posters": 0,
    "squares": 0
  },
  "viewerFence": "string"
}

Schema

nextCursorstringrequired
resourcesarray of objectrequired
- actionsarray of stringrequired
- artworkPathsarray of stringrequired
- definitionobject
  - libraryIdstringrequired
  - pivotstringrequired
  - presentationstringrequired
  - queryobject | any | nullrequired
    fieldstringrequiredone of "releaseDate", "dateAdded", "lastPlayedAt"
    operatorstringrequiredone of "within-last-days"
    valueintegerrequired1–36500
    variant"relative"required
  - sortarray of objectrequired
    directionstringrequired
    fieldstringrequired
    seedinteger
- entryCountintegerrequired
- idstringrequired
- invalidComponentsarray of stringrequired
- kindstringrequired
- namestringrequired
- onHomebooleanrequired
- pinRevisionintegerrequired
- pinnedbooleanrequired
- revisionintegerrequired
- rolestringrequired
- samplesarray of objectrequired
  - 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
- serverIdstringrequired
- shapestringrequired
- sharesarray of object
  - accountIdstringrequired
  - authoritystringrequired
  - displayNamestringrequired
  - profileIdstringrequired
  - rolestringrequired
- statusstringrequired
- summarystringrequired
- totalIsLowerBoundboolean
- viewerFencestringrequired
- visibilitystringrequired
revisionintegerrequired
serverIdstringrequired
shapeCountsobjectrequired
- postersintegerrequired
- squaresintegerrequired
viewerFencestringrequired

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/saved-resources" \
  -H "Authorization: Bearer $PORTICO_API_KEY"

POST/v1/saved-resourcesRun saved resourcesplayback

Audience: Clients · Native API
Authorization: API key or personal access token with the playback scope, or a signed-in session
OpenAPI operation ID: post_saved_resources
Max body: 64 KiB

Parameters

Name	In	Type	Description
`Idempotency-Key`	header	`string`
`Portico-Mutation-Root`	header	`string`

Request body application/json · required

Example

{
  "accountId": "id_8h2k4q",
  "addItemIds": [
    "string"
  ],
  "afterEntryId": "id_8h2k4q",
  "authority": "string",
  "definition": {
    "libraryId": "id_8h2k4q",
    "pivot": "string",
    "presentation": "string",
    "query": {
      "field": "releaseDate",
      "operator": "within-last-days",
      "value": 1,
      "variant": "relative"
    },
    "sort": [
      {
        "direction": "string",
        "field": "string",
        "seed": 0
      }
    ]
  },
  "entryIds": [
    "string"
  ],
  "expectedRevision": 0,
  "kind": "string",
  "name": "Fargo",
  "operationId": "id_8h2k4q",
  "profileId": "id_8h2k4q",
  "removeEntryIds": [
    "string"
  ],
  "role": "string",
  "summary": "string",
  "undoToken": "string",
  "visibility": "string"
}

Schema

accountIdstring
addItemIdsarray of string
afterEntryIdstring
authoritystring
definitionobject
- libraryIdstringrequired
- pivotstringrequired
- presentationstringrequired
- queryobject | any | nullrequired
  - fieldstringrequiredone of "releaseDate", "dateAdded", "lastPlayedAt"
  - operatorstringrequiredone of "within-last-days"
  - valueintegerrequired1–36500
  - variant"relative"required
- sortarray of objectrequired
  - directionstringrequired
  - fieldstringrequired
  - seedinteger
entryIdsarray of string
expectedRevisionintegerrequired
kindstring
namestring
operationIdstringrequired
profileIdstring
removeEntryIdsarray of string
rolestring
summarystring
undoTokenstring
visibilitystring

Responses

200Successapplication/json

Example

{
  "current": {
    "deleted": true,
    "resourceId": "id_8h2k4q",
    "revision": 0
  },
  "receipt": {
    "deleted": true,
    "entries": {
      "added": [
        "string"
      ],
      "failed": [
        {
          "code": "string",
          "itemId": "id_8h2k4q"
        }
      ],
      "removed": [
        "string"
      ],
      "unchanged": [
        "string"
      ]
    },
    "operationId": "id_8h2k4q",
    "resourceId": "id_8h2k4q",
    "revision": 0,
    "undoToken": "string",
    "undoUntil": "string"
  },
  "receiptLifetimeMs": 1800000,
  "serverId": "id_8h2k4q",
  "viewerFence": "string"
}

Schema

currentobject
- deletedbooleanrequired
- resourceIdstringrequired
- revisionintegerrequired
receiptobjectrequired
- deletedbooleanrequired
- entriesobject
  - addedarray of stringrequired
  - failedarray of objectrequired
    codestringrequired
    itemIdstringrequired
  - removedarray of stringrequired
  - unchangedarray of stringrequired
- operationIdstringrequired
- resourceIdstringrequired
- revisionintegerrequired
- undoTokenstring
- undoUntilstring
receiptLifetimeMsintegerrequired
serverIdstringrequired
viewerFencestringrequired

defaultRequest refused or unavailableapplication/json

Example

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

Schema

errorobjectrequired
- codestringrequired
- messagestringrequired

Error codesinvalid_requestunauthorizednot_permittednot_foundinternalidempotency_conflictreceipt_expiredinvalid_mutation_keydatabase_busywriter_capacity

Example request

curl -X POST "http://127.0.0.1:32500/v1/saved-resources" \
  -H "Authorization: Bearer $PORTICO_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "accountId": "id_8h2k4q",
  "addItemIds": [
    "string"
  ],
  "afterEntryId": "id_8h2k4q",
  "authority": "string",
  "definition": {
    "libraryId": "id_8h2k4q",
    "pivot": "string",
    "presentation": "string",
    "query": {
      "field": "releaseDate",
      "operator": "within-last-days",
      "value": 1,
      "variant": "relative"
    },
    "sort": [
      {
        "direction": "string",
        "field": "string",
        "seed": 0
      }
    ]
  },
  "entryIds": [
    "string"
  ],
  "expectedRevision": 0,
  "kind": "string",
  "name": "Fargo",
  "operationId": "id_8h2k4q",
  "profileId": "id_8h2k4q",
  "removeEntryIds": [
    "string"
  ],
  "role": "string",
  "summary": "string",
  "undoToken": "string",
  "visibility": "string"
}'

DELETE/v1/saved-resources/{id}Remove saved resourcesplayback

Audience: Clients · Native API
Authorization: API key or personal access token with the playback scope, or a signed-in session
OpenAPI operation ID: delete_saved_resources_id
Max body: 64 KiB

Parameters

Name	In	Type
`id`required	path	`string`
`Idempotency-Key`	header	`string`
`Portico-Mutation-Root`	header	`string`

Request body application/json · required

Example

{
  "accountId": "id_8h2k4q",
  "addItemIds": [
    "string"
  ],
  "afterEntryId": "id_8h2k4q",
  "authority": "string",
  "definition": {
    "libraryId": "id_8h2k4q",
    "pivot": "string",
    "presentation": "string",
    "query": {
      "field": "releaseDate",
      "operator": "within-last-days",
      "value": 1,
      "variant": "relative"
    },
    "sort": [
      {
        "direction": "string",
        "field": "string",
        "seed": 0
      }
    ]
  },
  "entryIds": [
    "string"
  ],
  "expectedRevision": 0,
  "kind": "string",
  "name": "Fargo",
  "operationId": "id_8h2k4q",
  "profileId": "id_8h2k4q",
  "removeEntryIds": [
    "string"
  ],
  "role": "string",
  "summary": "string",
  "undoToken": "string",
  "visibility": "string"
}

Schema

accountIdstring
addItemIdsarray of string
afterEntryIdstring
authoritystring
definitionobject
- libraryIdstringrequired
- pivotstringrequired
- presentationstringrequired
- queryobject | any | nullrequired
  - fieldstringrequiredone of "releaseDate", "dateAdded", "lastPlayedAt"
  - operatorstringrequiredone of "within-last-days"
  - valueintegerrequired1–36500
  - variant"relative"required
- sortarray of objectrequired
  - directionstringrequired
  - fieldstringrequired
  - seedinteger
entryIdsarray of string
expectedRevisionintegerrequired
kindstring
namestring
operationIdstringrequired
profileIdstring
removeEntryIdsarray of string
rolestring
summarystring
undoTokenstring
visibilitystring

Responses

200Successapplication/json

Example

{
  "current": {
    "deleted": true,
    "resourceId": "id_8h2k4q",
    "revision": 0
  },
  "receipt": {
    "deleted": true,
    "entries": {
      "added": [
        "string"
      ],
      "failed": [
        {
          "code": "string",
          "itemId": "id_8h2k4q"
        }
      ],
      "removed": [
        "string"
      ],
      "unchanged": [
        "string"
      ]
    },
    "operationId": "id_8h2k4q",
    "resourceId": "id_8h2k4q",
    "revision": 0,
    "undoToken": "string",
    "undoUntil": "string"
  },
  "receiptLifetimeMs": 1800000,
  "serverId": "id_8h2k4q",
  "viewerFence": "string"
}

Schema

currentobject
- deletedbooleanrequired
- resourceIdstringrequired
- revisionintegerrequired
receiptobjectrequired
- deletedbooleanrequired
- entriesobject
  - addedarray of stringrequired
  - failedarray of objectrequired
    codestringrequired
    itemIdstringrequired
  - removedarray of stringrequired
  - unchangedarray of stringrequired
- operationIdstringrequired
- resourceIdstringrequired
- revisionintegerrequired
- undoTokenstring
- undoUntilstring
receiptLifetimeMsintegerrequired
serverIdstringrequired
viewerFencestringrequired

defaultRequest refused or unavailableapplication/json

Example

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

Schema

errorobjectrequired
- codestringrequired
- messagestringrequired

Error codesinvalid_requestunauthorizednot_permittednot_foundrevision_mismatchinternalidempotency_conflictreceipt_expiredinvalid_mutation_keydatabase_busywriter_capacity

Example request

curl -X DELETE "http://127.0.0.1:32500/v1/saved-resources/{id}" \
  -H "Authorization: Bearer $PORTICO_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "accountId": "id_8h2k4q",
  "addItemIds": [
    "string"
  ],
  "afterEntryId": "id_8h2k4q",
  "authority": "string",
  "definition": {
    "libraryId": "id_8h2k4q",
    "pivot": "string",
    "presentation": "string",
    "query": {
      "field": "releaseDate",
      "operator": "within-last-days",
      "value": 1,
      "variant": "relative"
    },
    "sort": [
      {
        "direction": "string",
        "field": "string",
        "seed": 0
      }
    ]
  },
  "entryIds": [
    "string"
  ],
  "expectedRevision": 0,
  "kind": "string",
  "name": "Fargo",
  "operationId": "id_8h2k4q",
  "profileId": "id_8h2k4q",
  "removeEntryIds": [
    "string"
  ],
  "role": "string",
  "summary": "string",
  "undoToken": "string",
  "visibility": "string"
}'

GET/v1/saved-resources/{id}Read saved resourcesread

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

Parameters

Name	In	Type	Description
`id`required	path	`string`

Responses

200Successapplication/json

Example

{
  "actions": [
    "string"
  ],
  "definition": {
    "libraryId": "id_8h2k4q",
    "pivot": "string",
    "presentation": "string",
    "query": {
      "field": "releaseDate",
      "operator": "within-last-days",
      "value": 1,
      "variant": "relative"
    },
    "sort": [
      {
        "direction": "string",
        "field": "string",
        "seed": 0
      }
    ]
  },
  "entryCount": 0,
  "id": "id_8h2k4q",
  "invalidComponents": [
    "string"
  ],
  "kind": "string",
  "name": "Fargo",
  "pinRevision": 0,
  "pinned": true,
  "revision": 0,
  "role": "string",
  "serverId": "id_8h2k4q",
  "shares": [
    {
      "accountId": "id_8h2k4q",
      "authority": "string",
      "displayName": "Fargo",
      "profileId": "id_8h2k4q",
      "role": "string"
    }
  ],
  "status": "string",
  "summary": "string",
  "viewerFence": "string",
  "visibility": "string"
}

Schema

actionsarray of stringrequired
definitionobject
- libraryIdstringrequired
- pivotstringrequired
- presentationstringrequired
- queryobject | any | nullrequired
  - fieldstringrequiredone of "releaseDate", "dateAdded", "lastPlayedAt"
  - operatorstringrequiredone of "within-last-days"
  - valueintegerrequired1–36500
  - variant"relative"required
- sortarray of objectrequired
  - directionstringrequired
  - fieldstringrequired
  - seedinteger
entryCountintegerrequired
idstringrequired
invalidComponentsarray of stringrequired
kindstringrequired
namestringrequired
pinRevisionintegerrequired
pinnedbooleanrequired
revisionintegerrequired
rolestringrequired
serverIdstringrequired
sharesarray of object
- accountIdstringrequired
- authoritystringrequired
- displayNamestringrequired
- profileIdstringrequired
- rolestringrequired
statusstringrequired
summarystringrequired
viewerFencestringrequired
visibilitystringrequired

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/saved-resources/{id}" \
  -H "Authorization: Bearer $PORTICO_API_KEY"

PATCH/v1/saved-resources/{id}Change saved resourcesplayback

Audience: Clients · Native API
Authorization: API key or personal access token with the playback scope, or a signed-in session
OpenAPI operation ID: patch_saved_resources_id
Max body: 64 KiB

Parameters

Name	In	Type
`id`required	path	`string`
`Idempotency-Key`	header	`string`
`Portico-Mutation-Root`	header	`string`

Request body application/json · required

Example

{
  "accountId": "id_8h2k4q",
  "addItemIds": [
    "string"
  ],
  "afterEntryId": "id_8h2k4q",
  "authority": "string",
  "definition": {
    "libraryId": "id_8h2k4q",
    "pivot": "string",
    "presentation": "string",
    "query": {
      "field": "releaseDate",
      "operator": "within-last-days",
      "value": 1,
      "variant": "relative"
    },
    "sort": [
      {
        "direction": "string",
        "field": "string",
        "seed": 0
      }
    ]
  },
  "entryIds": [
    "string"
  ],
  "expectedRevision": 0,
  "kind": "string",
  "name": "Fargo",
  "operationId": "id_8h2k4q",
  "profileId": "id_8h2k4q",
  "removeEntryIds": [
    "string"
  ],
  "role": "string",
  "summary": "string",
  "undoToken": "string",
  "visibility": "string"
}

Schema

accountIdstring
addItemIdsarray of string
afterEntryIdstring
authoritystring
definitionobject
- libraryIdstringrequired
- pivotstringrequired
- presentationstringrequired
- queryobject | any | nullrequired
  - fieldstringrequiredone of "releaseDate", "dateAdded", "lastPlayedAt"
  - operatorstringrequiredone of "within-last-days"
  - valueintegerrequired1–36500
  - variant"relative"required
- sortarray of objectrequired
  - directionstringrequired
  - fieldstringrequired
  - seedinteger
entryIdsarray of string
expectedRevisionintegerrequired
kindstring
namestring
operationIdstringrequired
profileIdstring
removeEntryIdsarray of string
rolestring
summarystring
undoTokenstring
visibilitystring

Responses

200Successapplication/json

Example

{
  "current": {
    "deleted": true,
    "resourceId": "id_8h2k4q",
    "revision": 0
  },
  "receipt": {
    "deleted": true,
    "entries": {
      "added": [
        "string"
      ],
      "failed": [
        {
          "code": "string",
          "itemId": "id_8h2k4q"
        }
      ],
      "removed": [
        "string"
      ],
      "unchanged": [
        "string"
      ]
    },
    "operationId": "id_8h2k4q",
    "resourceId": "id_8h2k4q",
    "revision": 0,
    "undoToken": "string",
    "undoUntil": "string"
  },
  "receiptLifetimeMs": 1800000,
  "serverId": "id_8h2k4q",
  "viewerFence": "string"
}

Schema

currentobject
- deletedbooleanrequired
- resourceIdstringrequired
- revisionintegerrequired
receiptobjectrequired
- deletedbooleanrequired
- entriesobject
  - addedarray of stringrequired
  - failedarray of objectrequired
    codestringrequired
    itemIdstringrequired
  - removedarray of stringrequired
  - unchangedarray of stringrequired
- operationIdstringrequired
- resourceIdstringrequired
- revisionintegerrequired
- undoTokenstring
- undoUntilstring
receiptLifetimeMsintegerrequired
serverIdstringrequired
viewerFencestringrequired

defaultRequest refused or unavailableapplication/json

Example

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

Schema

errorobjectrequired
- codestringrequired
- messagestringrequired

Error codesinvalid_requestunauthorizednot_permittednot_foundrevision_mismatchinternalidempotency_conflictreceipt_expiredinvalid_mutation_keydatabase_busywriter_capacity

Example request

curl -X PATCH "http://127.0.0.1:32500/v1/saved-resources/{id}" \
  -H "Authorization: Bearer $PORTICO_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "accountId": "id_8h2k4q",
  "addItemIds": [
    "string"
  ],
  "afterEntryId": "id_8h2k4q",
  "authority": "string",
  "definition": {
    "libraryId": "id_8h2k4q",
    "pivot": "string",
    "presentation": "string",
    "query": {
      "field": "releaseDate",
      "operator": "within-last-days",
      "value": 1,
      "variant": "relative"
    },
    "sort": [
      {
        "direction": "string",
        "field": "string",
        "seed": 0
      }
    ]
  },
  "entryIds": [
    "string"
  ],
  "expectedRevision": 0,
  "kind": "string",
  "name": "Fargo",
  "operationId": "id_8h2k4q",
  "profileId": "id_8h2k4q",
  "removeEntryIds": [
    "string"
  ],
  "role": "string",
  "summary": "string",
  "undoToken": "string",
  "visibility": "string"
}'

GET/v1/saved-resources/{id}/contentRead or update the selected projectionread

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

Parameters

Name	In	Type
`id`required	path	`string`
`cursor`	query	`string`
`limit`	query	`integer`1–100
`sort`	query	`string`
`direction`	query	`string`
`filter`	query	`string`

Responses

200Successapplication/json

Example

{
  "browse": {
    "applied": {
      "query": {
        "field": "releaseDate",
        "operator": "within-last-days",
        "value": 1,
        "variant": "relative"
      },
      "seek": {
        "prefix": "string"
      },
      "sort": [
        {
          "direction": "string",
          "field": "string",
          "seed": 0
        }
      ]
    },
    "displayTargets": [
      {
        "entryId": "id_8h2k4q",
        "membershipId": "id_8h2k4q"
      }
    ],
    "entries": [
      {
        "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
      }
    ],
    "pageInfo": {
      "durationIsLowerBound": true,
      "durationMs": 1800000,
      "hasMore": true,
      "nextCursor": "eyJvIjoyMH0",
      "revision": "r12",
      "start": 0,
      "total": 0,
      "totalIsLowerBound": true
    },
    "pivot": "string",
    "positionIndex": [
      {
        "index": 0,
        "key": "string"
      }
    ],
    "wholeSelection": {
      "catalogRevision": "r12",
      "selector": {
        "query": {
          "filter": null,
          "libraryId": "id_8h2k4q",
          "pivot": "string",
          "selectionBasis": "string",
          "sort": []
        }
      },
      "total": 0,
      "types": [
        {
          "capabilityCounts": {},
          "count": 0,
          "kind": "string",
          "libraries": []
        }
      ],
      "unavailableActions": {
        "delete": "unsupported-sort",
        "metadataPreview": "preview-limit",
        "play": "unsupported-sort",
        "playlist": "unsupported-sort",
        "queue": "unsupported-sort"
      }
    },
    "wholeSelectionPreparing": {
      "kind": "browse-selection-preparing",
      "queryId": "id_8h2k4q",
      "retryAfterMs": 1800000,
      "state": "preparing",
      "variant": "preparing"
    },
    "wholeSelectionUnavailable": {
      "reason": "search_not_bounded"
    }
  },
  "entries": [
    {
      "hidden": true,
      "id": "id_8h2k4q",
      "media": {
        "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
      }
    }
  ],
  "filters": [
    {
      "id": "id_8h2k4q",
      "labelKey": "string",
      "options": [
        {
          "count": 0,
          "id": "id_8h2k4q",
          "label": "string"
        }
      ]
    }
  ],
  "nextCursor": "eyJvIjoyMH0",
  "order": {
    "last": "string",
    "next": "string",
    "previous": "string"
  },
  "query": {
    "category": "string",
    "direction": "string",
    "limit": 0,
    "q": "string",
    "searchMode": "string",
    "sort": "string"
  },
  "resource": {
    "actions": [
      "string"
    ],
    "definition": {
      "libraryId": "id_8h2k4q",
      "pivot": "string",
      "presentation": "string",
      "query": {
        "field": "releaseDate",
        "operator": "within-last-days",
        "value": 1,
        "variant": "relative"
      },
      "sort": [
        {
          "direction": "string",
          "field": "string",
          "seed": 0
        }
      ]
    },
    "entryCount": 0,
    "id": "id_8h2k4q",
    "invalidComponents": [
      "string"
    ],
    "kind": "string",
    "name": "Fargo",
    "pinRevision": 0,
    "pinned": true,
    "revision": 0,
    "role": "string",
    "serverId": "id_8h2k4q",
    "shares": [
      {
        "accountId": "id_8h2k4q",
        "authority": "string",
        "displayName": "Fargo",
        "profileId": "id_8h2k4q",
        "role": "string"
      }
    ],
    "status": "string",
    "summary": "string",
    "viewerFence": "string",
    "visibility": "string"
  },
  "sorts": [
    {
      "directions": [
        "string"
      ],
      "id": "id_8h2k4q",
      "labelKey": "string"
    }
  ],
  "start": 0,
  "totalCount": 0
}

Schema

browseobject
- appliedobjectrequired
  - queryobject | any | nullrequired
    fieldstringrequiredone of "releaseDate", "dateAdded", "lastPlayedAt"
    operatorstringrequiredone of "within-last-days"
    valueintegerrequired1–36500
    variant"relative"required
  - seekobject
    prefixstringrequired
  - sortarray of objectrequired
    directionstringrequired
    fieldstringrequired
    seedinteger
- displayTargetsarray of object
  - entryIdstringrequired
  - membershipIdstringrequired
- entriesarray of objectrequired
  - 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
- pageInfoobjectrequired
  - durationIsLowerBoundbooleanrequired
  - durationMsintegerrequired
  - hasMorebooleanrequired
  - nextCursorstringrequired
  - revisionstringrequired
  - startintegerrequired
  - totalintegerrequired
  - totalIsLowerBoundbooleanrequired
- pivotstringrequired
- positionIndexarray of objectrequired
  - indexintegerrequired
  - keystringrequired
- wholeSelectionobject
  - catalogRevisionstringrequired
  - selectorobjectrequired
    queryobjectrequired
    filterany
    libraryIdstringrequired
    pivotstringrequired
    selectionBasisstringpattern ^[a-f0-9]{64}$
    sortarray of object
    directionstringrequired
    fieldstringrequired
    seedinteger
  - totalintegerrequired
  - typesarray of objectrequired
    capabilityCountsobjectrequired
    collectionintegerrequired
    deleteintegerrequired
    downloadintegerrequired
    editintegerrequired
    favoriteintegerrequired
    myListintegerrequired
    playintegerrequired
    playlistintegerrequired
    queueintegerrequired
    refreshintegerrequired
    watchedintegerrequired
    countintegerrequired
    kindstringrequired
    librariesarray of objectrequired
    countintegerrequired
    libraryIdstringrequired
  - unavailableActionsobject
    deletestringone of "unsupported-sort"
    metadataPreviewstringone of "preview-limit"
    playstringone of "unsupported-sort"
    playliststringone of "unsupported-sort"
    queuestringone of "unsupported-sort"
- wholeSelectionPreparingobject
  - kindstringrequiredone of "browse-selection-preparing"
  - queryIdstringrequiredlength 1–128
  - retryAfterMsintegerrequired≥ 1
  - statestringrequiredone of "preparing"
  - variant"preparing"required
- wholeSelectionUnavailableobject
  - reasonstringrequiredone of "search_not_bounded"
entriesarray of objectrequired
- hiddenbooleanrequired
- idstringrequired
- mediaobject
  - 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
filtersarray of object
- idstringrequired
- labelKeystringrequired
- optionsarray of objectrequired
  - countintegerrequired
  - idstringrequired
  - labelstringrequired
nextCursorstringrequired
orderobject
- laststring
- nextstring
- previousstring
queryobject
- categorystringrequired
- directionstringrequired
- limitintegerrequired
- qstringrequired
- searchModestringrequired
- sortstringrequired
resourceobjectrequired
- actionsarray of stringrequired
- definitionobject
  - libraryIdstringrequired
  - pivotstringrequired
  - presentationstringrequired
  - queryobject | any | nullrequired
    fieldstringrequiredone of "releaseDate", "dateAdded", "lastPlayedAt"
    operatorstringrequiredone of "within-last-days"
    valueintegerrequired1–36500
    variant"relative"required
  - sortarray of objectrequired
    directionstringrequired
    fieldstringrequired
    seedinteger
- entryCountintegerrequired
- idstringrequired
- invalidComponentsarray of stringrequired
- kindstringrequired
- namestringrequired
- pinRevisionintegerrequired
- pinnedbooleanrequired
- revisionintegerrequired
- rolestringrequired
- serverIdstringrequired
- sharesarray of object
  - accountIdstringrequired
  - authoritystringrequired
  - displayNamestringrequired
  - profileIdstringrequired
  - rolestringrequired
- statusstringrequired
- summarystringrequired
- viewerFencestringrequired
- visibilitystringrequired
sortsarray of object
- directionsarray of stringrequired
- idstringrequired
- labelKeystringrequired
startintegerrequired
totalCountinteger

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/saved-resources/{id}/content" \
  -H "Authorization: Bearer $PORTICO_API_KEY"

PUT/v1/saved-resources/{id}/entriesSave saved resources entriesplayback

Audience: Clients · Native API
Authorization: API key or personal access token with the playback scope, or a signed-in session
OpenAPI operation ID: put_saved_resources_id_entries
Max body: 64 KiB

Parameters

Name	In	Type
`id`required	path	`string`
`Idempotency-Key`	header	`string`
`Portico-Mutation-Root`	header	`string`

Request body application/json · required

Example

{
  "accountId": "id_8h2k4q",
  "addItemIds": [
    "string"
  ],
  "afterEntryId": "id_8h2k4q",
  "authority": "string",
  "definition": {
    "libraryId": "id_8h2k4q",
    "pivot": "string",
    "presentation": "string",
    "query": {
      "field": "releaseDate",
      "operator": "within-last-days",
      "value": 1,
      "variant": "relative"
    },
    "sort": [
      {
        "direction": "string",
        "field": "string",
        "seed": 0
      }
    ]
  },
  "entryIds": [
    "string"
  ],
  "expectedRevision": 0,
  "kind": "string",
  "name": "Fargo",
  "operationId": "id_8h2k4q",
  "profileId": "id_8h2k4q",
  "removeEntryIds": [
    "string"
  ],
  "role": "string",
  "summary": "string",
  "undoToken": "string",
  "visibility": "string"
}

Schema

accountIdstring
addItemIdsarray of string
afterEntryIdstring
authoritystring
definitionobject
- libraryIdstringrequired
- pivotstringrequired
- presentationstringrequired
- queryobject | any | nullrequired
  - fieldstringrequiredone of "releaseDate", "dateAdded", "lastPlayedAt"
  - operatorstringrequiredone of "within-last-days"
  - valueintegerrequired1–36500
  - variant"relative"required
- sortarray of objectrequired
  - directionstringrequired
  - fieldstringrequired
  - seedinteger
entryIdsarray of string
expectedRevisionintegerrequired
kindstring
namestring
operationIdstringrequired
profileIdstring
removeEntryIdsarray of string
rolestring
summarystring
undoTokenstring
visibilitystring

Responses

200Successapplication/json

Example

{
  "current": {
    "deleted": true,
    "resourceId": "id_8h2k4q",
    "revision": 0
  },
  "receipt": {
    "deleted": true,
    "entries": {
      "added": [
        "string"
      ],
      "failed": [
        {
          "code": "string",
          "itemId": "id_8h2k4q"
        }
      ],
      "removed": [
        "string"
      ],
      "unchanged": [
        "string"
      ]
    },
    "operationId": "id_8h2k4q",
    "resourceId": "id_8h2k4q",
    "revision": 0,
    "undoToken": "string",
    "undoUntil": "string"
  },
  "receiptLifetimeMs": 1800000,
  "serverId": "id_8h2k4q",
  "viewerFence": "string"
}

Schema

currentobject
- deletedbooleanrequired
- resourceIdstringrequired
- revisionintegerrequired
receiptobjectrequired
- deletedbooleanrequired
- entriesobject
  - addedarray of stringrequired
  - failedarray of objectrequired
    codestringrequired
    itemIdstringrequired
  - removedarray of stringrequired
  - unchangedarray of stringrequired
- operationIdstringrequired
- resourceIdstringrequired
- revisionintegerrequired
- undoTokenstring
- undoUntilstring
receiptLifetimeMsintegerrequired
serverIdstringrequired
viewerFencestringrequired

defaultRequest refused or unavailableapplication/json

Example

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

Schema

errorobjectrequired
- codestringrequired
- messagestringrequired

Error codesinvalid_requestunauthorizednot_permittednot_foundrevision_mismatchinternalidempotency_conflictreceipt_expiredinvalid_mutation_keydatabase_busywriter_capacity

Example request

curl -X PUT "http://127.0.0.1:32500/v1/saved-resources/{id}/entries" \
  -H "Authorization: Bearer $PORTICO_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "accountId": "id_8h2k4q",
  "addItemIds": [
    "string"
  ],
  "afterEntryId": "id_8h2k4q",
  "authority": "string",
  "definition": {
    "libraryId": "id_8h2k4q",
    "pivot": "string",
    "presentation": "string",
    "query": {
      "field": "releaseDate",
      "operator": "within-last-days",
      "value": 1,
      "variant": "relative"
    },
    "sort": [
      {
        "direction": "string",
        "field": "string",
        "seed": 0
      }
    ]
  },
  "entryIds": [
    "string"
  ],
  "expectedRevision": 0,
  "kind": "string",
  "name": "Fargo",
  "operationId": "id_8h2k4q",
  "profileId": "id_8h2k4q",
  "removeEntryIds": [
    "string"
  ],
  "role": "string",
  "summary": "string",
  "undoToken": "string",
  "visibility": "string"
}'

PUT/v1/saved-resources/{id}/orderMove entries of a personal collection (at most 200), fenced by its revisionplayback

Audience: Clients · Native API
Authorization: API key or personal access token with the playback scope, or a signed-in session
OpenAPI operation ID: reorder_saved_collection
Max body: 64 KiB

Parameters

Name	In	Type
`id`required	path	`string`
`Idempotency-Key`	header	`string`
`Portico-Mutation-Root`	header	`string`

Request body application/json · required

Example

{
  "accountId": "id_8h2k4q",
  "addItemIds": [
    "string"
  ],
  "afterEntryId": "id_8h2k4q",
  "authority": "string",
  "definition": {
    "libraryId": "id_8h2k4q",
    "pivot": "string",
    "presentation": "string",
    "query": {
      "field": "releaseDate",
      "operator": "within-last-days",
      "value": 1,
      "variant": "relative"
    },
    "sort": [
      {
        "direction": "string",
        "field": "string",
        "seed": 0
      }
    ]
  },
  "entryIds": [
    "string"
  ],
  "expectedRevision": 0,
  "kind": "string",
  "name": "Fargo",
  "operationId": "id_8h2k4q",
  "profileId": "id_8h2k4q",
  "removeEntryIds": [
    "string"
  ],
  "role": "string",
  "summary": "string",
  "undoToken": "string",
  "visibility": "string"
}

Schema

accountIdstring
addItemIdsarray of string
afterEntryIdstring
authoritystring
definitionobject
- libraryIdstringrequired
- pivotstringrequired
- presentationstringrequired
- queryobject | any | nullrequired
  - fieldstringrequiredone of "releaseDate", "dateAdded", "lastPlayedAt"
  - operatorstringrequiredone of "within-last-days"
  - valueintegerrequired1–36500
  - variant"relative"required
- sortarray of objectrequired
  - directionstringrequired
  - fieldstringrequired
  - seedinteger
entryIdsarray of string
expectedRevisionintegerrequired
kindstring
namestring
operationIdstringrequired
profileIdstring
removeEntryIdsarray of string
rolestring
summarystring
undoTokenstring
visibilitystring

Responses

200Successapplication/json

Example

{
  "current": {
    "deleted": true,
    "resourceId": "id_8h2k4q",
    "revision": 0
  },
  "receipt": {
    "deleted": true,
    "entries": {
      "added": [
        "string"
      ],
      "failed": [
        {
          "code": "string",
          "itemId": "id_8h2k4q"
        }
      ],
      "removed": [
        "string"
      ],
      "unchanged": [
        "string"
      ]
    },
    "operationId": "id_8h2k4q",
    "resourceId": "id_8h2k4q",
    "revision": 0,
    "undoToken": "string",
    "undoUntil": "string"
  },
  "receiptLifetimeMs": 1800000,
  "serverId": "id_8h2k4q",
  "viewerFence": "string"
}

Schema

currentobject
- deletedbooleanrequired
- resourceIdstringrequired
- revisionintegerrequired
receiptobjectrequired
- deletedbooleanrequired
- entriesobject
  - addedarray of stringrequired
  - failedarray of objectrequired
    codestringrequired
    itemIdstringrequired
  - removedarray of stringrequired
  - unchangedarray of stringrequired
- operationIdstringrequired
- resourceIdstringrequired
- revisionintegerrequired
- undoTokenstring
- undoUntilstring
receiptLifetimeMsintegerrequired
serverIdstringrequired
viewerFencestringrequired

defaultRequest refused or unavailableapplication/json

Example

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

Schema

errorobjectrequired
- codestringrequired
- messagestringrequired

Error codesinvalid_requestunauthorizednot_permittednot_foundrevision_mismatchinternalidempotency_conflictreceipt_expiredinvalid_mutation_keydatabase_busywriter_capacity

Example request

curl -X PUT "http://127.0.0.1:32500/v1/saved-resources/{id}/order" \
  -H "Authorization: Bearer $PORTICO_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "accountId": "id_8h2k4q",
  "addItemIds": [
    "string"
  ],
  "afterEntryId": "id_8h2k4q",
  "authority": "string",
  "definition": {
    "libraryId": "id_8h2k4q",
    "pivot": "string",
    "presentation": "string",
    "query": {
      "field": "releaseDate",
      "operator": "within-last-days",
      "value": 1,
      "variant": "relative"
    },
    "sort": [
      {
        "direction": "string",
        "field": "string",
        "seed": 0
      }
    ]
  },
  "entryIds": [
    "string"
  ],
  "expectedRevision": 0,
  "kind": "string",
  "name": "Fargo",
  "operationId": "id_8h2k4q",
  "profileId": "id_8h2k4q",
  "removeEntryIds": [
    "string"
  ],
  "role": "string",
  "summary": "string",
  "undoToken": "string",
  "visibility": "string"
}'

GET/v1/saved-resources/{id}/share-candidatesRead saved resources share candidatesread

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

Parameters

Name	In	Type
`id`required	path	`string`
`cursor`	query	`string`
`limit`	query	`integer`1–100

Responses

200Successapplication/json

Example

{
  "candidates": [
    {
      "accountId": "id_8h2k4q",
      "authority": "string",
      "displayName": "Fargo",
      "id": "id_8h2k4q",
      "profileId": "id_8h2k4q"
    }
  ],
  "nextCursor": "eyJvIjoyMH0",
  "resourceId": "id_8h2k4q",
  "revision": 0,
  "serverId": "id_8h2k4q",
  "viewerFence": "string"
}

Schema

candidatesarray of objectrequired
- accountIdstringrequired
- authoritystringrequired
- displayNamestringrequired
- idstringrequired
- profileIdstringrequired
nextCursorstringrequired
resourceIdstringrequired
revisionintegerrequired
serverIdstringrequired
viewerFencestringrequired

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/saved-resources/{id}/share-candidates" \
  -H "Authorization: Bearer $PORTICO_API_KEY"

DELETE/v1/saved-resources/{id}/sharesRemove saved resources sharesplayback

Audience: Clients · Native API
Authorization: API key or personal access token with the playback scope, or a signed-in session
OpenAPI operation ID: delete_saved_resources_id_shares
Max body: 64 KiB

Parameters

Name	In	Type
`id`required	path	`string`
`Idempotency-Key`	header	`string`
`Portico-Mutation-Root`	header	`string`

Request body application/json · required

Example

{
  "accountId": "id_8h2k4q",
  "addItemIds": [
    "string"
  ],
  "afterEntryId": "id_8h2k4q",
  "authority": "string",
  "definition": {
    "libraryId": "id_8h2k4q",
    "pivot": "string",
    "presentation": "string",
    "query": {
      "field": "releaseDate",
      "operator": "within-last-days",
      "value": 1,
      "variant": "relative"
    },
    "sort": [
      {
        "direction": "string",
        "field": "string",
        "seed": 0
      }
    ]
  },
  "entryIds": [
    "string"
  ],
  "expectedRevision": 0,
  "kind": "string",
  "name": "Fargo",
  "operationId": "id_8h2k4q",
  "profileId": "id_8h2k4q",
  "removeEntryIds": [
    "string"
  ],
  "role": "string",
  "summary": "string",
  "undoToken": "string",
  "visibility": "string"
}

Schema

accountIdstring
addItemIdsarray of string
afterEntryIdstring
authoritystring
definitionobject
- libraryIdstringrequired
- pivotstringrequired
- presentationstringrequired
- queryobject | any | nullrequired
  - fieldstringrequiredone of "releaseDate", "dateAdded", "lastPlayedAt"
  - operatorstringrequiredone of "within-last-days"
  - valueintegerrequired1–36500
  - variant"relative"required
- sortarray of objectrequired
  - directionstringrequired
  - fieldstringrequired
  - seedinteger
entryIdsarray of string
expectedRevisionintegerrequired
kindstring
namestring
operationIdstringrequired
profileIdstring
removeEntryIdsarray of string
rolestring
summarystring
undoTokenstring
visibilitystring

Responses

200Successapplication/json

Example

{
  "current": {
    "deleted": true,
    "resourceId": "id_8h2k4q",
    "revision": 0
  },
  "receipt": {
    "deleted": true,
    "entries": {
      "added": [
        "string"
      ],
      "failed": [
        {
          "code": "string",
          "itemId": "id_8h2k4q"
        }
      ],
      "removed": [
        "string"
      ],
      "unchanged": [
        "string"
      ]
    },
    "operationId": "id_8h2k4q",
    "resourceId": "id_8h2k4q",
    "revision": 0,
    "undoToken": "string",
    "undoUntil": "string"
  },
  "receiptLifetimeMs": 1800000,
  "serverId": "id_8h2k4q",
  "viewerFence": "string"
}

Schema

currentobject
- deletedbooleanrequired
- resourceIdstringrequired
- revisionintegerrequired
receiptobjectrequired
- deletedbooleanrequired
- entriesobject
  - addedarray of stringrequired
  - failedarray of objectrequired
    codestringrequired
    itemIdstringrequired
  - removedarray of stringrequired
  - unchangedarray of stringrequired
- operationIdstringrequired
- resourceIdstringrequired
- revisionintegerrequired
- undoTokenstring
- undoUntilstring
receiptLifetimeMsintegerrequired
serverIdstringrequired
viewerFencestringrequired

defaultRequest refused or unavailableapplication/json

Example

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

Schema

errorobjectrequired
- codestringrequired
- messagestringrequired

Error codesinvalid_requestunauthorizednot_permittednot_foundrevision_mismatchinternalidempotency_conflictreceipt_expiredinvalid_mutation_keydatabase_busywriter_capacity

Example request

curl -X DELETE "http://127.0.0.1:32500/v1/saved-resources/{id}/shares" \
  -H "Authorization: Bearer $PORTICO_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "accountId": "id_8h2k4q",
  "addItemIds": [
    "string"
  ],
  "afterEntryId": "id_8h2k4q",
  "authority": "string",
  "definition": {
    "libraryId": "id_8h2k4q",
    "pivot": "string",
    "presentation": "string",
    "query": {
      "field": "releaseDate",
      "operator": "within-last-days",
      "value": 1,
      "variant": "relative"
    },
    "sort": [
      {
        "direction": "string",
        "field": "string",
        "seed": 0
      }
    ]
  },
  "entryIds": [
    "string"
  ],
  "expectedRevision": 0,
  "kind": "string",
  "name": "Fargo",
  "operationId": "id_8h2k4q",
  "profileId": "id_8h2k4q",
  "removeEntryIds": [
    "string"
  ],
  "role": "string",
  "summary": "string",
  "undoToken": "string",
  "visibility": "string"
}'

PUT/v1/saved-resources/{id}/sharesSave saved resources sharesplayback

Audience: Clients · Native API
Authorization: API key or personal access token with the playback scope, or a signed-in session
OpenAPI operation ID: put_saved_resources_id_shares
Max body: 64 KiB

Parameters

Name	In	Type
`id`required	path	`string`
`Idempotency-Key`	header	`string`
`Portico-Mutation-Root`	header	`string`

Request body application/json · required

Example

{
  "accountId": "id_8h2k4q",
  "addItemIds": [
    "string"
  ],
  "afterEntryId": "id_8h2k4q",
  "authority": "string",
  "definition": {
    "libraryId": "id_8h2k4q",
    "pivot": "string",
    "presentation": "string",
    "query": {
      "field": "releaseDate",
      "operator": "within-last-days",
      "value": 1,
      "variant": "relative"
    },
    "sort": [
      {
        "direction": "string",
        "field": "string",
        "seed": 0
      }
    ]
  },
  "entryIds": [
    "string"
  ],
  "expectedRevision": 0,
  "kind": "string",
  "name": "Fargo",
  "operationId": "id_8h2k4q",
  "profileId": "id_8h2k4q",
  "removeEntryIds": [
    "string"
  ],
  "role": "string",
  "summary": "string",
  "undoToken": "string",
  "visibility": "string"
}

Schema

accountIdstring
addItemIdsarray of string
afterEntryIdstring
authoritystring
definitionobject
- libraryIdstringrequired
- pivotstringrequired
- presentationstringrequired
- queryobject | any | nullrequired
  - fieldstringrequiredone of "releaseDate", "dateAdded", "lastPlayedAt"
  - operatorstringrequiredone of "within-last-days"
  - valueintegerrequired1–36500
  - variant"relative"required
- sortarray of objectrequired
  - directionstringrequired
  - fieldstringrequired
  - seedinteger
entryIdsarray of string
expectedRevisionintegerrequired
kindstring
namestring
operationIdstringrequired
profileIdstring
removeEntryIdsarray of string
rolestring
summarystring
undoTokenstring
visibilitystring

Responses

200Successapplication/json

Example

{
  "current": {
    "deleted": true,
    "resourceId": "id_8h2k4q",
    "revision": 0
  },
  "receipt": {
    "deleted": true,
    "entries": {
      "added": [
        "string"
      ],
      "failed": [
        {
          "code": "string",
          "itemId": "id_8h2k4q"
        }
      ],
      "removed": [
        "string"
      ],
      "unchanged": [
        "string"
      ]
    },
    "operationId": "id_8h2k4q",
    "resourceId": "id_8h2k4q",
    "revision": 0,
    "undoToken": "string",
    "undoUntil": "string"
  },
  "receiptLifetimeMs": 1800000,
  "serverId": "id_8h2k4q",
  "viewerFence": "string"
}

Schema

currentobject
- deletedbooleanrequired
- resourceIdstringrequired
- revisionintegerrequired
receiptobjectrequired
- deletedbooleanrequired
- entriesobject
  - addedarray of stringrequired
  - failedarray of objectrequired
    codestringrequired
    itemIdstringrequired
  - removedarray of stringrequired
  - unchangedarray of stringrequired
- operationIdstringrequired
- resourceIdstringrequired
- revisionintegerrequired
- undoTokenstring
- undoUntilstring
receiptLifetimeMsintegerrequired
serverIdstringrequired
viewerFencestringrequired

defaultRequest refused or unavailableapplication/json

Example

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

Schema

errorobjectrequired
- codestringrequired
- messagestringrequired

Error codesinvalid_requestunauthorizednot_permittednot_foundrevision_mismatchinternalidempotency_conflictreceipt_expiredinvalid_mutation_keydatabase_busywriter_capacity

Example request

curl -X PUT "http://127.0.0.1:32500/v1/saved-resources/{id}/shares" \
  -H "Authorization: Bearer $PORTICO_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "accountId": "id_8h2k4q",
  "addItemIds": [
    "string"
  ],
  "afterEntryId": "id_8h2k4q",
  "authority": "string",
  "definition": {
    "libraryId": "id_8h2k4q",
    "pivot": "string",
    "presentation": "string",
    "query": {
      "field": "releaseDate",
      "operator": "within-last-days",
      "value": 1,
      "variant": "relative"
    },
    "sort": [
      {
        "direction": "string",
        "field": "string",
        "seed": 0
      }
    ]
  },
  "entryIds": [
    "string"
  ],
  "expectedRevision": 0,
  "kind": "string",
  "name": "Fargo",
  "operationId": "id_8h2k4q",
  "profileId": "id_8h2k4q",
  "removeEntryIds": [
    "string"
  ],
  "role": "string",
  "summary": "string",
  "undoToken": "string",
  "visibility": "string"
}'