Me

Generated me operations.

GET/v1/meRead the current viewerread

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

Responses

200Successapplication/json

Example

{
  "viewer": {
    "accountId": "id_8h2k4q",
    "authority": "string",
    "profileId": "id_8h2k4q",
    "role": "string",
    "serverId": "id_8h2k4q"
  }
}

Schema

viewerobjectrequired
- accountIdstringrequired
- authoritystringrequired
- profileIdstringrequired
- rolestringrequired
- serverIdstringrequired

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

GET/v1/me/access-tokensList your personal access tokenssession

Audience: Integrations · Native API
Authorization: Session only; API keys and personal access tokens are refused
OpenAPI operation ID: list_access_tokens

Parameters

Name	In	Type	Description
`cursor`	query	`string`
`limit`	query	`integer \| ""`1–100

Responses

200Successapplication/json

Example

{
  "items": [
    {
      "createdAt": "2026-10-18T19:30:00Z",
      "endedReason": "string",
      "expiresAt": "2026-10-18T19:30:00Z",
      "hint": "string",
      "id": "id_8h2k4q",
      "kind": "string",
      "lastUsedAt": "2026-10-18T19:30:00Z",
      "member": {
        "accountId": "id_8h2k4q",
        "profile": "string",
        "profileId": "id_8h2k4q",
        "username": "Fargo"
      },
      "name": "Fargo",
      "scopes": [
        "string"
      ],
      "state": "string"
    }
  ],
  "limit": 0,
  "nextCursor": "eyJvIjoyMH0",
  "total": 0
}

Schema

itemsarray of objectrequired
- createdAtstringrequired
- endedReasonstring
- expiresAtstring
- hintstringrequired
- idstringrequired
- kindstringrequired
- lastUsedAtstring
- memberobjectrequired
  - accountIdstringrequired
  - profilestringrequired
  - profileIdstringrequired
  - usernamestringrequired
- namestringrequired
- scopesarray of stringrequired
- statestringrequired
limitintegerrequired
nextCursorstring
totalintegerrequired

defaultRequest refused or unavailableapplication/json

Example

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

Schema

errorobjectrequired
- codestringrequired
- messagestringrequired

Error codesunauthorizednot_permittedsession_requiredinvalid_requestadministration_unavailableinternaldatabase_busy

Example request

curl -X GET "http://127.0.0.1:32500/v1/me/access-tokens" \
  -H "Authorization: Bearer $PORTICO_ACCESS_TOKEN"

POST/v1/me/access-tokensCreate a personal access token; its secret is shown oncesession

Audience: Integrations · Native API
Authorization: Session only; API keys and personal access tokens are refused
OpenAPI operation ID: create_access_token
Max body: 4 KiB

Request body application/json · required

Example

{
  "expiresAt": "2026-10-18T19:30:00Z",
  "name": "Fargo",
  "operationId": "id_8h2k4q",
  "scopes": [
    "string"
  ]
}

Schema

expiresAtstring
namestringrequired
operationIdstringrequired
scopesarray of stringrequired

Responses

201Successapplication/json

Example

{
  "credential": {
    "createdAt": "2026-10-18T19:30:00Z",
    "endedReason": "string",
    "expiresAt": "2026-10-18T19:30:00Z",
    "hint": "string",
    "id": "id_8h2k4q",
    "kind": "string",
    "lastUsedAt": "2026-10-18T19:30:00Z",
    "member": {
      "accountId": "id_8h2k4q",
      "profile": "string",
      "profileId": "id_8h2k4q",
      "username": "Fargo"
    },
    "name": "Fargo",
    "scopes": [
      "string"
    ],
    "state": "string"
  },
  "secret": "string"
}

Schema

credentialobjectrequired
- createdAtstringrequired
- endedReasonstring
- expiresAtstring
- hintstringrequired
- idstringrequired
- kindstringrequired
- lastUsedAtstring
- memberobjectrequired
  - accountIdstringrequired
  - profilestringrequired
  - profileIdstringrequired
  - usernamestringrequired
- namestringrequired
- scopesarray of stringrequired
- statestringrequired
secretstring

defaultRequest refused or unavailableapplication/json

Example

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

Schema

errorobjectrequired
- codestringrequired
- messagestringrequired

Error codesunauthorizednot_permittedsession_requiredinvalid_requestidempotency_key_reusedcredential_limitcredential_unavailableaccess_tokens_offadministration_unavailableinternaldatabase_busywriter_capacity

Example request

curl -X POST "http://127.0.0.1:32500/v1/me/access-tokens" \
  -H "Authorization: Bearer $PORTICO_ACCESS_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"expiresAt":"2026-10-18T19:30:00Z","name":"Fargo","operationId":"id_8h2k4q","scopes":["string"]}'

DELETE/v1/me/access-tokens/{id}Revoke one of your personal access tokenssession

Audience: Integrations · Native API
Authorization: Session only; API keys and personal access tokens are refused
OpenAPI operation ID: revoke_access_token

Parameters

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

Responses

200Successapplication/json

Example

{
  "createdAt": "2026-10-18T19:30:00Z",
  "endedReason": "string",
  "expiresAt": "2026-10-18T19:30:00Z",
  "hint": "string",
  "id": "id_8h2k4q",
  "kind": "string",
  "lastUsedAt": "2026-10-18T19:30:00Z",
  "member": {
    "accountId": "id_8h2k4q",
    "profile": "string",
    "profileId": "id_8h2k4q",
    "username": "Fargo"
  },
  "name": "Fargo",
  "scopes": [
    "string"
  ],
  "state": "string"
}

Schema

createdAtstringrequired
endedReasonstring
expiresAtstring
hintstringrequired
idstringrequired
kindstringrequired
lastUsedAtstring
memberobjectrequired
- accountIdstringrequired
- profilestringrequired
- profileIdstringrequired
- usernamestringrequired
namestringrequired
scopesarray of stringrequired
statestringrequired

defaultRequest refused or unavailableapplication/json

Example

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

Schema

errorobjectrequired
- codestringrequired
- messagestringrequired

Error codesunauthorizednot_permittedsession_requiredinvalid_requestnot_foundadministration_unavailableinternaldatabase_busywriter_capacity

Example request

curl -X DELETE "http://127.0.0.1:32500/v1/me/access-tokens/{id}" \
  -H "Authorization: Bearer $PORTICO_ACCESS_TOKEN"

GET/v1/me/api-accessRead the scopes and limits for API keys and personal access tokenssession

Audience: Integrations · Native API
Authorization: Session only; API keys and personal access tokens are refused
OpenAPI operation ID: get_api_access_options

Responses

200Successapplication/json

Example

{
  "maximumKeys": 0,
  "maximumTokens": 0,
  "queryParameter": "string",
  "requestsPerMinute": 0,
  "scopes": [
    {
      "id": "id_8h2k4q"
    }
  ],
  "tokensAllowed": true
}

Schema

maximumKeysintegerrequired
maximumTokensintegerrequired
queryParameterstringrequired
requestsPerMinuteintegerrequired
scopesarray of objectrequired
- idstringrequired
tokensAllowedbooleanrequired

defaultRequest refused or unavailableapplication/json

Example

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

Schema

errorobjectrequired
- codestringrequired
- messagestringrequired

Error codesunauthorizedsession_requiredinternaldatabase_busy

Example request

curl -X GET "http://127.0.0.1:32500/v1/me/api-access" \
  -H "Authorization: Bearer $PORTICO_ACCESS_TOKEN"

GET/v1/me/devices/current/capabilitiesRead this device's capability documentread

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

Responses

200Successapplication/json

Example

{
  "capabilities": {
    "audioDecode": [
      {
        "codec": "string",
        "containers": [
          "string"
        ],
        "maxBitDepth": 0,
        "maxChannels": 0,
        "maxSampleRate": 0,
        "sampleRates": [
          0
        ],
        "via": "string"
      }
    ],
    "audioOutput": {
      "maxChannels": 0,
      "route": "string",
      "spatial": true
    },
    "client": {
      "app": "string",
      "appVersion": "string",
      "family": "string",
      "form": "string",
      "model": "string",
      "os": "string",
      "osVersion": "string",
      "platform": "string",
      "platformVersion": "string"
    },
    "display": {
      "dynamicRanges": [
        "string"
      ],
      "height": 0,
      "maxFrameRate": 0,
      "width": 0
    },
    "engineSetting": "string",
    "engines": {
      "mpv": {
        "audio": [
          {}
        ],
        "audioPassthrough": [
          {}
        ],
        "embeddedAudioSwitching": true,
        "evidence": "string",
        "liveChannels": true,
        "name": "Fargo",
        "subtitleRendering": [
          "Fargo"
        ],
        "toneMapsHdr": true,
        "transports": [
          {}
        ],
        "version": "string",
        "video": [
          {}
        ]
      },
      "native": {
        "audio": [
          {}
        ],
        "audioPassthrough": [
          {}
        ],
        "embeddedAudioSwitching": true,
        "evidence": "string",
        "liveChannels": true,
        "name": "Fargo",
        "subtitleRendering": [
          "Fargo"
        ],
        "toneMapsHdr": true,
        "transports": [
          {}
        ],
        "version": "string",
        "video": [
          {}
        ]
      }
    },
    "maxBitrateBps": 0,
    "overrides": {
      "disableHdr": true,
      "disablePassthrough": true,
      "forceStereo": true
    },
    "version": 0
  },
  "revision": 0
}

Schema

capabilitiesobjectrequired
- audioDecodearray of object
  - codecstringrequired
  - containersarray of stringrequired
  - maxBitDepthinteger
  - maxChannelsinteger
  - maxSampleRateinteger
  - sampleRatesarray of integer
  - viastring
- audioOutputobjectrequired
  - maxChannelsintegerrequired
  - routestringrequired
  - spatialbooleanrequired
- clientobjectrequired
  - appstring
  - appVersionstring
  - familystringrequired
  - formstring
  - modelstring
  - osstring
  - osVersionstring
  - platformstring
  - platformVersionstring
- displayobjectrequired
  - dynamicRangesarray of stringrequired
  - heightintegerrequired
  - maxFrameRatenumberrequired
  - widthintegerrequired
- engineSettingstringrequired
- enginesobjectrequired
  - mpvobject
    audioarray of objectrequired
    codecstringrequired
    evidencestring
    maxBitDepthinteger
    maxChannelsintegerrequired
    maxSampleRateintegerrequired
    objectAudioarray of stringrequired
    sampleRatesarray of integer
    variantsarray of string
    audioPassthrougharray of objectrequired
    codecstringrequired
    evidencestring
    maxChannelsintegerrequired
    objectAudioarray of stringrequired
    variantsarray of string
    embeddedAudioSwitchingbooleanrequired
    evidencestringrequired
    liveChannelsboolean
    namestring
    subtitleRenderingarray of stringrequired
    toneMapsHdrbooleanrequired
    transportsarray of objectrequired
    audioarray of stringrequired
    containersarray of stringrequired
    transportstringrequired
    videoarray of stringrequired
    versionstring
    videoarray of objectrequired
    bitDepthsarray of integerrequired
    chromaSubsamplingarray of string
    codecstringrequired
    codecTagsarray of string
    dolbyVisionProfile8Compatibilityarray of integer0–3 items
    dolbyVisionProfilesarray of integerrequired
    dynamicRangesarray of stringrequired
    evidencestring
    frameRateModesarray of string
    interlacedbooleanrequired
    limitsarray of object
    bitDepthsarray of integer
    maxFrameRatenumberrequired
    maxHeightintegerrequired
    maxLevelinteger
    maxWidthintegerrequired
    maxBitrateBpsintegerrequired
    maxFrameRatenumberrequired
    maxHeightintegerrequired
    maxLevelintegerrequired
    maxWidthintegerrequired
    profilesarray of stringrequired
  - nativeobject | any | nullrequired
    audioarray of objectrequired
    codecstringrequired
    evidencestring
    maxBitDepthinteger
    maxChannelsintegerrequired
    maxSampleRateintegerrequired
    objectAudioarray of stringrequired
    sampleRatesarray of integer
    variantsarray of string
    audioPassthrougharray of objectrequired
    codecstringrequired
    evidencestring
    maxChannelsintegerrequired
    objectAudioarray of stringrequired
    variantsarray of string
    embeddedAudioSwitchingbooleanrequired
    evidencestringrequired
    liveChannelsboolean
    namestring
    subtitleRenderingarray of stringrequired
    toneMapsHdrbooleanrequired
    transportsarray of objectrequired
    audioarray of stringrequired
    containersarray of stringrequired
    transportstringrequired
    videoarray of stringrequired
    versionstring
    videoarray of objectrequired
    bitDepthsarray of integerrequired
    chromaSubsamplingarray of string
    codecstringrequired
    codecTagsarray of string
    dolbyVisionProfile8Compatibilityarray of integer0–3 items
    dolbyVisionProfilesarray of integerrequired
    dynamicRangesarray of stringrequired
    evidencestring
    frameRateModesarray of string
    interlacedbooleanrequired
    limitsarray of object
    bitDepthsarray of integer
    maxFrameRatenumberrequired
    maxHeightintegerrequired
    maxLevelinteger
    maxWidthintegerrequired
    maxBitrateBpsintegerrequired
    maxFrameRatenumberrequired
    maxHeightintegerrequired
    maxLevelintegerrequired
    maxWidthintegerrequired
    profilesarray of stringrequired
- maxBitrateBpsintegerrequired
- overridesobjectrequired
  - disableHdrbooleanrequired
  - disablePassthroughbooleanrequired
  - forceStereobooleanrequired
- versionintegerrequired
revisionintegerrequired

defaultRequest refused or unavailableapplication/json

Example

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

Schema

errorobjectrequired
- codestringrequired
- messagestringrequired

Error codesunauthorizednot_foundtimeoutdatabase_busy

Example request

curl -X GET "http://127.0.0.1:32500/v1/me/devices/current/capabilities" \
  -H "Authorization: Bearer $PORTICO_API_KEY"

PUT/v1/me/devices/current/capabilitiesReplace this device's capability document: what each of its player engines can play, the viewer's player setting and overridesplayback

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

Request body application/json · required

Example

{
  "audioDecode": [
    {
      "codec": "string",
      "containers": [
        "string"
      ],
      "maxBitDepth": 0,
      "maxChannels": 0,
      "maxSampleRate": 0,
      "sampleRates": [
        0
      ],
      "via": "string"
    }
  ],
  "audioOutput": {
    "maxChannels": 0,
    "route": "string",
    "spatial": true
  },
  "client": {
    "app": "string",
    "appVersion": "string",
    "family": "string",
    "form": "string",
    "model": "string",
    "os": "string",
    "osVersion": "string",
    "platform": "string",
    "platformVersion": "string"
  },
  "display": {
    "dynamicRanges": [
      "string"
    ],
    "height": 0,
    "maxFrameRate": 0,
    "width": 0
  },
  "engineSetting": "string",
  "engines": {
    "mpv": {
      "audio": [
        {
          "codec": "string",
          "evidence": "string",
          "maxBitDepth": 0,
          "maxChannels": 0,
          "maxSampleRate": 0,
          "objectAudio": [],
          "sampleRates": [],
          "variants": []
        }
      ],
      "audioPassthrough": [
        {
          "codec": "string",
          "evidence": "string",
          "maxChannels": 0,
          "objectAudio": [],
          "variants": []
        }
      ],
      "embeddedAudioSwitching": true,
      "evidence": "string",
      "liveChannels": true,
      "name": "Fargo",
      "subtitleRendering": [
        "Fargo"
      ],
      "toneMapsHdr": true,
      "transports": [
        {
          "audio": [],
          "containers": [],
          "transport": "string",
          "video": []
        }
      ],
      "version": "string",
      "video": [
        {
          "bitDepths": [],
          "chromaSubsampling": [],
          "codec": "string",
          "codecTags": [],
          "dolbyVisionProfile8Compatibility": [],
          "dolbyVisionProfiles": [],
          "dynamicRanges": [],
          "evidence": "string",
          "frameRateModes": [],
          "interlaced": true,
          "limits": [],
          "maxBitrateBps": 0,
          "maxFrameRate": 0,
          "maxHeight": 0,
          "maxLevel": 0,
          "maxWidth": 0,
          "profiles": []
        }
      ]
    },
    "native": {
      "audio": [
        {
          "codec": "string",
          "evidence": "string",
          "maxBitDepth": 0,
          "maxChannels": 0,
          "maxSampleRate": 0,
          "objectAudio": [],
          "sampleRates": [],
          "variants": []
        }
      ],
      "audioPassthrough": [
        {
          "codec": "string",
          "evidence": "string",
          "maxChannels": 0,
          "objectAudio": [],
          "variants": []
        }
      ],
      "embeddedAudioSwitching": true,
      "evidence": "string",
      "liveChannels": true,
      "name": "Fargo",
      "subtitleRendering": [
        "Fargo"
      ],
      "toneMapsHdr": true,
      "transports": [
        {
          "audio": [],
          "containers": [],
          "transport": "string",
          "video": []
        }
      ],
      "version": "string",
      "video": [
        {
          "bitDepths": [],
          "chromaSubsampling": [],
          "codec": "string",
          "codecTags": [],
          "dolbyVisionProfile8Compatibility": [],
          "dolbyVisionProfiles": [],
          "dynamicRanges": [],
          "evidence": "string",
          "frameRateModes": [],
          "interlaced": true,
          "limits": [],
          "maxBitrateBps": 0,
          "maxFrameRate": 0,
          "maxHeight": 0,
          "maxLevel": 0,
          "maxWidth": 0,
          "profiles": []
        }
      ]
    }
  },
  "maxBitrateBps": 0,
  "overrides": {
    "disableHdr": true,
    "disablePassthrough": true,
    "forceStereo": true
  },
  "version": 0
}

Schema

audioDecodearray of object
- codecstringrequired
- containersarray of stringrequired
- maxBitDepthinteger
- maxChannelsinteger
- maxSampleRateinteger
- sampleRatesarray of integer
- viastring
audioOutputobjectrequired
- maxChannelsintegerrequired
- routestringrequired
- spatialbooleanrequired
clientobjectrequired
- appstring
- appVersionstring
- familystringrequired
- formstring
- modelstring
- osstring
- osVersionstring
- platformstring
- platformVersionstring
displayobjectrequired
- dynamicRangesarray of stringrequired
- heightintegerrequired
- maxFrameRatenumberrequired
- widthintegerrequired
engineSettingstringrequired
enginesobjectrequired
- mpvobject
  - audioarray of objectrequired
    codecstringrequired
    evidencestring
    maxBitDepthinteger
    maxChannelsintegerrequired
    maxSampleRateintegerrequired
    objectAudioarray of stringrequired
    sampleRatesarray of integer
    variantsarray of string
  - audioPassthrougharray of objectrequired
    codecstringrequired
    evidencestring
    maxChannelsintegerrequired
    objectAudioarray of stringrequired
    variantsarray of string
  - embeddedAudioSwitchingbooleanrequired
  - evidencestringrequired
  - liveChannelsboolean
  - namestring
  - subtitleRenderingarray of stringrequired
  - toneMapsHdrbooleanrequired
  - transportsarray of objectrequired
    audioarray of stringrequired
    containersarray of stringrequired
    transportstringrequired
    videoarray of stringrequired
  - versionstring
  - videoarray of objectrequired
    bitDepthsarray of integerrequired
    chromaSubsamplingarray of string
    codecstringrequired
    codecTagsarray of string
    dolbyVisionProfile8Compatibilityarray of integer0–3 items
    dolbyVisionProfilesarray of integerrequired
    dynamicRangesarray of stringrequired
    evidencestring
    frameRateModesarray of string
    interlacedbooleanrequired
    limitsarray of object
    bitDepthsarray of integer
    maxFrameRatenumberrequired
    maxHeightintegerrequired
    maxLevelinteger
    maxWidthintegerrequired
    maxBitrateBpsintegerrequired
    maxFrameRatenumberrequired
    maxHeightintegerrequired
    maxLevelintegerrequired
    maxWidthintegerrequired
    profilesarray of stringrequired
- nativeobject | any | nullrequired
  - audioarray of objectrequired
    codecstringrequired
    evidencestring
    maxBitDepthinteger
    maxChannelsintegerrequired
    maxSampleRateintegerrequired
    objectAudioarray of stringrequired
    sampleRatesarray of integer
    variantsarray of string
  - audioPassthrougharray of objectrequired
    codecstringrequired
    evidencestring
    maxChannelsintegerrequired
    objectAudioarray of stringrequired
    variantsarray of string
  - embeddedAudioSwitchingbooleanrequired
  - evidencestringrequired
  - liveChannelsboolean
  - namestring
  - subtitleRenderingarray of stringrequired
  - toneMapsHdrbooleanrequired
  - transportsarray of objectrequired
    audioarray of stringrequired
    containersarray of stringrequired
    transportstringrequired
    videoarray of stringrequired
  - versionstring
  - videoarray of objectrequired
    bitDepthsarray of integerrequired
    chromaSubsamplingarray of string
    codecstringrequired
    codecTagsarray of string
    dolbyVisionProfile8Compatibilityarray of integer0–3 items
    dolbyVisionProfilesarray of integerrequired
    dynamicRangesarray of stringrequired
    evidencestring
    frameRateModesarray of string
    interlacedbooleanrequired
    limitsarray of object
    bitDepthsarray of integer
    maxFrameRatenumberrequired
    maxHeightintegerrequired
    maxLevelinteger
    maxWidthintegerrequired
    maxBitrateBpsintegerrequired
    maxFrameRatenumberrequired
    maxHeightintegerrequired
    maxLevelintegerrequired
    maxWidthintegerrequired
    profilesarray of stringrequired
maxBitrateBpsintegerrequired
overridesobjectrequired
- disableHdrbooleanrequired
- disablePassthroughbooleanrequired
- forceStereobooleanrequired
versionintegerrequired

Responses

204Success

defaultRequest refused or unavailableapplication/json

Example

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

Schema

errorobjectrequired
- codestringrequired
- messagestringrequired

Error codesinvalid_requestunauthorizedrevision_mismatchtimeoutdatabase_busywriter_capacity

Example request

curl -X PUT "http://127.0.0.1:32500/v1/me/devices/current/capabilities" \
  -H "Authorization: Bearer $PORTICO_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "audioDecode": [
    {
      "codec": "string",
      "containers": [
        "string"
      ],
      "maxBitDepth": 0,
      "maxChannels": 0,
      "maxSampleRate": 0,
      "sampleRates": [
        0
      ],
      "via": "string"
    }
  ],
  "audioOutput": {
    "maxChannels": 0,
    "route": "string",
    "spatial": true
  },
  "client": {
    "app": "string",
    "appVersion": "string",
    "family": "string",
    "form": "string",
    "model": "string",
    "os": "string",
    "osVersion": "string",
    "platform": "string",
    "platformVersion": "string"
  },
  "display": {
    "dynamicRanges": [
      "string"
    ],
    "height": 0,
    "maxFrameRate": 0,
    "width": 0
  },
  "engineSetting": "string",
  "engines": {
    "mpv": {
      "audio": [
        {
          "codec": "string",
          "evidence": "string",
          "maxBitDepth": 0,
          "maxChannels": 0,
          "maxSampleRate": 0,
          "objectAudio": [],
          "sampleRates": [],
          "variants": []
        }
      ],
      "audioPassthrough": [
        {
          "codec": "string",
          "evidence": "string",
          "maxChannels": 0,
          "objectAudio": [],
          "variants": []
        }
      ],
      "embeddedAudioSwitching": true,
      "evidence": "string",
      "liveChannels": true,
      "name": "Fargo",
      "subtitleRendering": [
        "Fargo"
      ],
      "toneMapsHdr": true,
      "transports": [
        {
          "audio": [],
          "containers": [],
          "transport": "string",
          "video": []
        }
      ],
      "version": "string",
      "video": [
        {
          "bitDepths": [],
          "chromaSubsampling": [],
          "codec": "string",
          "codecTags": [],
          "dolbyVisionProfile8Compatibility": [],
          "dolbyVisionProfiles": [],
          "dynamicRanges": [],
          "evidence": "string",
          "frameRateModes": [],
          "interlaced": true,
          "limits": [],
          "maxBitrateBps": 0,
          "maxFrameRate": 0,
          "maxHeight": 0,
          "maxLevel": 0,
          "maxWidth": 0,
          "profiles": []
        }
      ]
    },
    "native": {
      "audio": [
        {
          "codec": "string",
          "evidence": "string",
          "maxBitDepth": 0,
          "maxChannels": 0,
          "maxSampleRate": 0,
          "objectAudio": [],
          "sampleRates": [],
          "variants": []
        }
      ],
      "audioPassthrough": [
        {
          "codec": "string",
          "evidence": "string",
          "maxChannels": 0,
          "objectAudio": [],
          "variants": []
        }
      ],
      "embeddedAudioSwitching": true,
      "evidence": "string",
      "liveChannels": true,
      "name": "Fargo",
      "subtitleRendering": [
        "Fargo"
      ],
      "toneMapsHdr": true,
      "transports": [
        {
          "audio": [],
          "containers": [],
          "transport": "string",
          "video": []
        }
      ],
      "version": "string",
      "video": [
        {
          "bitDepths": [],
          "chromaSubsampling": [],
          "codec": "string",
          "codecTags": [],
          "dolbyVisionProfile8Compatibility": [],
          "dolbyVisionProfiles": [],
          "dynamicRanges": [],
          "evidence": "string",
          "frameRateModes": [],
          "interlaced": true,
          "limits": [],
          "maxBitrateBps": 0,
          "maxFrameRate": 0,
          "maxHeight": 0,
          "maxLevel": 0,
          "maxWidth": 0,
          "profiles": []
        }
      ]
    }
  },
  "maxBitrateBps": 0,
  "overrides": {
    "disableHdr": true,
    "disablePassthrough": true,
    "forceStereo": true
  },
  "version": 0
}'

GET/v1/me/library-navigationRead viewer library navigationread

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

Responses

200Successapplication/json

Example

{
  "pinnedLibraryIds": [
    "string"
  ],
  "revision": 0
}

Schema

pinnedLibraryIdsarray of stringrequired
revisionintegerrequired

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/me/library-navigation" \
  -H "Authorization: Bearer $PORTICO_API_KEY"

PUT/v1/me/library-navigationSave viewer library navigationplayback

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

Request body application/json · required

Example

{
  "expectedRevision": 0,
  "pinnedLibraryIds": [
    "string"
  ]
}

Schema

expectedRevisionintegerrequired
pinnedLibraryIdsarray of stringrequired

Responses

200Successapplication/json

Example

{
  "pinnedLibraryIds": [
    "string"
  ],
  "revision": 0
}

Schema

pinnedLibraryIdsarray of stringrequired
revisionintegerrequired

defaultRequest refused or unavailableapplication/json

Example

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

Schema

errorobjectrequired
- codestringrequired
- messagestringrequired

Error codesinvalid_requestunauthorizednot_permittednot_foundinternaldatabase_busywriter_capacity

Example request

curl -X PUT "http://127.0.0.1:32500/v1/me/library-navigation" \
  -H "Authorization: Bearer $PORTICO_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"expectedRevision":0,"pinnedLibraryIds":["string"]}'

POST/v1/me/recommendations:resetRun viewer recommendations resetplayback

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

Request body application/json · required

Example

{
  "operationId": "id_8h2k4q"
}

Schema

operationIdstringrequired

Responses

200Successapplication/json

Example

{
  "clearedNotInterested": 0,
  "operationId": "id_8h2k4q",
  "receiptLifetimeMs": 1800000,
  "serverId": "id_8h2k4q",
  "viewerFence": "string"
}

Schema

clearedNotInterestedintegerrequired
operationIdstringrequired
receiptLifetimeMsintegerrequired
serverIdstringrequired
viewerFencestringrequired

defaultRequest refused or unavailableapplication/json

Example

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

Schema

errorobjectrequired
- codestringrequired
- messagestringrequired

Error codesinvalid_requestunauthorizednot_permittednot_foundinternaldatabase_busywriter_capacity

Example request

curl -X POST "http://127.0.0.1:32500/v1/me/recommendations:reset" \
  -H "Authorization: Bearer $PORTICO_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"operationId":"id_8h2k4q"}'

DELETE/v1/me/removed-titles/{id}Remove this profile's removed-title Continue referenceplayback

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

Parameters

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

Responses

200Successapplication/json

Example

{
  "removed": true
}

Schema

removedbooleanrequired

defaultRequest refused or unavailableapplication/json

Example

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

Schema

errorobjectrequired
- codestringrequired
- messagestringrequired

Error codesunauthorizednot_permittednot_foundinternaldatabase_busywriter_capacity

Example request

curl -X DELETE "http://127.0.0.1:32500/v1/me/removed-titles/{id}" \
  -H "Authorization: Bearer $PORTICO_API_KEY"

GET/v1/me/removed-titles/{id}Read this profile's removed-title referenceread

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

Parameters

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

Responses

200Successapplication/json

Example

{
  "backdropUrl": "https://example.com/…",
  "canRemoveFromContinue": true,
  "id": "id_8h2k4q",
  "kind": "string",
  "posterUrl": "https://example.com/…",
  "removedAt": "2026-10-18T19:30:00Z",
  "title": "Fargo"
}

Schema

backdropUrlstring
canRemoveFromContinuebooleanrequired
idstringrequired
kindstringrequired
posterUrlstring
removedAtstringrequired
titlestringrequired

defaultRequest refused or unavailableapplication/json

Example

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

Schema

errorobjectrequired
- codestringrequired
- messagestringrequired

Error codesunauthorizednot_permittednot_foundinternaldatabase_busy

Example request

curl -X GET "http://127.0.0.1:32500/v1/me/removed-titles/{id}" \
  -H "Authorization: Bearer $PORTICO_API_KEY"

GET/v1/me/saved/summaryRead private Saved landing countsread

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

Responses

200Successapplication/json

Example

{
  "collections": 0,
  "favorites": {
    "posters": 0,
    "squares": 0
  },
  "myList": {
    "posters": 0,
    "squares": 0
  },
  "playlists": 0,
  "revision": {
    "catalog": 0,
    "viewer": 0
  },
  "savedViews": 0,
  "serverId": "id_8h2k4q",
  "viewerFence": "string"
}

Schema

collectionsintegerrequired
favoritesobjectrequired
- postersintegerrequired
- squaresintegerrequired
myListobjectrequired
- postersintegerrequired
- squaresintegerrequired
playlistsintegerrequired
revisionobjectrequired
- catalogintegerrequired
- viewerintegerrequired
savedViewsintegerrequired
serverIdstringrequired
viewerFencestringrequired

defaultRequest refused or unavailableapplication/json

Example

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

Schema

errorobjectrequired
- codestringrequired
- messagestringrequired

Error codesunauthorizednot_permittednot_foundinternaldatabase_busy

Example request

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