Items
Generated items operations.
GET/v1/itemsRead or update the selected projectionread
- Audience
- Integrations · Native API
- Authorization
- API key or personal access token with the read scope, or a signed-in session
- OpenAPI operation ID
get_items
Parameters
| Name | In | Type | Description |
|---|---|---|---|
libraryId | query | string | |
cursor | query | string | |
limit | query | integer |
Responses
200Successapplication/json
Example
{
"items": [
{
"addedAt": "2026-10-18T19:30:00Z",
"audioFacts": {
"atmos": true,
"bitDepth": 0,
"channels": 0,
"codec": "string",
"layout": "string",
"lossless": true,
"sampleRate": 0
},
"available": true,
"backdropUrl": "https://example.com/…",
"bookFile": {
"bookId": "id_8h2k4q",
"bookTitle": "Fargo",
"discNumber": 0,
"localMetadata": {
"authors": [],
"description": "string",
"edition": "string",
"identifiers": [],
"language": "en",
"narrators": [],
"publishedYear": 0,
"publisher": "string",
"series": [],
"sources": {}
},
"localMetadataIssue": "string",
"localPolicy": {
"localMode": "string",
"revision": 0
},
"partNumber": 0,
"sourceBoundary": "string"
},
"durationMs": 1800000,
"durationState": "unrepresentable",
"episode": {
"airDate": "string",
"localIdentityStatus": "string",
"number": 0,
"numbering": "string",
"orderingBasis": "string",
"providerMatchStatus": "string",
"seasonId": "id_8h2k4q",
"seasonNumber": 0,
"showId": "id_8h2k4q",
"showTitle": "Fargo",
"sourceBoundary": "string"
},
"fileInfoOpening": "string",
"id": "id_8h2k4q",
"kind": "string",
"libraryId": "id_8h2k4q",
"missing": true,
"overview": "string",
"posterUrl": "https://example.com/…",
"progressMs": 1800000,
"song": {
"albumArtist": "string",
"albumId": "id_8h2k4q",
"albumTitle": "Fargo",
"artist": "string",
"discNumber": 0,
"localMetadataIssue": "string",
"providerArtist": "string",
"providerMatchStatus": "string",
"providerObservedAt": "2026-10-18T19:30:00Z",
"providerRecordingId": "id_8h2k4q",
"providerReleaseGroupId": "id_8h2k4q",
"providerReleaseId": "id_8h2k4q",
"providerReleaseStatus": "string",
"providerSourceUrl": "https://example.com/…",
"providerTitle": "Fargo",
"providerTrackId": "id_8h2k4q",
"trackNumber": 0
},
"sources": [
{
"audioCodec": "string",
"container": "string",
"durationMs": 1800000,
"height": 0,
"id": "id_8h2k4q",
"videoCodec": "string",
"width": 0
}
],
"stillUrl": "https://example.com/…",
"title": "Fargo",
"watched": true,
"year": 0
}
],
"nextCursor": "eyJvIjoyMH0"
}Schema
itemsarray of objectrequired
- addedAtstring | any | nullrequired
audioFactsobject
- atmosboolean
- bitDepthinteger
- channelsinteger
- codecstringrequired
- layoutstring
- losslessboolean
- sampleRateinteger
- availablebooleanrequired
- backdropUrlstring
bookFileobject
- bookIdstringrequired
- bookTitlestringrequired
- discNumberinteger
localMetadataobject
- authorsarray of stringrequired
- descriptionstring
- editionstring
identifiersarray of objectrequired
- schemestringrequired
- valuestringrequired
- languagestring
- narratorsarray of stringrequired
- publishedYearinteger
- publisherstring
seriesarray of objectrequired
- namestringrequired
- positionstring
- sourcesobjectrequired
- localMetadataIssuestring
localPolicyobject
- localModestringrequired
- revisionintegerrequired
- partNumberinteger
- sourceBoundarystringrequired
- durationMsinteger≥ 0
- durationStatestringone of "unrepresentable"
episodeobject
- airDatestring
- localIdentityStatusstringrequired
- numberintegerrequired
- numberingstringrequired
- orderingBasisstringrequired
- providerMatchStatusstringrequired
- seasonIdstring
- seasonNumberinteger
- showIdstringrequired
- showTitlestringrequired
- sourceBoundarystringrequired
- fileInfoOpeningstring
- idstringrequired
- kindstringrequired
- libraryIdstringrequired
- missingbooleanrequired
- overviewstring
- posterUrlstring
- progressMsintegerrequired≥ 0
songobject
- albumArtiststringrequired
- albumIdstringrequired
- albumTitlestringrequired
- artiststringrequired
- discNumberinteger
- localMetadataIssuestring
- providerArtiststring
- providerMatchStatusstringrequired
- providerObservedAtstring
- providerRecordingIdstring
- providerReleaseGroupIdstring
- providerReleaseIdstring
- providerReleaseStatusstringrequired
- providerSourceUrlstring
- providerTitlestring
- providerTrackIdstring
- trackNumberinteger
sourcesarray of object
- audioCodecstringrequired
- containerstringrequired
- durationMsintegerrequired≥ 0
- heightintegerrequired
- idstringrequired
- videoCodecstringrequired
- widthintegerrequired
- stillUrlstring
- titlestringrequired
- watchedboolean
- yearinteger
- nextCursorstringrequired
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/items" \
-H "Authorization: Bearer $PORTICO_API_KEY"GET/v1/items/{id}Read or update the selected projectionread
- Audience
- Integrations · Native API
- Authorization
- API key or personal access token with the read scope, or a signed-in session
- OpenAPI operation ID
get_items_id
Parameters
| Name | In | Type | Description |
|---|---|---|---|
idrequired | path | string |
Responses
200Successapplication/json
Example
{
"addedAt": "2026-10-18T19:30:00Z",
"audioFacts": {
"atmos": true,
"bitDepth": 0,
"channels": 0,
"codec": "string",
"layout": "string",
"lossless": true,
"sampleRate": 0
},
"available": true,
"backdropUrl": "https://example.com/…",
"bookFile": {
"bookId": "id_8h2k4q",
"bookTitle": "Fargo",
"discNumber": 0,
"localMetadata": {
"authors": [
"string"
],
"description": "string",
"edition": "string",
"identifiers": [
{
"scheme": "string",
"value": "string"
}
],
"language": "en",
"narrators": [
"string"
],
"publishedYear": 0,
"publisher": "string",
"series": [
{
"name": "Fargo",
"position": "string"
}
],
"sources": {
"key": "string"
}
},
"localMetadataIssue": "string",
"localPolicy": {
"localMode": "string",
"revision": 0
},
"partNumber": 0,
"sourceBoundary": "string"
},
"durationMs": 1800000,
"durationState": "unrepresentable",
"episode": {
"airDate": "string",
"localIdentityStatus": "string",
"number": 0,
"numbering": "string",
"orderingBasis": "string",
"providerMatchStatus": "string",
"seasonId": "id_8h2k4q",
"seasonNumber": 0,
"showId": "id_8h2k4q",
"showTitle": "Fargo",
"sourceBoundary": "string"
},
"fileInfoOpening": "string",
"id": "id_8h2k4q",
"kind": "string",
"libraryId": "id_8h2k4q",
"missing": true,
"overview": "string",
"posterUrl": "https://example.com/…",
"progressMs": 1800000,
"song": {
"albumArtist": "string",
"albumId": "id_8h2k4q",
"albumTitle": "Fargo",
"artist": "string",
"discNumber": 0,
"localMetadataIssue": "string",
"providerArtist": "string",
"providerMatchStatus": "string",
"providerObservedAt": "2026-10-18T19:30:00Z",
"providerRecordingId": "id_8h2k4q",
"providerReleaseGroupId": "id_8h2k4q",
"providerReleaseId": "id_8h2k4q",
"providerReleaseStatus": "string",
"providerSourceUrl": "https://example.com/…",
"providerTitle": "Fargo",
"providerTrackId": "id_8h2k4q",
"trackNumber": 0
},
"sources": [
{
"audioCodec": "string",
"container": "string",
"durationMs": 1800000,
"height": 0,
"id": "id_8h2k4q",
"videoCodec": "string",
"width": 0
}
],
"stillUrl": "https://example.com/…",
"title": "Fargo",
"variant": "item",
"watched": true,
"year": 0
}Schema
- addedAtstring | any | nullrequired
audioFactsobject
- atmosboolean
- bitDepthinteger
- channelsinteger
- codecstringrequired
- layoutstring
- losslessboolean
- sampleRateinteger
- availablebooleanrequired
- backdropUrlstring
bookFileobject
- bookIdstringrequired
- bookTitlestringrequired
- discNumberinteger
localMetadataobject
- authorsarray of stringrequired
- descriptionstring
- editionstring
identifiersarray of objectrequired
- schemestringrequired
- valuestringrequired
- languagestring
- narratorsarray of stringrequired
- publishedYearinteger
- publisherstring
seriesarray of objectrequired
- namestringrequired
- positionstring
- sourcesobjectrequired
- localMetadataIssuestring
localPolicyobject
- localModestringrequired
- revisionintegerrequired
- partNumberinteger
- sourceBoundarystringrequired
- durationMsinteger≥ 0
- durationStatestringone of "unrepresentable"
episodeobject
- airDatestring
- localIdentityStatusstringrequired
- numberintegerrequired
- numberingstringrequired
- orderingBasisstringrequired
- providerMatchStatusstringrequired
- seasonIdstring
- seasonNumberinteger
- showIdstringrequired
- showTitlestringrequired
- sourceBoundarystringrequired
- fileInfoOpeningstring
- idstringrequired
- kindstringrequired
- libraryIdstringrequired
- missingbooleanrequired
- overviewstring
- posterUrlstring
- progressMsintegerrequired≥ 0
songobject
- albumArtiststringrequired
- albumIdstringrequired
- albumTitlestringrequired
- artiststringrequired
- discNumberinteger
- localMetadataIssuestring
- providerArtiststring
- providerMatchStatusstringrequired
- providerObservedAtstring
- providerRecordingIdstring
- providerReleaseGroupIdstring
- providerReleaseIdstring
- providerReleaseStatusstringrequired
- providerSourceUrlstring
- providerTitlestring
- providerTrackIdstring
- trackNumberinteger
sourcesarray of object
- audioCodecstringrequired
- containerstringrequired
- durationMsintegerrequired≥ 0
- heightintegerrequired
- idstringrequired
- videoCodecstringrequired
- widthintegerrequired
- stillUrlstring
- titlestringrequired
- variant"item"required
- watchedboolean
- yearinteger
202Successapplication/json
Example
{
"detail": {
"revision": {
"catalog": 0,
"viewer": 0
},
"scope": {
"itemId": "id_8h2k4q",
"libraryId": "id_8h2k4q",
"serverId": "id_8h2k4q",
"viewerFence": "string"
}
},
"kind": "file-info-preparing",
"queryId": "id_8h2k4q",
"retryAfterMs": 1800000,
"state": "preparing",
"variant": "preparing"
}Schema
detailobject
revisionobjectrequired
- catalogintegerrequired
- viewerintegerrequired
scopeobjectrequired
- itemIdstringrequired
- libraryIdstringrequired
- serverIdstringrequired
- viewerFencestringrequired
- kind"file-info-preparing"required
- queryIdstringrequiredlength 1–512pattern ^[A-Za-z0-9_.-]+$
- retryAfterMsintegerrequired≥ 1
- state"preparing"required
- variant"preparing"required
304Successapplication/json
Example
{
"addedAt": "2026-10-18T19:30:00Z",
"audioFacts": {
"atmos": true,
"bitDepth": 0,
"channels": 0,
"codec": "string",
"layout": "string",
"lossless": true,
"sampleRate": 0
},
"available": true,
"backdropUrl": "https://example.com/…",
"bookFile": {
"bookId": "id_8h2k4q",
"bookTitle": "Fargo",
"discNumber": 0,
"localMetadata": {
"authors": [
"string"
],
"description": "string",
"edition": "string",
"identifiers": [
{
"scheme": "string",
"value": "string"
}
],
"language": "en",
"narrators": [
"string"
],
"publishedYear": 0,
"publisher": "string",
"series": [
{
"name": "Fargo",
"position": "string"
}
],
"sources": {
"key": "string"
}
},
"localMetadataIssue": "string",
"localPolicy": {
"localMode": "string",
"revision": 0
},
"partNumber": 0,
"sourceBoundary": "string"
},
"durationMs": 1800000,
"durationState": "unrepresentable",
"episode": {
"airDate": "string",
"localIdentityStatus": "string",
"number": 0,
"numbering": "string",
"orderingBasis": "string",
"providerMatchStatus": "string",
"seasonId": "id_8h2k4q",
"seasonNumber": 0,
"showId": "id_8h2k4q",
"showTitle": "Fargo",
"sourceBoundary": "string"
},
"fileInfoOpening": "string",
"id": "id_8h2k4q",
"kind": "string",
"libraryId": "id_8h2k4q",
"missing": true,
"overview": "string",
"posterUrl": "https://example.com/…",
"progressMs": 1800000,
"song": {
"albumArtist": "string",
"albumId": "id_8h2k4q",
"albumTitle": "Fargo",
"artist": "string",
"discNumber": 0,
"localMetadataIssue": "string",
"providerArtist": "string",
"providerMatchStatus": "string",
"providerObservedAt": "2026-10-18T19:30:00Z",
"providerRecordingId": "id_8h2k4q",
"providerReleaseGroupId": "id_8h2k4q",
"providerReleaseId": "id_8h2k4q",
"providerReleaseStatus": "string",
"providerSourceUrl": "https://example.com/…",
"providerTitle": "Fargo",
"providerTrackId": "id_8h2k4q",
"trackNumber": 0
},
"sources": [
{
"audioCodec": "string",
"container": "string",
"durationMs": 1800000,
"height": 0,
"id": "id_8h2k4q",
"videoCodec": "string",
"width": 0
}
],
"stillUrl": "https://example.com/…",
"title": "Fargo",
"variant": "item",
"watched": true,
"year": 0
}Schema
- addedAtstring | any | nullrequired
audioFactsobject
- atmosboolean
- bitDepthinteger
- channelsinteger
- codecstringrequired
- layoutstring
- losslessboolean
- sampleRateinteger
- availablebooleanrequired
- backdropUrlstring
bookFileobject
- bookIdstringrequired
- bookTitlestringrequired
- discNumberinteger
localMetadataobject
- authorsarray of stringrequired
- descriptionstring
- editionstring
identifiersarray of objectrequired
- schemestringrequired
- valuestringrequired
- languagestring
- narratorsarray of stringrequired
- publishedYearinteger
- publisherstring
seriesarray of objectrequired
- namestringrequired
- positionstring
- sourcesobjectrequired
- localMetadataIssuestring
localPolicyobject
- localModestringrequired
- revisionintegerrequired
- partNumberinteger
- sourceBoundarystringrequired
- durationMsinteger≥ 0
- durationStatestringone of "unrepresentable"
episodeobject
- airDatestring
- localIdentityStatusstringrequired
- numberintegerrequired
- numberingstringrequired
- orderingBasisstringrequired
- providerMatchStatusstringrequired
- seasonIdstring
- seasonNumberinteger
- showIdstringrequired
- showTitlestringrequired
- sourceBoundarystringrequired
- fileInfoOpeningstring
- idstringrequired
- kindstringrequired
- libraryIdstringrequired
- missingbooleanrequired
- overviewstring
- posterUrlstring
- progressMsintegerrequired≥ 0
songobject
- albumArtiststringrequired
- albumIdstringrequired
- albumTitlestringrequired
- artiststringrequired
- discNumberinteger
- localMetadataIssuestring
- providerArtiststring
- providerMatchStatusstringrequired
- providerObservedAtstring
- providerRecordingIdstring
- providerReleaseGroupIdstring
- providerReleaseIdstring
- providerReleaseStatusstringrequired
- providerSourceUrlstring
- providerTitlestring
- providerTrackIdstring
- trackNumberinteger
sourcesarray of object
- audioCodecstringrequired
- containerstringrequired
- durationMsintegerrequired≥ 0
- heightintegerrequired
- idstringrequired
- videoCodecstringrequired
- widthintegerrequired
- stillUrlstring
- titlestringrequired
- variant"item"required
- watchedboolean
- yearinteger
defaultRequest refused or unavailableapplication/json
Example
{
"error": {
"code": "string",
"message": "string"
}
}Schema
errorobjectrequired
- codestringrequired
- messagestringrequired
Error codesinvalid_requestunauthorizednot_permittednot_foundinternalstale_continuationmetadata_unavailabledatabase_busy
Example request
curl -X GET "http://127.0.0.1:32500/v1/items/{id}" \
-H "Authorization: Bearer $PORTICO_API_KEY"GET/v1/items/{id}/analysisRead title analysisread
- Audience
- Clients · Native API
- Authorization
- API key or personal access token with the read scope, or a signed-in session
- OpenAPI operation ID
get_items_id_analysis
Parameters
| Name | In | Type | Description |
|---|---|---|---|
idrequired | path | string | |
sourceId | query | string | |
sourceRevision | query | string | |
mappingRevision | query | string | |
sessionId | query | string | |
generation | query | string | |
positionUS | query | string |
Responses
200Successapplication/json
Example
{
"budgets": {
"key": null
},
"canManage": true,
"jobs": [
{
"attempt": 0,
"errorCode": "string",
"jobId": "id_8h2k4q",
"jobStatus": "string",
"processedBytes": "string",
"stage": "string",
"state": "string",
"updatedMS": 1800000
}
],
"markerRevision": 0,
"markers": [
{
"approved": true,
"confidence": 0,
"edited": true,
"endUS": "string",
"id": "id_8h2k4q",
"kind": "string",
"provenance": "string",
"startUS": "string",
"title": "Fargo"
}
],
"policy": {
"operations": [
"string"
],
"revision": 0,
"tier": "string",
"trickplay": {
"intervalMs": 1800000,
"maxTiles": 0,
"tileWidth": 0
}
},
"previews": [
{
"endUS": "string",
"height": 0,
"id": "id_8h2k4q",
"kind": "string",
"startUS": "string",
"width": 0
}
],
"results": [
{
"algorithm": "string",
"artifactId": "id_8h2k4q",
"createdMS": 1800000,
"originAssurance": "string",
"stage": "string",
"summary": null
}
],
"scope": {
"itemId": "id_8h2k4q",
"libraryId": "id_8h2k4q",
"serverId": "id_8h2k4q",
"sessionGeneration": 0,
"sessionId": "id_8h2k4q",
"viewerFence": "string"
},
"source": {
"durationUS": "string",
"id": "id_8h2k4q",
"mappingRevision": "r12",
"needsProbe": true,
"revision": "r12"
},
"sources": [
{
"id": "id_8h2k4q",
"label": "string"
}
]
}Schema
- budgetsobjectrequired
- canManagebooleanrequired
jobsarray of objectrequired
- attemptintegerrequired
- errorCodestringrequired
- jobIdstringrequired
- jobStatusstringrequired
- processedBytesstringrequired
- stagestringrequired
- statestringrequired
- updatedMSintegerrequired
- markerRevisionintegerrequired
markersarray of objectrequired
- approvedbooleanrequired
- confidencenumberrequired
- editedbooleanrequired
- endUSstringrequired
- idstringrequired
- kindstringrequired
- provenancestringrequired
- startUSstringrequired
- titlestringrequired
policyobjectrequired
- operationsarray of stringrequired
- revisionintegerrequired
- tierstringrequired
trickplayobjectrequired
- intervalMsintegerrequired≥ 0
- maxTilesintegerrequired
- tileWidthintegerrequired
previewsarray of objectrequired
- endUSstringrequired
- heightintegerrequired
- idstringrequired
- kindstringrequired
- startUSstringrequired
- widthintegerrequired
resultsarray of objectrequired
- algorithmstringrequired
- artifactIdstring
- createdMSintegerrequired
- originAssurancestringrequired
- stagestringrequired
- summaryanyrequired
scopeobjectrequired
- itemIdstringrequired
- libraryIdstringrequired
- serverIdstringrequired
- sessionGenerationintegerrequired
- sessionIdstringrequired
- viewerFencestringrequired
sourceobjectrequired
- durationUSstringrequired
- idstringrequired
- mappingRevisionstringrequired
- needsProbebooleanrequired
- revisionstringrequired
sourcesarray of objectrequired
- idstringrequired
- labelstringrequired
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/items/{id}/analysis" \
-H "Authorization: Bearer $PORTICO_API_KEY"GET/v1/items/{id}/analysis/artifacts/{artifact}Read title analysis artifactsread
- Audience
- Clients · Native API
- Authorization
- API key or personal access token with the read scope, or a signed-in session
- OpenAPI operation ID
get_items_id_analysis_artifacts_artifact
Parameters
| Name | In | Type | Description |
|---|---|---|---|
idrequired | path | string | |
artifactrequired | path | string | |
sourceId | query | string | |
sourceRevision | query | string | |
mappingRevision | query | string | |
sessionId | query | string | |
generation | query | string | |
positionUS | query | string |
Responses
200Successapplication/json
Example
{
"data": "string",
"document": null,
"id": "id_8h2k4q",
"kind": "string",
"mime": "string",
"scope": {
"itemId": "id_8h2k4q",
"libraryId": "id_8h2k4q",
"serverId": "id_8h2k4q",
"sessionGeneration": 0,
"sessionId": "id_8h2k4q",
"viewerFence": "string"
},
"source": {
"durationUS": "string",
"id": "id_8h2k4q",
"mappingRevision": "r12",
"needsProbe": true,
"revision": "r12"
}
}Schema
- datastring
- documentany
- idstringrequired
- kindstringrequired
- mimestringrequired
scopeobjectrequired
- itemIdstringrequired
- libraryIdstringrequired
- serverIdstringrequired
- sessionGenerationintegerrequired
- sessionIdstringrequired
- viewerFencestringrequired
sourceobjectrequired
- durationUSstringrequired
- idstringrequired
- mappingRevisionstringrequired
- needsProbebooleanrequired
- revisionstringrequired
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/items/{id}/analysis/artifacts/{artifact}" \
-H "Authorization: Bearer $PORTICO_API_KEY"POST/v1/items/{id}/analysis/jobsRun title analysis jobslibrary
- Audience
- Clients · Native API
- Authorization
- API key or personal access token with the library scope, or a signed-in session
- OpenAPI operation ID
post_items_id_analysis_jobs- Max body
- 2 MiB
Parameters
| Name | In | Type | Description |
|---|---|---|---|
idrequired | path | string |
Request body application/json · required
Example
{
"action": "string",
"generation": 0,
"mappingRevision": "r12",
"sessionId": "id_8h2k4q",
"sourceId": "id_8h2k4q",
"sourceRevision": "r12"
}Schema
- actionstringrequired
- generationintegerrequired
- mappingRevisionstringrequired
- sessionIdstringrequired
- sourceIdstringrequired
- sourceRevisionstringrequired
Responses
202Successapplication/json
Example
{
"analyzed": 0,
"error": "string",
"id": "id_8h2k4q",
"jobs": [
"string"
],
"phase": "string",
"processed": 0,
"scanMode": "string",
"sourceId": "id_8h2k4q",
"status": "string",
"warnings": 0
}Schema
- analyzedintegerrequired
- errorstring
- idstringrequired
- jobsarray of string
- phasestring
- processedintegerrequired
- scanModestring
- sourceIdstring
- statusstringrequired
- warningsintegerrequired
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/items/{id}/analysis/jobs" \
-H "Authorization: Bearer $PORTICO_API_KEY" \
-H "Content-Type: application/json" \
-d '{"action":"string","generation":0,"mappingRevision":"r12","sessionId":"id_8h2k4q","sourceId":"id_8h2k4q","sourceRevision":"r12"}'POST/v1/items/{id}/analysis/jobs/{job}/controlRun title analysis jobs controllibrary
- Audience
- Clients · Native API
- Authorization
- API key or personal access token with the library scope, or a signed-in session
- OpenAPI operation ID
post_items_id_analysis_jobs_job_control- Max body
- 2 MiB
Parameters
| Name | In | Type | Description |
|---|---|---|---|
idrequired | path | string | |
jobrequired | path | string |
Request body application/json · required
Example
{
"action": "string",
"generation": 0,
"mappingRevision": "r12",
"sessionId": "id_8h2k4q",
"sourceId": "id_8h2k4q",
"sourceRevision": "r12"
}Schema
- actionstringrequired
- generationintegerrequired
- mappingRevisionstringrequired
- sessionIdstringrequired
- sourceIdstringrequired
- sourceRevisionstringrequired
Responses
200Successapplication/json
Example
{
"analyzed": 0,
"error": "string",
"id": "id_8h2k4q",
"jobs": [
"string"
],
"phase": "string",
"processed": 0,
"scanMode": "string",
"sourceId": "id_8h2k4q",
"status": "string",
"variant": "job",
"warnings": 0
}Schema
- analyzedintegerrequired
- errorstring
- idstringrequired
- jobsarray of string
- phasestring
- processedintegerrequired
- scanModestring
- sourceIdstring
- statusstringrequired
- variant"job"required
- warningsintegerrequired
202Successapplication/json
Example
{
"analyzed": 0,
"error": "string",
"id": "id_8h2k4q",
"jobs": [
"string"
],
"phase": "string",
"processed": 0,
"scanMode": "string",
"sourceId": "id_8h2k4q",
"status": "string",
"variant": "job",
"warnings": 0
}Schema
- analyzedintegerrequired
- errorstring
- idstringrequired
- jobsarray of string
- phasestring
- processedintegerrequired
- scanModestring
- sourceIdstring
- statusstringrequired
- variant"job"required
- warningsintegerrequired
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/items/{id}/analysis/jobs/{job}/control" \
-H "Authorization: Bearer $PORTICO_API_KEY" \
-H "Content-Type: application/json" \
-d '{"action":"string","generation":0,"mappingRevision":"r12","sessionId":"id_8h2k4q","sourceId":"id_8h2k4q","sourceRevision":"r12"}'POST/v1/items/{id}/analysis/markersRun title analysis markerslibrary
- Audience
- Clients · Native API
- Authorization
- API key or personal access token with the library scope, or a signed-in session
- OpenAPI operation ID
post_items_id_analysis_markers- Max body
- 2 MiB
Parameters
| Name | In | Type | Description |
|---|---|---|---|
idrequired | path | string |
Request body application/json · required
Example
{
"action": "string",
"endUS": "string",
"expectedRevision": 0,
"generation": 0,
"kind": "string",
"mappingRevision": "r12",
"markerId": "id_8h2k4q",
"requestId": "id_8h2k4q",
"sessionId": "id_8h2k4q",
"sourceId": "id_8h2k4q",
"sourceRevision": "r12",
"startUS": "string",
"title": "Fargo"
}Schema
- actionstringrequired
- endUSstringrequired
- expectedRevisionintegerrequired
- generationintegerrequired
- kindstringrequired
- mappingRevisionstringrequired
- markerIdstringrequired
- requestIdstringrequired
- sessionIdstringrequired
- sourceIdstringrequired
- sourceRevisionstringrequired
- startUSstringrequired
- titlestringrequired
Responses
200Successapplication/json
Example
{
"markerId": "id_8h2k4q",
"markerRevision": 0
}Schema
- markerIdstringrequired
- markerRevisionintegerrequired
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/items/{id}/analysis/markers" \
-H "Authorization: Bearer $PORTICO_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"action": "string",
"endUS": "string",
"expectedRevision": 0,
"generation": 0,
"kind": "string",
"mappingRevision": "r12",
"markerId": "id_8h2k4q",
"requestId": "id_8h2k4q",
"sessionId": "id_8h2k4q",
"sourceId": "id_8h2k4q",
"sourceRevision": "r12",
"startUS": "string",
"title": "Fargo"
}'PUT/v1/items/{id}/analysis/policySave title analysis policylibrary
- Audience
- Clients · Native API
- Authorization
- API key or personal access token with the library scope, or a signed-in session
- OpenAPI operation ID
put_items_id_analysis_policy- Max body
- 2 MiB
Parameters
| Name | In | Type | Description |
|---|---|---|---|
idrequired | path | string |
Request body application/json · required
Example
{
"expectedRevision": 0,
"generation": 0,
"mappingRevision": "r12",
"operations": [
"string"
],
"sessionId": "id_8h2k4q",
"sourceId": "id_8h2k4q",
"sourceRevision": "r12",
"tier": "string",
"trickplay": {
"intervalMs": 1800000,
"maxTiles": 0,
"tileWidth": 0
}
}Schema
- expectedRevisionintegerrequired
- generationintegerrequired
- mappingRevisionstringrequired
- operationsarray of stringrequired
- sessionIdstringrequired
- sourceIdstringrequired
- sourceRevisionstringrequired
- tierstringrequired
trickplayobjectrequired
- intervalMsintegerrequired≥ 0
- maxTilesintegerrequired
- tileWidthintegerrequired
Responses
200Successapplication/json
Example
{
"operations": [
"string"
],
"revision": 0,
"tier": "string",
"trickplay": {
"intervalMs": 1800000,
"maxTiles": 0,
"tileWidth": 0
}
}Schema
- operationsarray of stringrequired
- revisionintegerrequired
- tierstringrequired
trickplayobjectrequired
- intervalMsintegerrequired≥ 0
- maxTilesintegerrequired
- tileWidthintegerrequired
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/items/{id}/analysis/policy" \
-H "Authorization: Bearer $PORTICO_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"expectedRevision": 0,
"generation": 0,
"mappingRevision": "r12",
"operations": [
"string"
],
"sessionId": "id_8h2k4q",
"sourceId": "id_8h2k4q",
"sourceRevision": "r12",
"tier": "string",
"trickplay": {
"intervalMs": 1800000,
"maxTiles": 0,
"tileWidth": 0
}
}'GET/v1/items/{id}/art/{kind}Read title artread
- Audience
- Integrations · Native API
- Authorization
- API key or personal access token with the read scope, or a signed-in session
- OpenAPI operation ID
get_items_id_art_kind
Parameters
| Name | In | Type | Description |
|---|---|---|---|
idrequired | path | string | |
kindrequired | path | string | |
ld | query | string | |
r | query | string | |
sd | query | string | |
size | query | string | |
v | query | string | |
w | query | string |
Responses
200Successapplication/octet-stream
Example
"string"Schema
string (binary)
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/items/{id}/art/{kind}" \
-H "Authorization: Bearer $PORTICO_API_KEY"GET/v1/items/{id}/chapters/{chapter}/imageRead or change authorized subtitlesread
- Audience
- Clients · Native API
- Authorization
- API key or personal access token with the read scope, or a signed-in session
- OpenAPI operation ID
get_v1_items_id_chapters_chapter_image
Parameters
| Name | In | Type | Description |
|---|---|---|---|
idrequired | path | string | |
chapterrequired | path | string | |
segment | query | string |
Responses
200Successimage/jpeg
Example
"string"Schema
string (binary)
defaultRequest refused or unavailableapplication/json
Example
{
"error": {
"code": "string",
"message": "string"
}
}Schema
errorobjectrequired
- codestringrequired
- messagestringrequired
Error codesunauthorizednot_permittednot_foundinvalid_requestinternalsubtitle_unavailablesubtitle_not_foundsubtitle_renderer_platform_unsupportedsubtitle_renderer_configurationsubtitle_conflictsubtitle_operation_conflictsubtitle_capacitysubtitle_unsupportedsubtitle_invalid_inputsubtitle_provider_not_configuredsubtitle_provider_key_rejectedsubtitle_provider_sign_in_failedsubtitle_provider_sign_in_requiredsubtitle_provider_quotasubtitle_provider_busydatabase_busy
Example request
curl -X GET "http://127.0.0.1:32500/v1/items/{id}/chapters/{chapter}/image" \
-H "Authorization: Bearer $PORTICO_API_KEY"GET/v1/items/{id}/creditsRead title creditsread
- Audience
- Clients · Native API
- Authorization
- API key or personal access token with the read scope, or a signed-in session
- OpenAPI operation ID
get_items_id_credits
Parameters
| Name | In | Type | Description |
|---|---|---|---|
idrequired | path | string | |
cursor | query | string | |
group | query | string | |
limit | query | integer |
Responses
200Successapplication/json
Example
{
"credits": [
{
"department": "string",
"id": "id_8h2k4q",
"name": "Fargo",
"personId": "id_8h2k4q",
"portraitUrl": "https://example.com/…",
"provider": "string",
"role": "string"
}
],
"group": "string",
"nextCursor": "eyJvIjoyMH0",
"revision": {
"catalog": 0,
"viewer": 0
},
"total": 0
}Schema
creditsarray of objectrequired
- departmentstringrequired
- idstringrequired
- namestringrequired
- personIdstring
- portraitUrlstring
- providerstringrequired
- rolestringrequired
- groupstringrequired
- nextCursorstring
revisionobjectrequired
- catalogintegerrequired
- viewerintegerrequired
- totalintegerrequired
defaultRequest refused or unavailableapplication/json
Example
{
"error": {
"code": "string",
"message": "string"
}
}Schema
errorobjectrequired
- codestringrequired
- messagestringrequired
Error codesinvalid_requestunauthorizednot_permittednot_foundinternaldatabase_busy
Example request
curl -X GET "http://127.0.0.1:32500/v1/items/{id}/credits" \
-H "Authorization: Bearer $PORTICO_API_KEY"POST/v1/items/{id}/deleteDelete a title’s fileslibrary
- Audience
- Clients · Native API
- Authorization
- API key or personal access token with the library scope, or a signed-in session
- OpenAPI operation ID
post_items_id_delete- Max body
- 64 KiB
Parameters
| Name | In | Type | Description |
|---|---|---|---|
idrequired | path | string |
Request body application/json · required
Example
{
"confirmation": "string",
"deleteFiles": true,
"expectedRevision": 0,
"itemIds": [
"string"
],
"operationId": "id_8h2k4q"
}Schema
- confirmationstringrequired
- deleteFilesbooleanrequired
- expectedRevisionintegerrequired
- itemIdsarray of stringrequired
- operationIdstringrequired
Responses
200Successapplication/json
Example
{
"protocolVersion": "string",
"result": {
"bytesDeleted": 0,
"failed": 0,
"filesRetained": true,
"receipts": [
{
"bytes": 0,
"code": "string",
"filesDeleted": 0,
"filesKept": 0,
"itemId": "id_8h2k4q",
"removed": true,
"title": "Fargo"
}
],
"removed": 0,
"revision": 0
},
"serverId": "id_8h2k4q"
}Schema
- protocolVersionstringrequired
resultobjectrequired
- bytesDeletedintegerrequired
- failedintegerrequired
- filesRetainedbooleanrequired
receiptsarray of objectrequired
- bytesintegerrequired
- codestring
- filesDeletedintegerrequired
- filesKeptintegerrequired
- itemIdstringrequired
- removedbooleanrequired
- titlestringrequired
- removedintegerrequired
- revisionintegerrequired
- serverIdstringrequired
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/items/{id}/delete" \
-H "Authorization: Bearer $PORTICO_API_KEY" \
-H "Content-Type: application/json" \
-d '{"confirmation":"string","deleteFiles":true,"expectedRevision":0,"itemIds":["string"],"operationId":"id_8h2k4q"}'POST/v1/items/{id}/delete/previewPreview deleting a title’s fileslibrary
- Audience
- Clients · Native API
- Authorization
- API key or personal access token with the library scope, or a signed-in session
- OpenAPI operation ID
post_items_id_delete_preview
Parameters
| Name | In | Type | Description |
|---|---|---|---|
idrequired | path | string |
Responses
200Successapplication/json
Example
{
"protocolVersion": "string",
"result": {
"blocked": [
"string"
],
"confirmation": "string",
"confirmationKind": "string",
"revision": 0,
"targets": [
{
"allowMediaDeletion": true,
"bytes": 0,
"dependents": [
{}
],
"files": [
{}
],
"itemId": "id_8h2k4q",
"kind": "string",
"libraryId": "id_8h2k4q",
"libraryName": "Fargo",
"title": "Fargo",
"titles": 0
}
],
"totalBytes": 0,
"totalBytesText": "string",
"totalFiles": 0
},
"serverId": "id_8h2k4q"
}Schema
- protocolVersionstringrequired
resultobjectrequired
- blockedarray of stringrequired
- confirmationstringrequired
- confirmationKindstringrequired
- revisionintegerrequired
targetsarray of objectrequired
- allowMediaDeletionbooleanrequired
- bytesintegerrequired
dependentsarray of objectrequired
- countintegerrequired
- descriptionstringrequired
- kindstringrequired
filesarray of objectrequired
- assetIdstringrequired
- bytesintegerrequired
- pathstringrequired
- presentbooleanrequired
- sharedbooleanrequired
- itemIdstringrequired
- kindstringrequired
- libraryIdstringrequired
- libraryNamestringrequired
- titlestringrequired
- titlesintegerrequired
- totalBytesintegerrequired
- totalBytesTextstringrequired
- totalFilesintegerrequired
- serverIdstringrequired
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/items/{id}/delete/preview" \
-H "Authorization: Bearer $PORTICO_API_KEY"GET/v1/items/{id}/detailRead or update the selected projectionread
- Audience
- Integrations · Native API
- Authorization
- API key or personal access token with the read scope, or a signed-in session
- OpenAPI operation ID
get_items_id_detail
Parameters
| Name | In | Type | Description |
|---|---|---|---|
idrequired | path | string | |
related | query | string |
Responses
200Successapplication/json
Example
{
"actions": [
{
"enabled": true,
"id": "id_8h2k4q",
"labelKey": "string",
"max": 0,
"min": 0,
"playback": {
"itemId": "id_8h2k4q",
"startMs": 1800000
},
"step": 0
}
],
"collections": [
{
"id": "id_8h2k4q",
"memberCount": 0,
"name": "Fargo",
"position": 0,
"posterUrls": [
"https://example.com/…"
],
"yearFrom": 0,
"yearTo": 0
}
],
"episodeDetails": {
"contentRating": "string",
"next": {
"id": "id_8h2k4q",
"number": 0,
"title": "Fargo"
},
"previous": {
"id": "id_8h2k4q",
"number": 0,
"title": "Fargo"
}
},
"extras": [
{
"items": [
{
"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
}
],
"label": "string",
"type": "string"
}
],
"facts": {
"contentRating": "string",
"country": "string",
"edition": "string",
"network": "string",
"originalLanguage": "en",
"originalTitle": "Fargo",
"releaseDate": "string",
"studio": "string",
"tagline": "string"
},
"fileInfoOpening": "string",
"item": {
"addedAt": "2026-10-18T19:30:00Z",
"audioFacts": {
"atmos": true,
"bitDepth": 0,
"channels": 0,
"codec": "string",
"layout": "string",
"lossless": true,
"sampleRate": 0
},
"available": true,
"backdropUrl": "https://example.com/…",
"bookFile": {
"bookId": "id_8h2k4q",
"bookTitle": "Fargo",
"discNumber": 0,
"localMetadata": {
"authors": [
"string"
],
"description": "string",
"edition": "string",
"identifiers": [
{}
],
"language": "en",
"narrators": [
"string"
],
"publishedYear": 0,
"publisher": "string",
"series": [
{}
],
"sources": {
"key": "string"
}
},
"localMetadataIssue": "string",
"localPolicy": {
"localMode": "string",
"revision": 0
},
"partNumber": 0,
"sourceBoundary": "string"
},
"durationMs": 1800000,
"durationState": "unrepresentable",
"episode": {
"airDate": "string",
"localIdentityStatus": "string",
"number": 0,
"numbering": "string",
"orderingBasis": "string",
"providerMatchStatus": "string",
"seasonId": "id_8h2k4q",
"seasonNumber": 0,
"showId": "id_8h2k4q",
"showTitle": "Fargo",
"sourceBoundary": "string"
},
"fileInfoOpening": "string",
"id": "id_8h2k4q",
"kind": "string",
"libraryId": "id_8h2k4q",
"missing": true,
"overview": "string",
"posterUrl": "https://example.com/…",
"progressMs": 1800000,
"song": {
"albumArtist": "string",
"albumId": "id_8h2k4q",
"albumTitle": "Fargo",
"artist": "string",
"discNumber": 0,
"localMetadataIssue": "string",
"providerArtist": "string",
"providerMatchStatus": "string",
"providerObservedAt": "2026-10-18T19:30:00Z",
"providerRecordingId": "id_8h2k4q",
"providerReleaseGroupId": "id_8h2k4q",
"providerReleaseId": "id_8h2k4q",
"providerReleaseStatus": "string",
"providerSourceUrl": "https://example.com/…",
"providerTitle": "Fargo",
"providerTrackId": "id_8h2k4q",
"trackNumber": 0
},
"sources": [
{
"audioCodec": "string",
"container": "string",
"durationMs": 1800000,
"height": 0,
"id": "id_8h2k4q",
"videoCodec": "string",
"width": 0
}
],
"stillUrl": "https://example.com/…",
"title": "Fargo",
"watched": true,
"year": 0
},
"languages": {
"audio": [
"string"
],
"subtitles": [
"Fargo"
]
},
"markers": [
{
"automaticSafe": true,
"endMs": 1800000,
"id": "id_8h2k4q",
"kind": "string",
"startMs": 1800000
}
],
"metadata": {
"attributions": [
"string"
],
"creditTotals": {
"cast": 0,
"crew": 0
},
"credits": [
{
"department": "string",
"id": "id_8h2k4q",
"name": "Fargo",
"personId": "id_8h2k4q",
"portraitUrl": "https://example.com/…",
"provider": "string",
"role": "string"
}
],
"genres": [
{
"id": "id_8h2k4q",
"name": "Fargo",
"provider": "string"
}
],
"ratings": [
{
"max": 0,
"observedAt": "2026-10-18T19:30:00Z",
"provider": "string",
"sourceUrl": "https://example.com/…",
"value": 0,
"votes": 0
}
],
"sources": [
{
"observedAt": "2026-10-18T19:30:00Z",
"provider": "string",
"sourceUrl": "https://example.com/…"
}
],
"status": "string"
},
"missingSince": "string",
"personal": {
"conflicts": [
{
"baseRevision": 0,
"baseValue": null,
"choices": [
{}
],
"field": "string",
"id": "id_8h2k4q"
}
],
"continueDismissed": true,
"favorite": true,
"lastPlayedAt": "2026-10-18T19:30:00Z",
"notInterested": true,
"progressMs": 1800000,
"rating": 0,
"revision": 0,
"status": "string",
"watched": true,
"watchlisted": true
},
"related": {
"libraryId": "id_8h2k4q",
"libraryName": "Fargo",
"rows": [
{
"entries": [
{}
],
"evidenceId": "id_8h2k4q",
"hasMore": true,
"heading": "string",
"headingText": {
"code": "string",
"fallback": "string",
"params": {}
},
"id": "id_8h2k4q",
"nextCursor": "eyJvIjoyMH0",
"provider": "string",
"relation": "string"
}
],
"version": 0
},
"revision": {
"catalog": 0,
"viewer": 0
},
"scope": {
"itemId": "id_8h2k4q",
"libraryId": "id_8h2k4q",
"serverId": "id_8h2k4q",
"viewerFence": "string"
},
"variant": "detail"
}Schema
actionsarray of objectrequired
- enabledbooleanrequired
- idstringrequired
- labelKeystringrequired
- maxnumber
- minnumber
playbackobject
- itemIdstringrequired
- startMsinteger≥ 0
- stepnumber
collectionsarray of objectrequired
- idstringrequired
- memberCountintegerrequired
- namestringrequired
- positionintegerrequired
- posterUrlsarray of stringrequired
- yearFrominteger
- yearTointeger
episodeDetailsobject
- contentRatingstring
nextobject
- idstringrequired
- numberintegerrequired
- titlestringrequired
previousobject
- idstringrequired
- numberintegerrequired
- titlestringrequired
extrasarray of object
itemsarray 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
- labelstringrequired
- typestringrequired
factsobject
- contentRatingstring
- countrystring
- editionstring
- networkstring
- originalLanguagestring
- originalTitlestring
- releaseDatestring
- studiostring
- taglinestring
- fileInfoOpeningstring
itemobjectrequired
- addedAtstring | any | nullrequired
audioFactsobject
- atmosboolean
- bitDepthinteger
- channelsinteger
- codecstringrequired
- layoutstring
- losslessboolean
- sampleRateinteger
- availablebooleanrequired
- backdropUrlstring
bookFileobject
- bookIdstringrequired
- bookTitlestringrequired
- discNumberinteger
localMetadataobject
- authorsarray of stringrequired
- descriptionstring
- editionstring
identifiersarray of objectrequired
- schemestringrequired
- valuestringrequired
- languagestring
- narratorsarray of stringrequired
- publishedYearinteger
- publisherstring
seriesarray of objectrequired
- namestringrequired
- positionstring
- sourcesobjectrequired
- localMetadataIssuestring
localPolicyobject
- localModestringrequired
- revisionintegerrequired
- partNumberinteger
- sourceBoundarystringrequired
- durationMsinteger≥ 0
- durationStatestringone of "unrepresentable"
episodeobject
- airDatestring
- localIdentityStatusstringrequired
- numberintegerrequired
- numberingstringrequired
- orderingBasisstringrequired
- providerMatchStatusstringrequired
- seasonIdstring
- seasonNumberinteger
- showIdstringrequired
- showTitlestringrequired
- sourceBoundarystringrequired
- fileInfoOpeningstring
- idstringrequired
- kindstringrequired
- libraryIdstringrequired
- missingbooleanrequired
- overviewstring
- posterUrlstring
- progressMsintegerrequired≥ 0
songobject
- albumArtiststringrequired
- albumIdstringrequired
- albumTitlestringrequired
- artiststringrequired
- discNumberinteger
- localMetadataIssuestring
- providerArtiststring
- providerMatchStatusstringrequired
- providerObservedAtstring
- providerRecordingIdstring
- providerReleaseGroupIdstring
- providerReleaseIdstring
- providerReleaseStatusstringrequired
- providerSourceUrlstring
- providerTitlestring
- providerTrackIdstring
- trackNumberinteger
sourcesarray of object
- audioCodecstringrequired
- containerstringrequired
- durationMsintegerrequired≥ 0
- heightintegerrequired
- idstringrequired
- videoCodecstringrequired
- widthintegerrequired
- stillUrlstring
- titlestringrequired
- watchedboolean
- yearinteger
languagesobjectrequired
- audioarray of stringrequired
- subtitlesarray of stringrequired
markersarray of objectrequired
- automaticSafebooleanrequired
- endMsintegerrequired≥ 0
- idstringrequired
- kindstringrequired
- startMsintegerrequired≥ 0
metadataobjectrequired
- attributionsarray of string
creditTotalsobjectrequired
- castintegerrequired
- crewintegerrequired
creditsarray of objectrequired
- departmentstringrequired
- idstringrequired
- namestringrequired
- personIdstring
- portraitUrlstring
- providerstringrequired
- rolestringrequired
genresarray of objectrequired
- idstringrequired
- namestringrequired
- providerstringrequired
ratingsarray of objectrequired
- maxnumberrequired
- observedAtstringrequired
- providerstringrequired
- sourceUrlstringrequired
- valuenumberrequired
- votesintegerrequired
sourcesarray of objectrequired
- observedAtstringrequired
- providerstringrequired
- sourceUrlstringrequired
- statusstringrequired
- missingSincestring
personalobjectrequired
conflictsarray of objectrequired
- baseRevisionintegerrequired
- baseValueanyrequired
choicesarray of objectrequired
- authoredAtstringrequired
- deviceIdstringrequired
- operationIdstringrequired
- valueanyrequired
- fieldstringrequired
- idstringrequired
- continueDismissedboolean
- favoritebooleanrequired
- lastPlayedAtstringrequired
- notInterestedboolean
- progressMsintegerrequired≥ 0
- ratinginteger | any | nullrequired
- revisionintegerrequired
- statusstringrequired
- watchedbooleanrequired
- watchlistedbooleanrequired
relatedobject
- libraryIdstringrequired
- libraryNamestringrequired
rowsarray of objectrequired
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
- 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
- evidenceIdstringrequired
- hasMoreboolean
- headingstringrequired
headingTextobjectrequired
- codestringrequired
- fallbackstringrequired
- paramsobject
- idstringrequired
- nextCursorstring
- providerstringrequired
- relationstringrequired
- versionintegerrequired
revisionobjectrequired
- catalogintegerrequired
- viewerintegerrequired
scopeobjectrequired
- itemIdstringrequired
- libraryIdstringrequired
- serverIdstringrequired
- viewerFencestringrequired
- variant"detail"required
202Successapplication/json
Example
{
"detail": {
"revision": {
"catalog": 0,
"viewer": 0
},
"scope": {
"itemId": "id_8h2k4q",
"libraryId": "id_8h2k4q",
"serverId": "id_8h2k4q",
"viewerFence": "string"
}
},
"kind": "file-info-preparing",
"queryId": "id_8h2k4q",
"retryAfterMs": 1800000,
"state": "preparing",
"variant": "preparing"
}Schema
detailobject
revisionobjectrequired
- catalogintegerrequired
- viewerintegerrequired
scopeobjectrequired
- itemIdstringrequired
- libraryIdstringrequired
- serverIdstringrequired
- viewerFencestringrequired
- kind"file-info-preparing"required
- queryIdstringrequiredlength 1–512pattern ^[A-Za-z0-9_.-]+$
- retryAfterMsintegerrequired≥ 1
- state"preparing"required
- variant"preparing"required
304Successapplication/json
Example
{
"actions": [
{
"enabled": true,
"id": "id_8h2k4q",
"labelKey": "string",
"max": 0,
"min": 0,
"playback": {
"itemId": "id_8h2k4q",
"startMs": 1800000
},
"step": 0
}
],
"collections": [
{
"id": "id_8h2k4q",
"memberCount": 0,
"name": "Fargo",
"position": 0,
"posterUrls": [
"https://example.com/…"
],
"yearFrom": 0,
"yearTo": 0
}
],
"episodeDetails": {
"contentRating": "string",
"next": {
"id": "id_8h2k4q",
"number": 0,
"title": "Fargo"
},
"previous": {
"id": "id_8h2k4q",
"number": 0,
"title": "Fargo"
}
},
"extras": [
{
"items": [
{
"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
}
],
"label": "string",
"type": "string"
}
],
"facts": {
"contentRating": "string",
"country": "string",
"edition": "string",
"network": "string",
"originalLanguage": "en",
"originalTitle": "Fargo",
"releaseDate": "string",
"studio": "string",
"tagline": "string"
},
"fileInfoOpening": "string",
"item": {
"addedAt": "2026-10-18T19:30:00Z",
"audioFacts": {
"atmos": true,
"bitDepth": 0,
"channels": 0,
"codec": "string",
"layout": "string",
"lossless": true,
"sampleRate": 0
},
"available": true,
"backdropUrl": "https://example.com/…",
"bookFile": {
"bookId": "id_8h2k4q",
"bookTitle": "Fargo",
"discNumber": 0,
"localMetadata": {
"authors": [
"string"
],
"description": "string",
"edition": "string",
"identifiers": [
{}
],
"language": "en",
"narrators": [
"string"
],
"publishedYear": 0,
"publisher": "string",
"series": [
{}
],
"sources": {
"key": "string"
}
},
"localMetadataIssue": "string",
"localPolicy": {
"localMode": "string",
"revision": 0
},
"partNumber": 0,
"sourceBoundary": "string"
},
"durationMs": 1800000,
"durationState": "unrepresentable",
"episode": {
"airDate": "string",
"localIdentityStatus": "string",
"number": 0,
"numbering": "string",
"orderingBasis": "string",
"providerMatchStatus": "string",
"seasonId": "id_8h2k4q",
"seasonNumber": 0,
"showId": "id_8h2k4q",
"showTitle": "Fargo",
"sourceBoundary": "string"
},
"fileInfoOpening": "string",
"id": "id_8h2k4q",
"kind": "string",
"libraryId": "id_8h2k4q",
"missing": true,
"overview": "string",
"posterUrl": "https://example.com/…",
"progressMs": 1800000,
"song": {
"albumArtist": "string",
"albumId": "id_8h2k4q",
"albumTitle": "Fargo",
"artist": "string",
"discNumber": 0,
"localMetadataIssue": "string",
"providerArtist": "string",
"providerMatchStatus": "string",
"providerObservedAt": "2026-10-18T19:30:00Z",
"providerRecordingId": "id_8h2k4q",
"providerReleaseGroupId": "id_8h2k4q",
"providerReleaseId": "id_8h2k4q",
"providerReleaseStatus": "string",
"providerSourceUrl": "https://example.com/…",
"providerTitle": "Fargo",
"providerTrackId": "id_8h2k4q",
"trackNumber": 0
},
"sources": [
{
"audioCodec": "string",
"container": "string",
"durationMs": 1800000,
"height": 0,
"id": "id_8h2k4q",
"videoCodec": "string",
"width": 0
}
],
"stillUrl": "https://example.com/…",
"title": "Fargo",
"watched": true,
"year": 0
},
"languages": {
"audio": [
"string"
],
"subtitles": [
"Fargo"
]
},
"markers": [
{
"automaticSafe": true,
"endMs": 1800000,
"id": "id_8h2k4q",
"kind": "string",
"startMs": 1800000
}
],
"metadata": {
"attributions": [
"string"
],
"creditTotals": {
"cast": 0,
"crew": 0
},
"credits": [
{
"department": "string",
"id": "id_8h2k4q",
"name": "Fargo",
"personId": "id_8h2k4q",
"portraitUrl": "https://example.com/…",
"provider": "string",
"role": "string"
}
],
"genres": [
{
"id": "id_8h2k4q",
"name": "Fargo",
"provider": "string"
}
],
"ratings": [
{
"max": 0,
"observedAt": "2026-10-18T19:30:00Z",
"provider": "string",
"sourceUrl": "https://example.com/…",
"value": 0,
"votes": 0
}
],
"sources": [
{
"observedAt": "2026-10-18T19:30:00Z",
"provider": "string",
"sourceUrl": "https://example.com/…"
}
],
"status": "string"
},
"missingSince": "string",
"personal": {
"conflicts": [
{
"baseRevision": 0,
"baseValue": null,
"choices": [
{}
],
"field": "string",
"id": "id_8h2k4q"
}
],
"continueDismissed": true,
"favorite": true,
"lastPlayedAt": "2026-10-18T19:30:00Z",
"notInterested": true,
"progressMs": 1800000,
"rating": 0,
"revision": 0,
"status": "string",
"watched": true,
"watchlisted": true
},
"related": {
"libraryId": "id_8h2k4q",
"libraryName": "Fargo",
"rows": [
{
"entries": [
{}
],
"evidenceId": "id_8h2k4q",
"hasMore": true,
"heading": "string",
"headingText": {
"code": "string",
"fallback": "string",
"params": {}
},
"id": "id_8h2k4q",
"nextCursor": "eyJvIjoyMH0",
"provider": "string",
"relation": "string"
}
],
"version": 0
},
"revision": {
"catalog": 0,
"viewer": 0
},
"scope": {
"itemId": "id_8h2k4q",
"libraryId": "id_8h2k4q",
"serverId": "id_8h2k4q",
"viewerFence": "string"
},
"variant": "detail"
}Schema
actionsarray of objectrequired
- enabledbooleanrequired
- idstringrequired
- labelKeystringrequired
- maxnumber
- minnumber
playbackobject
- itemIdstringrequired
- startMsinteger≥ 0
- stepnumber
collectionsarray of objectrequired
- idstringrequired
- memberCountintegerrequired
- namestringrequired
- positionintegerrequired
- posterUrlsarray of stringrequired
- yearFrominteger
- yearTointeger
episodeDetailsobject
- contentRatingstring
nextobject
- idstringrequired
- numberintegerrequired
- titlestringrequired
previousobject
- idstringrequired
- numberintegerrequired
- titlestringrequired
extrasarray of object
itemsarray 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
- labelstringrequired
- typestringrequired
factsobject
- contentRatingstring
- countrystring
- editionstring
- networkstring
- originalLanguagestring
- originalTitlestring
- releaseDatestring
- studiostring
- taglinestring
- fileInfoOpeningstring
itemobjectrequired
- addedAtstring | any | nullrequired
audioFactsobject
- atmosboolean
- bitDepthinteger
- channelsinteger
- codecstringrequired
- layoutstring
- losslessboolean
- sampleRateinteger
- availablebooleanrequired
- backdropUrlstring
bookFileobject
- bookIdstringrequired
- bookTitlestringrequired
- discNumberinteger
localMetadataobject
- authorsarray of stringrequired
- descriptionstring
- editionstring
identifiersarray of objectrequired
- schemestringrequired
- valuestringrequired
- languagestring
- narratorsarray of stringrequired
- publishedYearinteger
- publisherstring
seriesarray of objectrequired
- namestringrequired
- positionstring
- sourcesobjectrequired
- localMetadataIssuestring
localPolicyobject
- localModestringrequired
- revisionintegerrequired
- partNumberinteger
- sourceBoundarystringrequired
- durationMsinteger≥ 0
- durationStatestringone of "unrepresentable"
episodeobject
- airDatestring
- localIdentityStatusstringrequired
- numberintegerrequired
- numberingstringrequired
- orderingBasisstringrequired
- providerMatchStatusstringrequired
- seasonIdstring
- seasonNumberinteger
- showIdstringrequired
- showTitlestringrequired
- sourceBoundarystringrequired
- fileInfoOpeningstring
- idstringrequired
- kindstringrequired
- libraryIdstringrequired
- missingbooleanrequired
- overviewstring
- posterUrlstring
- progressMsintegerrequired≥ 0
songobject
- albumArtiststringrequired
- albumIdstringrequired
- albumTitlestringrequired
- artiststringrequired
- discNumberinteger
- localMetadataIssuestring
- providerArtiststring
- providerMatchStatusstringrequired
- providerObservedAtstring
- providerRecordingIdstring
- providerReleaseGroupIdstring
- providerReleaseIdstring
- providerReleaseStatusstringrequired
- providerSourceUrlstring
- providerTitlestring
- providerTrackIdstring
- trackNumberinteger
sourcesarray of object
- audioCodecstringrequired
- containerstringrequired
- durationMsintegerrequired≥ 0
- heightintegerrequired
- idstringrequired
- videoCodecstringrequired
- widthintegerrequired
- stillUrlstring
- titlestringrequired
- watchedboolean
- yearinteger
languagesobjectrequired
- audioarray of stringrequired
- subtitlesarray of stringrequired
markersarray of objectrequired
- automaticSafebooleanrequired
- endMsintegerrequired≥ 0
- idstringrequired
- kindstringrequired
- startMsintegerrequired≥ 0
metadataobjectrequired
- attributionsarray of string
creditTotalsobjectrequired
- castintegerrequired
- crewintegerrequired
creditsarray of objectrequired
- departmentstringrequired
- idstringrequired
- namestringrequired
- personIdstring
- portraitUrlstring
- providerstringrequired
- rolestringrequired
genresarray of objectrequired
- idstringrequired
- namestringrequired
- providerstringrequired
ratingsarray of objectrequired
- maxnumberrequired
- observedAtstringrequired
- providerstringrequired
- sourceUrlstringrequired
- valuenumberrequired
- votesintegerrequired
sourcesarray of objectrequired
- observedAtstringrequired
- providerstringrequired
- sourceUrlstringrequired
- statusstringrequired
- missingSincestring
personalobjectrequired
conflictsarray of objectrequired
- baseRevisionintegerrequired
- baseValueanyrequired
choicesarray of objectrequired
- authoredAtstringrequired
- deviceIdstringrequired
- operationIdstringrequired
- valueanyrequired
- fieldstringrequired
- idstringrequired
- continueDismissedboolean
- favoritebooleanrequired
- lastPlayedAtstringrequired
- notInterestedboolean
- progressMsintegerrequired≥ 0
- ratinginteger | any | nullrequired
- revisionintegerrequired
- statusstringrequired
- watchedbooleanrequired
- watchlistedbooleanrequired
relatedobject
- libraryIdstringrequired
- libraryNamestringrequired
rowsarray of objectrequired
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
- 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
- evidenceIdstringrequired
- hasMoreboolean
- headingstringrequired
headingTextobjectrequired
- codestringrequired
- fallbackstringrequired
- paramsobject
- idstringrequired
- nextCursorstring
- providerstringrequired
- relationstringrequired
- versionintegerrequired
revisionobjectrequired
- catalogintegerrequired
- viewerintegerrequired
scopeobjectrequired
- itemIdstringrequired
- libraryIdstringrequired
- serverIdstringrequired
- viewerFencestringrequired
- variant"detail"required
defaultRequest refused or unavailableapplication/json
Example
{
"error": {
"code": "string",
"message": "string"
}
}Schema
errorobjectrequired
- codestringrequired
- messagestringrequired
Error codesinvalid_requestunauthorizednot_permittednot_foundinternalstale_continuationmetadata_unavailabledatabase_busy
Example request
curl -X GET "http://127.0.0.1:32500/v1/items/{id}/detail" \
-H "Authorization: Bearer $PORTICO_API_KEY"GET/v1/items/{id}/disc-titlesRead current disc title choicesread
- Audience
- Clients · Native API
- Authorization
- API key or personal access token with the read scope, or a signed-in session
- OpenAPI operation ID
get_disc_titles
Parameters
| Name | In | Type | Description |
|---|---|---|---|
idrequired | path | string | |
versionId | query | string |
Responses
200Successapplication/json
Example
{
"kind": "bluray",
"packaging": "iso",
"ready": true,
"revision": "r12",
"titles": [
{
"chapterCount": 0,
"durationMs": 1800000,
"id": "id_8h2k4q",
"main": true,
"number": 0,
"ready": true,
"revision": "r12"
}
],
"versionId": "id_8h2k4q"
}Schema
- kindstringrequiredone of "bluray", "dvd"
- packagingstringrequiredone of "iso", "folder"
- readybooleanrequired
- revisionstringrequired
titlesarray of objectrequired
- chapterCountintegerrequired
- durationMsintegerrequired
- idstringrequired
- mainbooleanrequired
- numberintegerrequired
- readybooleanrequired
- revisionstring
- versionIdstringrequired
defaultRequest refused or unavailableapplication/json
Example
{
"error": {
"code": "string",
"message": "string"
}
}Schema
errorobjectrequired
- codestringrequired
- messagestringrequired
Error codesunauthorizednot_permittednot_foundinvalid_requesttimeoutdatabase_busy
Example request
curl -X GET "http://127.0.0.1:32500/v1/items/{id}/disc-titles" \
-H "Authorization: Bearer $PORTICO_API_KEY"POST/v1/items/{id}/disc-titles/prepareAnalyze an alternate disc title for playbackplayback
- Audience
- Clients · Native API
- Authorization
- API key or personal access token with the playback scope, or a signed-in session
- OpenAPI operation ID
prepare_disc_title
Parameters
| Name | In | Type | Description |
|---|---|---|---|
idrequired | path | string |
Responses
202Successapplication/json
Example
{
"kind": "bluray",
"packaging": "iso",
"ready": true,
"revision": "r12",
"titles": [
{
"chapterCount": 0,
"durationMs": 1800000,
"id": "id_8h2k4q",
"main": true,
"number": 0,
"ready": true,
"revision": "r12"
}
],
"versionId": "id_8h2k4q"
}Schema
- kindstringrequiredone of "bluray", "dvd"
- packagingstringrequiredone of "iso", "folder"
- readybooleanrequired
- revisionstringrequired
titlesarray of objectrequired
- chapterCountintegerrequired
- durationMsintegerrequired
- idstringrequired
- mainbooleanrequired
- numberintegerrequired
- readybooleanrequired
- revisionstring
- versionIdstringrequired
defaultRequest refused or unavailableapplication/json
Example
{
"error": {
"code": "string",
"message": "string"
}
}Schema
errorobjectrequired
- codestringrequired
- messagestringrequired
Error codesunauthorizednot_permittednot_foundinvalid_requestrevision_mismatchsource_unavailabletimeoutdatabase_busywriter_capacity
Example request
curl -X POST "http://127.0.0.1:32500/v1/items/{id}/disc-titles/prepare" \
-H "Authorization: Bearer $PORTICO_API_KEY"GET/v1/items/{id}/file-infoRead the item's flat file windowread
- Audience
- Integrations · Native API
- Authorization
- API key or personal access token with the read scope, or a signed-in session
- OpenAPI operation ID
get_items_id_file_info
Parameters
| Name | In | Type | Description |
|---|---|---|---|
idrequired | path | string | |
opening | query | string | |
cursor | query | string | |
limit | query | integer | ""1–100 | |
around | query | string |
Responses
200Successapplication/json
Example
{
"basis": "string",
"detail": {
"revision": {
"catalog": 0,
"viewer": 0
},
"scope": {
"itemId": "id_8h2k4q",
"libraryId": "id_8h2k4q",
"serverId": "id_8h2k4q",
"viewerFence": "string"
}
},
"files": [
{
"audioCount": 0,
"available": true,
"bitRate": 0,
"container": "string",
"disc": {
"chapterCount": 0,
"kind": "bluray",
"packaging": "iso",
"titleNumber": 0
},
"duration": 0,
"durationState": "string",
"edition": "string",
"id": "id_8h2k4q",
"itemId": "id_8h2k4q",
"occurrence": "string",
"partIndex": 0,
"path": "string",
"size": 0,
"sizeExact": "string",
"subtitleCount": 0,
"video": {
"bitDepth": 0,
"bitRate": 0,
"codec": "string",
"dynamicRange": "string",
"frameRate": 0,
"hdr10Plus": true,
"height": 0,
"profile": "string",
"width": 0
}
}
],
"itemKind": "string",
"kind": "file-info-files",
"scope": {
"itemId": "id_8h2k4q",
"libraryId": "id_8h2k4q",
"serverId": "id_8h2k4q",
"viewerFence": "string"
},
"surface": {
"canSplit": true,
"eligibleFileCount": 0,
"fileCount": 0,
"groupCount": 0,
"hasDiscColumns": true,
"manage": {
"delete": true,
"merge": true,
"split": true
},
"ownerDiscOccurrence": "string"
},
"variant": "files",
"window": {
"limit": 1,
"nextCursor": "eyJvIjoyMH0",
"previousCursor": "eyJvIjoyMH0",
"queryId": "id_8h2k4q",
"reloadCursor": "eyJvIjoyMH0",
"returned": 0
}
}Schema
- basisstringrequiredlength 43–43pattern ^[A-Za-z0-9_-]{43}$
detailobjectrequired
revisionobjectrequired
- catalogintegerrequired
- viewerintegerrequired
scopeobjectrequired
- itemIdstringrequired
- libraryIdstringrequired
- serverIdstringrequired
- viewerFencestringrequired
filesarray of objectrequired0–100 items
- audioCountintegerrequired
- availablebooleanrequired
- bitRateinteger
- containerstringrequiredpattern ^[^ ]*$
discobject
- chapterCountintegerrequired
- kindstringrequiredone of "bluray", "dvd"
- packagingstringrequiredone of "iso", "folder"
- titleNumberintegerrequired
- durationnumber
- durationStatestring
- editionstringpattern ^[^ ]*$
- idstringrequired
- itemIdstringrequired
- occurrencestringrequired
- partIndexintegerrequired
- pathstringpattern ^[^ ]*$
- sizeinteger
- sizeExactstring
- subtitleCountintegerrequired
videoobject
- bitDepthinteger
- bitRateinteger
- codecstringrequiredpattern ^[^ ]*$
- dynamicRangestringpattern ^[^ ]*$
- frameRatenumber
- hdr10Plusboolean
- heightintegerrequired
- profilestringpattern ^[^ ]*$
- widthintegerrequired
- itemKindstringrequired
- kind"file-info-files"required
scopeobjectrequired
- itemIdstringrequired
- libraryIdstringrequired
- serverIdstringrequired
- viewerFencestringrequired
surfaceobjectrequired
- canSplitbooleanrequired
- eligibleFileCountintegerrequired
- fileCountintegerrequired
- groupCountintegerrequired
- hasDiscColumnsbooleanrequired
manageobject
- deletebooleanrequired
- mergebooleanrequired
- splitbooleanrequired
- ownerDiscOccurrencestring
- variant"files"required
windowobjectrequired
- limitintegerrequired1–100
- nextCursorstringlength 154–154pattern ^[A-Za-z0-9_-]{154}$
- previousCursorstringlength 154–154pattern ^[A-Za-z0-9_-]{154}$
- queryIdstringrequiredlength 338–338pattern ^[A-Za-z0-9_-]{183}\.[A-Za-z0-9_-]{154}$
- reloadCursorstringlength 154–154pattern ^[A-Za-z0-9_-]{154}$
- returnedintegerrequired0–100
202Successapplication/json
Example
{
"detail": {
"revision": {
"catalog": 0,
"viewer": 0
},
"scope": {
"itemId": "id_8h2k4q",
"libraryId": "id_8h2k4q",
"serverId": "id_8h2k4q",
"viewerFence": "string"
}
},
"kind": "file-info-preparing",
"queryId": "id_8h2k4q",
"retryAfterMs": 1800000,
"state": "preparing",
"variant": "preparing"
}Schema
detailobjectrequired
revisionobjectrequired
- catalogintegerrequired
- viewerintegerrequired
scopeobjectrequired
- itemIdstringrequired
- libraryIdstringrequired
- serverIdstringrequired
- viewerFencestringrequired
- kind"file-info-preparing"required
- queryIdstringrequiredlength 338–338pattern ^[A-Za-z0-9_-]{183}\.[A-Za-z0-9_-]{154}$
- retryAfterMsintegerrequired≥ 1
- state"preparing"required
- variant"preparing"required
304Successapplication/json
Example
{
"basis": "string",
"detail": {
"revision": {
"catalog": 0,
"viewer": 0
},
"scope": {
"itemId": "id_8h2k4q",
"libraryId": "id_8h2k4q",
"serverId": "id_8h2k4q",
"viewerFence": "string"
}
},
"files": [
{
"audioCount": 0,
"available": true,
"bitRate": 0,
"container": "string",
"disc": {
"chapterCount": 0,
"kind": "bluray",
"packaging": "iso",
"titleNumber": 0
},
"duration": 0,
"durationState": "string",
"edition": "string",
"id": "id_8h2k4q",
"itemId": "id_8h2k4q",
"occurrence": "string",
"partIndex": 0,
"path": "string",
"size": 0,
"sizeExact": "string",
"subtitleCount": 0,
"video": {
"bitDepth": 0,
"bitRate": 0,
"codec": "string",
"dynamicRange": "string",
"frameRate": 0,
"hdr10Plus": true,
"height": 0,
"profile": "string",
"width": 0
}
}
],
"itemKind": "string",
"kind": "file-info-files",
"scope": {
"itemId": "id_8h2k4q",
"libraryId": "id_8h2k4q",
"serverId": "id_8h2k4q",
"viewerFence": "string"
},
"surface": {
"canSplit": true,
"eligibleFileCount": 0,
"fileCount": 0,
"groupCount": 0,
"hasDiscColumns": true,
"manage": {
"delete": true,
"merge": true,
"split": true
},
"ownerDiscOccurrence": "string"
},
"variant": "files",
"window": {
"limit": 1,
"nextCursor": "eyJvIjoyMH0",
"previousCursor": "eyJvIjoyMH0",
"queryId": "id_8h2k4q",
"reloadCursor": "eyJvIjoyMH0",
"returned": 0
}
}Schema
- basisstringrequiredlength 43–43pattern ^[A-Za-z0-9_-]{43}$
detailobjectrequired
revisionobjectrequired
- catalogintegerrequired
- viewerintegerrequired
scopeobjectrequired
- itemIdstringrequired
- libraryIdstringrequired
- serverIdstringrequired
- viewerFencestringrequired
filesarray of objectrequired0–100 items
- audioCountintegerrequired
- availablebooleanrequired
- bitRateinteger
- containerstringrequiredpattern ^[^ ]*$
discobject
- chapterCountintegerrequired
- kindstringrequiredone of "bluray", "dvd"
- packagingstringrequiredone of "iso", "folder"
- titleNumberintegerrequired
- durationnumber
- durationStatestring
- editionstringpattern ^[^ ]*$
- idstringrequired
- itemIdstringrequired
- occurrencestringrequired
- partIndexintegerrequired
- pathstringpattern ^[^ ]*$
- sizeinteger
- sizeExactstring
- subtitleCountintegerrequired
videoobject
- bitDepthinteger
- bitRateinteger
- codecstringrequiredpattern ^[^ ]*$
- dynamicRangestringpattern ^[^ ]*$
- frameRatenumber
- hdr10Plusboolean
- heightintegerrequired
- profilestringpattern ^[^ ]*$
- widthintegerrequired
- itemKindstringrequired
- kind"file-info-files"required
scopeobjectrequired
- itemIdstringrequired
- libraryIdstringrequired
- serverIdstringrequired
- viewerFencestringrequired
surfaceobjectrequired
- canSplitbooleanrequired
- eligibleFileCountintegerrequired
- fileCountintegerrequired
- groupCountintegerrequired
- hasDiscColumnsbooleanrequired
manageobject
- deletebooleanrequired
- mergebooleanrequired
- splitbooleanrequired
- ownerDiscOccurrencestring
- variant"files"required
windowobjectrequired
- limitintegerrequired1–100
- nextCursorstringlength 154–154pattern ^[A-Za-z0-9_-]{154}$
- previousCursorstringlength 154–154pattern ^[A-Za-z0-9_-]{154}$
- queryIdstringrequiredlength 338–338pattern ^[A-Za-z0-9_-]{183}\.[A-Za-z0-9_-]{154}$
- reloadCursorstringlength 154–154pattern ^[A-Za-z0-9_-]{154}$
- returnedintegerrequired0–100
defaultRequest refused or unavailableapplication/json
Example
{
"error": {
"code": "string",
"message": "string"
}
}Schema
errorobjectrequired
- codestringrequired
- messagestringrequired
Error codesinvalid_requestunauthorizednot_permittednot_foundstale_continuationmetadata_unavailableinternaldatabase_busy
Example request
curl -X GET "http://127.0.0.1:32500/v1/items/{id}/file-info" \
-H "Authorization: Bearer $PORTICO_API_KEY"GET/v1/items/{id}/file-info/disc-titlesRead the owner's stored disc titlesread
- Audience
- Clients · Native API
- Authorization
- API key or personal access token with the read scope, or a signed-in session
- OpenAPI operation ID
get_item_file_info_disc_titles
Parameters
| Name | In | Type | Description |
|---|---|---|---|
idrequired | path | string | |
opening | query | string | |
cursor | query | string | |
limit | query | integer | ""1–100 | |
occurrence | query | string |
Responses
200Successapplication/json
Example
{
"basis": "string",
"detail": {
"revision": {
"catalog": 0,
"viewer": 0
},
"scope": {
"itemId": "id_8h2k4q",
"libraryId": "id_8h2k4q",
"serverId": "id_8h2k4q",
"viewerFence": "string"
}
},
"discKind": "bluray",
"kind": "file-info-disc-titles",
"occurrence": "string",
"scope": {
"itemId": "id_8h2k4q",
"libraryId": "id_8h2k4q",
"serverId": "id_8h2k4q",
"viewerFence": "string"
},
"titles": [
{
"angles": 0,
"chapters": 0,
"durationMs": 1800000,
"number": 0
}
],
"total": 0,
"variant": "disc-titles",
"window": {
"limit": 1,
"nextCursor": "eyJvIjoyMH0",
"previousCursor": "eyJvIjoyMH0",
"queryId": "id_8h2k4q",
"reloadCursor": "eyJvIjoyMH0",
"returned": 0
}
}Schema
- basisstringrequiredlength 43–43pattern ^[A-Za-z0-9_-]{43}$
detailobjectrequired
revisionobjectrequired
- catalogintegerrequired
- viewerintegerrequired
scopeobjectrequired
- itemIdstringrequired
- libraryIdstringrequired
- serverIdstringrequired
- viewerFencestringrequired
- discKindstringrequiredone of "bluray", "dvd"
- kind"file-info-disc-titles"required
- occurrencestringrequired
scopeobjectrequired
- itemIdstringrequired
- libraryIdstringrequired
- serverIdstringrequired
- viewerFencestringrequired
titlesarray of objectrequired0–100 items
- anglesintegerrequired
- chaptersintegerrequired
- durationMsintegerrequired
- numberintegerrequired
- totalintegerrequired
- variant"disc-titles"required
windowobjectrequired
- limitintegerrequired1–100
- nextCursorstringlength 154–154pattern ^[A-Za-z0-9_-]{154}$
- previousCursorstringlength 154–154pattern ^[A-Za-z0-9_-]{154}$
- queryIdstringrequiredlength 338–338pattern ^[A-Za-z0-9_-]{183}\.[A-Za-z0-9_-]{154}$
- reloadCursorstringlength 154–154pattern ^[A-Za-z0-9_-]{154}$
- returnedintegerrequired0–100
202Successapplication/json
Example
{
"detail": {
"revision": {
"catalog": 0,
"viewer": 0
},
"scope": {
"itemId": "id_8h2k4q",
"libraryId": "id_8h2k4q",
"serverId": "id_8h2k4q",
"viewerFence": "string"
}
},
"kind": "file-info-preparing",
"queryId": "id_8h2k4q",
"retryAfterMs": 1800000,
"state": "preparing",
"variant": "preparing"
}Schema
detailobjectrequired
revisionobjectrequired
- catalogintegerrequired
- viewerintegerrequired
scopeobjectrequired
- itemIdstringrequired
- libraryIdstringrequired
- serverIdstringrequired
- viewerFencestringrequired
- kind"file-info-preparing"required
- queryIdstringrequiredlength 338–338pattern ^[A-Za-z0-9_-]{183}\.[A-Za-z0-9_-]{154}$
- retryAfterMsintegerrequired≥ 1
- state"preparing"required
- variant"preparing"required
304Successapplication/json
Example
{
"basis": "string",
"detail": {
"revision": {
"catalog": 0,
"viewer": 0
},
"scope": {
"itemId": "id_8h2k4q",
"libraryId": "id_8h2k4q",
"serverId": "id_8h2k4q",
"viewerFence": "string"
}
},
"discKind": "bluray",
"kind": "file-info-disc-titles",
"occurrence": "string",
"scope": {
"itemId": "id_8h2k4q",
"libraryId": "id_8h2k4q",
"serverId": "id_8h2k4q",
"viewerFence": "string"
},
"titles": [
{
"angles": 0,
"chapters": 0,
"durationMs": 1800000,
"number": 0
}
],
"total": 0,
"variant": "disc-titles",
"window": {
"limit": 1,
"nextCursor": "eyJvIjoyMH0",
"previousCursor": "eyJvIjoyMH0",
"queryId": "id_8h2k4q",
"reloadCursor": "eyJvIjoyMH0",
"returned": 0
}
}Schema
- basisstringrequiredlength 43–43pattern ^[A-Za-z0-9_-]{43}$
detailobjectrequired
revisionobjectrequired
- catalogintegerrequired
- viewerintegerrequired
scopeobjectrequired
- itemIdstringrequired
- libraryIdstringrequired
- serverIdstringrequired
- viewerFencestringrequired
- discKindstringrequiredone of "bluray", "dvd"
- kind"file-info-disc-titles"required
- occurrencestringrequired
scopeobjectrequired
- itemIdstringrequired
- libraryIdstringrequired
- serverIdstringrequired
- viewerFencestringrequired
titlesarray of objectrequired0–100 items
- anglesintegerrequired
- chaptersintegerrequired
- durationMsintegerrequired
- numberintegerrequired
- totalintegerrequired
- variant"disc-titles"required
windowobjectrequired
- limitintegerrequired1–100
- nextCursorstringlength 154–154pattern ^[A-Za-z0-9_-]{154}$
- previousCursorstringlength 154–154pattern ^[A-Za-z0-9_-]{154}$
- queryIdstringrequiredlength 338–338pattern ^[A-Za-z0-9_-]{183}\.[A-Za-z0-9_-]{154}$
- reloadCursorstringlength 154–154pattern ^[A-Za-z0-9_-]{154}$
- returnedintegerrequired0–100
defaultRequest refused or unavailableapplication/json
Example
{
"error": {
"code": "string",
"message": "string"
}
}Schema
errorobjectrequired
- codestringrequired
- messagestringrequired
Error codesinvalid_requestunauthorizednot_permittednot_foundstale_continuationmetadata_unavailableinternaldatabase_busy
Example request
curl -X GET "http://127.0.0.1:32500/v1/items/{id}/file-info/disc-titles" \
-H "Authorization: Bearer $PORTICO_API_KEY"GET/v1/items/{id}/file-info/groupsRead the item's bounded version groupsread
- Audience
- Clients · Native API
- Authorization
- API key or personal access token with the read scope, or a signed-in session
- OpenAPI operation ID
get_item_file_info_groups
Parameters
| Name | In | Type | Description |
|---|---|---|---|
idrequired | path | string | |
opening | query | string | |
cursor | query | string | |
limit | query | integer | ""1–100 | |
around | query | string |
Responses
200Successapplication/json
Example
{
"basis": "string",
"detail": {
"revision": {
"catalog": 0,
"viewer": 0
},
"scope": {
"itemId": "id_8h2k4q",
"libraryId": "id_8h2k4q",
"serverId": "id_8h2k4q",
"viewerFence": "string"
}
},
"groups": [
{
"audioCount": 0,
"container": "string",
"disc": {
"chapterCount": 0,
"kind": "bluray",
"packaging": "iso",
"titleNumber": 0
},
"durationMs": 1800000,
"durationState": "string",
"edition": "string",
"headOccurrence": "string",
"id": "id_8h2k4q",
"memberCount": 0,
"ordinal": 0,
"sizeBytes": 0,
"sizeBytesExact": "string",
"subtitleCount": 0,
"video": {
"bitDepth": 0,
"bitRate": 0,
"codec": "string",
"dynamicRange": "string",
"frameRate": 0,
"hdr10Plus": true,
"height": 0,
"profile": "string",
"width": 0
}
}
],
"kind": "file-info-groups",
"scope": {
"itemId": "id_8h2k4q",
"libraryId": "id_8h2k4q",
"serverId": "id_8h2k4q",
"viewerFence": "string"
},
"surface": {
"canSplit": true,
"eligibleFileCount": 0,
"fileCount": 0,
"groupCount": 0,
"hasDiscColumns": true,
"manage": {
"delete": true,
"merge": true,
"split": true
},
"ownerDiscOccurrence": "string"
},
"variant": "groups",
"window": {
"limit": 1,
"nextCursor": "eyJvIjoyMH0",
"previousCursor": "eyJvIjoyMH0",
"queryId": "id_8h2k4q",
"reloadCursor": "eyJvIjoyMH0",
"returned": 0
}
}Schema
- basisstringrequiredlength 43–43pattern ^[A-Za-z0-9_-]{43}$
detailobjectrequired
revisionobjectrequired
- catalogintegerrequired
- viewerintegerrequired
scopeobjectrequired
- itemIdstringrequired
- libraryIdstringrequired
- serverIdstringrequired
- viewerFencestringrequired
groupsarray of objectrequired0–100 items
- audioCountintegerrequired
- containerstringrequiredpattern ^[^ ]*$
discobject
- chapterCountintegerrequired
- kindstringrequiredone of "bluray", "dvd"
- packagingstringrequiredone of "iso", "folder"
- titleNumberintegerrequired
- durationMsinteger
- durationStatestring
- editionstringpattern ^[^ ]*$
- headOccurrencestringrequired
- idstringrequired
- memberCountintegerrequired
- ordinalintegerrequired
- sizeBytesinteger
- sizeBytesExactstring
- subtitleCountintegerrequired
videoobject
- bitDepthinteger
- bitRateinteger
- codecstringrequiredpattern ^[^ ]*$
- dynamicRangestringpattern ^[^ ]*$
- frameRatenumber
- hdr10Plusboolean
- heightintegerrequired
- profilestringpattern ^[^ ]*$
- widthintegerrequired
- kind"file-info-groups"required
scopeobjectrequired
- itemIdstringrequired
- libraryIdstringrequired
- serverIdstringrequired
- viewerFencestringrequired
surfaceobjectrequired
- canSplitbooleanrequired
- eligibleFileCountintegerrequired
- fileCountintegerrequired
- groupCountintegerrequired
- hasDiscColumnsbooleanrequired
manageobject
- deletebooleanrequired
- mergebooleanrequired
- splitbooleanrequired
- ownerDiscOccurrencestring
- variant"groups"required
windowobjectrequired
- limitintegerrequired1–100
- nextCursorstringlength 154–154pattern ^[A-Za-z0-9_-]{154}$
- previousCursorstringlength 154–154pattern ^[A-Za-z0-9_-]{154}$
- queryIdstringrequiredlength 338–338pattern ^[A-Za-z0-9_-]{183}\.[A-Za-z0-9_-]{154}$
- reloadCursorstringlength 154–154pattern ^[A-Za-z0-9_-]{154}$
- returnedintegerrequired0–100
202Successapplication/json
Example
{
"detail": {
"revision": {
"catalog": 0,
"viewer": 0
},
"scope": {
"itemId": "id_8h2k4q",
"libraryId": "id_8h2k4q",
"serverId": "id_8h2k4q",
"viewerFence": "string"
}
},
"kind": "file-info-preparing",
"queryId": "id_8h2k4q",
"retryAfterMs": 1800000,
"state": "preparing",
"variant": "preparing"
}Schema
detailobjectrequired
revisionobjectrequired
- catalogintegerrequired
- viewerintegerrequired
scopeobjectrequired
- itemIdstringrequired
- libraryIdstringrequired
- serverIdstringrequired
- viewerFencestringrequired
- kind"file-info-preparing"required
- queryIdstringrequiredlength 338–338pattern ^[A-Za-z0-9_-]{183}\.[A-Za-z0-9_-]{154}$
- retryAfterMsintegerrequired≥ 1
- state"preparing"required
- variant"preparing"required
304Successapplication/json
Example
{
"basis": "string",
"detail": {
"revision": {
"catalog": 0,
"viewer": 0
},
"scope": {
"itemId": "id_8h2k4q",
"libraryId": "id_8h2k4q",
"serverId": "id_8h2k4q",
"viewerFence": "string"
}
},
"groups": [
{
"audioCount": 0,
"container": "string",
"disc": {
"chapterCount": 0,
"kind": "bluray",
"packaging": "iso",
"titleNumber": 0
},
"durationMs": 1800000,
"durationState": "string",
"edition": "string",
"headOccurrence": "string",
"id": "id_8h2k4q",
"memberCount": 0,
"ordinal": 0,
"sizeBytes": 0,
"sizeBytesExact": "string",
"subtitleCount": 0,
"video": {
"bitDepth": 0,
"bitRate": 0,
"codec": "string",
"dynamicRange": "string",
"frameRate": 0,
"hdr10Plus": true,
"height": 0,
"profile": "string",
"width": 0
}
}
],
"kind": "file-info-groups",
"scope": {
"itemId": "id_8h2k4q",
"libraryId": "id_8h2k4q",
"serverId": "id_8h2k4q",
"viewerFence": "string"
},
"surface": {
"canSplit": true,
"eligibleFileCount": 0,
"fileCount": 0,
"groupCount": 0,
"hasDiscColumns": true,
"manage": {
"delete": true,
"merge": true,
"split": true
},
"ownerDiscOccurrence": "string"
},
"variant": "groups",
"window": {
"limit": 1,
"nextCursor": "eyJvIjoyMH0",
"previousCursor": "eyJvIjoyMH0",
"queryId": "id_8h2k4q",
"reloadCursor": "eyJvIjoyMH0",
"returned": 0
}
}Schema
- basisstringrequiredlength 43–43pattern ^[A-Za-z0-9_-]{43}$
detailobjectrequired
revisionobjectrequired
- catalogintegerrequired
- viewerintegerrequired
scopeobjectrequired
- itemIdstringrequired
- libraryIdstringrequired
- serverIdstringrequired
- viewerFencestringrequired
groupsarray of objectrequired0–100 items
- audioCountintegerrequired
- containerstringrequiredpattern ^[^ ]*$
discobject
- chapterCountintegerrequired
- kindstringrequiredone of "bluray", "dvd"
- packagingstringrequiredone of "iso", "folder"
- titleNumberintegerrequired
- durationMsinteger
- durationStatestring
- editionstringpattern ^[^ ]*$
- headOccurrencestringrequired
- idstringrequired
- memberCountintegerrequired
- ordinalintegerrequired
- sizeBytesinteger
- sizeBytesExactstring
- subtitleCountintegerrequired
videoobject
- bitDepthinteger
- bitRateinteger
- codecstringrequiredpattern ^[^ ]*$
- dynamicRangestringpattern ^[^ ]*$
- frameRatenumber
- hdr10Plusboolean
- heightintegerrequired
- profilestringpattern ^[^ ]*$
- widthintegerrequired
- kind"file-info-groups"required
scopeobjectrequired
- itemIdstringrequired
- libraryIdstringrequired
- serverIdstringrequired
- viewerFencestringrequired
surfaceobjectrequired
- canSplitbooleanrequired
- eligibleFileCountintegerrequired
- fileCountintegerrequired
- groupCountintegerrequired
- hasDiscColumnsbooleanrequired
manageobject
- deletebooleanrequired
- mergebooleanrequired
- splitbooleanrequired
- ownerDiscOccurrencestring
- variant"groups"required
windowobjectrequired
- limitintegerrequired1–100
- nextCursorstringlength 154–154pattern ^[A-Za-z0-9_-]{154}$
- previousCursorstringlength 154–154pattern ^[A-Za-z0-9_-]{154}$
- queryIdstringrequiredlength 338–338pattern ^[A-Za-z0-9_-]{183}\.[A-Za-z0-9_-]{154}$
- reloadCursorstringlength 154–154pattern ^[A-Za-z0-9_-]{154}$
- returnedintegerrequired0–100
defaultRequest refused or unavailableapplication/json
Example
{
"error": {
"code": "string",
"message": "string"
}
}Schema
errorobjectrequired
- codestringrequired
- messagestringrequired
Error codesinvalid_requestunauthorizednot_permittednot_foundstale_continuationmetadata_unavailableinternaldatabase_busy
Example request
curl -X GET "http://127.0.0.1:32500/v1/items/{id}/file-info/groups" \
-H "Authorization: Bearer $PORTICO_API_KEY"GET/v1/items/{id}/file-info/groups/head-tracksRead a version group's offered head tracksread
- Audience
- Clients · Native API
- Authorization
- API key or personal access token with the read scope, or a signed-in session
- OpenAPI operation ID
get_item_file_info_head_tracks
Parameters
| Name | In | Type | Description |
|---|---|---|---|
idrequired | path | string | |
opening | query | string | |
cursor | query | string | |
limit | query | integer | ""1–100 | |
group | query | string | |
lane | query | string |
Responses
200Successapplication/json
Example
{
"basis": "string",
"detail": {
"revision": {
"catalog": 0,
"viewer": 0
},
"scope": {
"itemId": "id_8h2k4q",
"libraryId": "id_8h2k4q",
"serverId": "id_8h2k4q",
"viewerFence": "string"
}
},
"groupId": "id_8h2k4q",
"kind": "file-info-head-tracks",
"lane": "audio",
"occurrence": "string",
"scope": {
"itemId": "id_8h2k4q",
"libraryId": "id_8h2k4q",
"serverId": "id_8h2k4q",
"viewerFence": "string"
},
"total": 0,
"tracks": [
{
"bitDepth": 0,
"bitRate": 0,
"channelLayout": "string",
"channels": 0,
"codec": "string",
"commentary": true,
"default": true,
"external": true,
"forced": true,
"hearingImpaired": true,
"id": "id_8h2k4q",
"language": "en",
"objectAudio": "string",
"ordinal": 0,
"profile": "string",
"sampleRate": 0,
"title": "Fargo"
}
],
"variant": "head-tracks",
"window": {
"limit": 1,
"nextCursor": "eyJvIjoyMH0",
"previousCursor": "eyJvIjoyMH0",
"queryId": "id_8h2k4q",
"reloadCursor": "eyJvIjoyMH0",
"returned": 0
}
}Schema
- basisstringrequiredlength 43–43pattern ^[A-Za-z0-9_-]{43}$
detailobjectrequired
revisionobjectrequired
- catalogintegerrequired
- viewerintegerrequired
scopeobjectrequired
- itemIdstringrequired
- libraryIdstringrequired
- serverIdstringrequired
- viewerFencestringrequired
- groupIdstringrequired
- kind"file-info-head-tracks"required
- lanestringrequiredone of "audio", "subtitles"
- occurrencestringrequired
scopeobjectrequired
- itemIdstringrequired
- libraryIdstringrequired
- serverIdstringrequired
- viewerFencestringrequired
- totalintegerrequired
tracksarray of objectrequired0–100 items
- bitDepthinteger
- bitRateinteger
- channelLayoutstringpattern ^[^ ]*$
- channelsinteger
- codecstringrequiredpattern ^[^ ]*$
- commentaryboolean
- defaultboolean
- externalboolean
- forcedboolean
- hearingImpairedboolean
- idstringrequired
- languagestringpattern ^[^ ]*$
- objectAudiostringpattern ^[^ ]*$
- ordinalintegerrequired
- profilestringpattern ^[^ ]*$
- sampleRateinteger
- titlestringpattern ^[^ ]*$
- variant"head-tracks"required
windowobjectrequired
- limitintegerrequired1–100
- nextCursorstringlength 154–154pattern ^[A-Za-z0-9_-]{154}$
- previousCursorstringlength 154–154pattern ^[A-Za-z0-9_-]{154}$
- queryIdstringrequiredlength 338–338pattern ^[A-Za-z0-9_-]{183}\.[A-Za-z0-9_-]{154}$
- reloadCursorstringlength 154–154pattern ^[A-Za-z0-9_-]{154}$
- returnedintegerrequired0–100
202Successapplication/json
Example
{
"detail": {
"revision": {
"catalog": 0,
"viewer": 0
},
"scope": {
"itemId": "id_8h2k4q",
"libraryId": "id_8h2k4q",
"serverId": "id_8h2k4q",
"viewerFence": "string"
}
},
"kind": "file-info-preparing",
"queryId": "id_8h2k4q",
"retryAfterMs": 1800000,
"state": "preparing",
"variant": "preparing"
}Schema
detailobjectrequired
revisionobjectrequired
- catalogintegerrequired
- viewerintegerrequired
scopeobjectrequired
- itemIdstringrequired
- libraryIdstringrequired
- serverIdstringrequired
- viewerFencestringrequired
- kind"file-info-preparing"required
- queryIdstringrequiredlength 338–338pattern ^[A-Za-z0-9_-]{183}\.[A-Za-z0-9_-]{154}$
- retryAfterMsintegerrequired≥ 1
- state"preparing"required
- variant"preparing"required
304Successapplication/json
Example
{
"basis": "string",
"detail": {
"revision": {
"catalog": 0,
"viewer": 0
},
"scope": {
"itemId": "id_8h2k4q",
"libraryId": "id_8h2k4q",
"serverId": "id_8h2k4q",
"viewerFence": "string"
}
},
"groupId": "id_8h2k4q",
"kind": "file-info-head-tracks",
"lane": "audio",
"occurrence": "string",
"scope": {
"itemId": "id_8h2k4q",
"libraryId": "id_8h2k4q",
"serverId": "id_8h2k4q",
"viewerFence": "string"
},
"total": 0,
"tracks": [
{
"bitDepth": 0,
"bitRate": 0,
"channelLayout": "string",
"channels": 0,
"codec": "string",
"commentary": true,
"default": true,
"external": true,
"forced": true,
"hearingImpaired": true,
"id": "id_8h2k4q",
"language": "en",
"objectAudio": "string",
"ordinal": 0,
"profile": "string",
"sampleRate": 0,
"title": "Fargo"
}
],
"variant": "head-tracks",
"window": {
"limit": 1,
"nextCursor": "eyJvIjoyMH0",
"previousCursor": "eyJvIjoyMH0",
"queryId": "id_8h2k4q",
"reloadCursor": "eyJvIjoyMH0",
"returned": 0
}
}Schema
- basisstringrequiredlength 43–43pattern ^[A-Za-z0-9_-]{43}$
detailobjectrequired
revisionobjectrequired
- catalogintegerrequired
- viewerintegerrequired
scopeobjectrequired
- itemIdstringrequired
- libraryIdstringrequired
- serverIdstringrequired
- viewerFencestringrequired
- groupIdstringrequired
- kind"file-info-head-tracks"required
- lanestringrequiredone of "audio", "subtitles"
- occurrencestringrequired
scopeobjectrequired
- itemIdstringrequired
- libraryIdstringrequired
- serverIdstringrequired
- viewerFencestringrequired
- totalintegerrequired
tracksarray of objectrequired0–100 items
- bitDepthinteger
- bitRateinteger
- channelLayoutstringpattern ^[^ ]*$
- channelsinteger
- codecstringrequiredpattern ^[^ ]*$
- commentaryboolean
- defaultboolean
- externalboolean
- forcedboolean
- hearingImpairedboolean
- idstringrequired
- languagestringpattern ^[^ ]*$
- objectAudiostringpattern ^[^ ]*$
- ordinalintegerrequired
- profilestringpattern ^[^ ]*$
- sampleRateinteger
- titlestringpattern ^[^ ]*$
- variant"head-tracks"required
windowobjectrequired
- limitintegerrequired1–100
- nextCursorstringlength 154–154pattern ^[A-Za-z0-9_-]{154}$
- previousCursorstringlength 154–154pattern ^[A-Za-z0-9_-]{154}$
- queryIdstringrequiredlength 338–338pattern ^[A-Za-z0-9_-]{183}\.[A-Za-z0-9_-]{154}$
- reloadCursorstringlength 154–154pattern ^[A-Za-z0-9_-]{154}$
- returnedintegerrequired0–100
defaultRequest refused or unavailableapplication/json
Example
{
"error": {
"code": "string",
"message": "string"
}
}Schema
errorobjectrequired
- codestringrequired
- messagestringrequired
Error codesinvalid_requestunauthorizednot_permittednot_foundstale_continuationmetadata_unavailableinternaldatabase_busy
Example request
curl -X GET "http://127.0.0.1:32500/v1/items/{id}/file-info/groups/head-tracks" \
-H "Authorization: Bearer $PORTICO_API_KEY"GET/v1/items/{id}/file-info/groups/membersRead one version group's member filesread
- Audience
- Clients · Native API
- Authorization
- API key or personal access token with the read scope, or a signed-in session
- OpenAPI operation ID
get_item_file_info_members
Parameters
| Name | In | Type | Description |
|---|---|---|---|
idrequired | path | string | |
opening | query | string | |
cursor | query | string | |
limit | query | integer | ""1–100 | |
group | query | string |
Responses
200Successapplication/json
Example
{
"basis": "string",
"detail": {
"revision": {
"catalog": 0,
"viewer": 0
},
"scope": {
"itemId": "id_8h2k4q",
"libraryId": "id_8h2k4q",
"serverId": "id_8h2k4q",
"viewerFence": "string"
}
},
"groupId": "id_8h2k4q",
"kind": "file-info-members",
"members": [
{
"audioCount": 0,
"available": true,
"bitRate": 0,
"container": "string",
"disc": {
"chapterCount": 0,
"kind": "bluray",
"packaging": "iso",
"titleNumber": 0
},
"duration": 0,
"durationState": "string",
"edition": "string",
"id": "id_8h2k4q",
"itemId": "id_8h2k4q",
"occurrence": "string",
"partIndex": 0,
"path": "string",
"size": 0,
"sizeExact": "string",
"subtitleCount": 0,
"video": {
"bitDepth": 0,
"bitRate": 0,
"codec": "string",
"dynamicRange": "string",
"frameRate": 0,
"hdr10Plus": true,
"height": 0,
"profile": "string",
"width": 0
}
}
],
"scope": {
"itemId": "id_8h2k4q",
"libraryId": "id_8h2k4q",
"serverId": "id_8h2k4q",
"viewerFence": "string"
},
"total": 0,
"variant": "members",
"window": {
"limit": 1,
"nextCursor": "eyJvIjoyMH0",
"previousCursor": "eyJvIjoyMH0",
"queryId": "id_8h2k4q",
"reloadCursor": "eyJvIjoyMH0",
"returned": 0
}
}Schema
- basisstringrequiredlength 43–43pattern ^[A-Za-z0-9_-]{43}$
detailobjectrequired
revisionobjectrequired
- catalogintegerrequired
- viewerintegerrequired
scopeobjectrequired
- itemIdstringrequired
- libraryIdstringrequired
- serverIdstringrequired
- viewerFencestringrequired
- groupIdstringrequired
- kind"file-info-members"required
membersarray of objectrequired0–100 items
- audioCountintegerrequired
- availablebooleanrequired
- bitRateinteger
- containerstringrequiredpattern ^[^ ]*$
discobject
- chapterCountintegerrequired
- kindstringrequiredone of "bluray", "dvd"
- packagingstringrequiredone of "iso", "folder"
- titleNumberintegerrequired
- durationnumber
- durationStatestring
- editionstringpattern ^[^ ]*$
- idstringrequired
- itemIdstringrequired
- occurrencestringrequired
- partIndexintegerrequired
- pathstringpattern ^[^ ]*$
- sizeinteger
- sizeExactstring
- subtitleCountintegerrequired
videoobject
- bitDepthinteger
- bitRateinteger
- codecstringrequiredpattern ^[^ ]*$
- dynamicRangestringpattern ^[^ ]*$
- frameRatenumber
- hdr10Plusboolean
- heightintegerrequired
- profilestringpattern ^[^ ]*$
- widthintegerrequired
scopeobjectrequired
- itemIdstringrequired
- libraryIdstringrequired
- serverIdstringrequired
- viewerFencestringrequired
- totalintegerrequired
- variant"members"required
windowobjectrequired
- limitintegerrequired1–100
- nextCursorstringlength 154–154pattern ^[A-Za-z0-9_-]{154}$
- previousCursorstringlength 154–154pattern ^[A-Za-z0-9_-]{154}$
- queryIdstringrequiredlength 338–338pattern ^[A-Za-z0-9_-]{183}\.[A-Za-z0-9_-]{154}$
- reloadCursorstringlength 154–154pattern ^[A-Za-z0-9_-]{154}$
- returnedintegerrequired0–100
202Successapplication/json
Example
{
"detail": {
"revision": {
"catalog": 0,
"viewer": 0
},
"scope": {
"itemId": "id_8h2k4q",
"libraryId": "id_8h2k4q",
"serverId": "id_8h2k4q",
"viewerFence": "string"
}
},
"kind": "file-info-preparing",
"queryId": "id_8h2k4q",
"retryAfterMs": 1800000,
"state": "preparing",
"variant": "preparing"
}Schema
detailobjectrequired
revisionobjectrequired
- catalogintegerrequired
- viewerintegerrequired
scopeobjectrequired
- itemIdstringrequired
- libraryIdstringrequired
- serverIdstringrequired
- viewerFencestringrequired
- kind"file-info-preparing"required
- queryIdstringrequiredlength 338–338pattern ^[A-Za-z0-9_-]{183}\.[A-Za-z0-9_-]{154}$
- retryAfterMsintegerrequired≥ 1
- state"preparing"required
- variant"preparing"required
304Successapplication/json
Example
{
"basis": "string",
"detail": {
"revision": {
"catalog": 0,
"viewer": 0
},
"scope": {
"itemId": "id_8h2k4q",
"libraryId": "id_8h2k4q",
"serverId": "id_8h2k4q",
"viewerFence": "string"
}
},
"groupId": "id_8h2k4q",
"kind": "file-info-members",
"members": [
{
"audioCount": 0,
"available": true,
"bitRate": 0,
"container": "string",
"disc": {
"chapterCount": 0,
"kind": "bluray",
"packaging": "iso",
"titleNumber": 0
},
"duration": 0,
"durationState": "string",
"edition": "string",
"id": "id_8h2k4q",
"itemId": "id_8h2k4q",
"occurrence": "string",
"partIndex": 0,
"path": "string",
"size": 0,
"sizeExact": "string",
"subtitleCount": 0,
"video": {
"bitDepth": 0,
"bitRate": 0,
"codec": "string",
"dynamicRange": "string",
"frameRate": 0,
"hdr10Plus": true,
"height": 0,
"profile": "string",
"width": 0
}
}
],
"scope": {
"itemId": "id_8h2k4q",
"libraryId": "id_8h2k4q",
"serverId": "id_8h2k4q",
"viewerFence": "string"
},
"total": 0,
"variant": "members",
"window": {
"limit": 1,
"nextCursor": "eyJvIjoyMH0",
"previousCursor": "eyJvIjoyMH0",
"queryId": "id_8h2k4q",
"reloadCursor": "eyJvIjoyMH0",
"returned": 0
}
}Schema
- basisstringrequiredlength 43–43pattern ^[A-Za-z0-9_-]{43}$
detailobjectrequired
revisionobjectrequired
- catalogintegerrequired
- viewerintegerrequired
scopeobjectrequired
- itemIdstringrequired
- libraryIdstringrequired
- serverIdstringrequired
- viewerFencestringrequired
- groupIdstringrequired
- kind"file-info-members"required
membersarray of objectrequired0–100 items
- audioCountintegerrequired
- availablebooleanrequired
- bitRateinteger
- containerstringrequiredpattern ^[^ ]*$
discobject
- chapterCountintegerrequired
- kindstringrequiredone of "bluray", "dvd"
- packagingstringrequiredone of "iso", "folder"
- titleNumberintegerrequired
- durationnumber
- durationStatestring
- editionstringpattern ^[^ ]*$
- idstringrequired
- itemIdstringrequired
- occurrencestringrequired
- partIndexintegerrequired
- pathstringpattern ^[^ ]*$
- sizeinteger
- sizeExactstring
- subtitleCountintegerrequired
videoobject
- bitDepthinteger
- bitRateinteger
- codecstringrequiredpattern ^[^ ]*$
- dynamicRangestringpattern ^[^ ]*$
- frameRatenumber
- hdr10Plusboolean
- heightintegerrequired
- profilestringpattern ^[^ ]*$
- widthintegerrequired
scopeobjectrequired
- itemIdstringrequired
- libraryIdstringrequired
- serverIdstringrequired
- viewerFencestringrequired
- totalintegerrequired
- variant"members"required
windowobjectrequired
- limitintegerrequired1–100
- nextCursorstringlength 154–154pattern ^[A-Za-z0-9_-]{154}$
- previousCursorstringlength 154–154pattern ^[A-Za-z0-9_-]{154}$
- queryIdstringrequiredlength 338–338pattern ^[A-Za-z0-9_-]{183}\.[A-Za-z0-9_-]{154}$
- reloadCursorstringlength 154–154pattern ^[A-Za-z0-9_-]{154}$
- returnedintegerrequired0–100
defaultRequest refused or unavailableapplication/json
Example
{
"error": {
"code": "string",
"message": "string"
}
}Schema
errorobjectrequired
- codestringrequired
- messagestringrequired
Error codesinvalid_requestunauthorizednot_permittednot_foundstale_continuationmetadata_unavailableinternaldatabase_busy
Example request
curl -X GET "http://127.0.0.1:32500/v1/items/{id}/file-info/groups/members" \
-H "Authorization: Bearer $PORTICO_API_KEY"GET/v1/items/{id}/file-info/sourcesRead the item's bounded technical sourcesread
- Audience
- Clients · Native API
- Authorization
- API key or personal access token with the read scope, or a signed-in session
- OpenAPI operation ID
get_item_file_info_sources
Parameters
| Name | In | Type | Description |
|---|---|---|---|
idrequired | path | string | |
opening | query | string | |
cursor | query | string | |
limit | query | integer | ""1–100 |
Responses
200Successapplication/json
Example
{
"basis": "string",
"detail": {
"revision": {
"catalog": 0,
"viewer": 0
},
"scope": {
"itemId": "id_8h2k4q",
"libraryId": "id_8h2k4q",
"serverId": "id_8h2k4q",
"viewerFence": "string"
}
},
"kind": "file-info-sources",
"scope": {
"itemId": "id_8h2k4q",
"libraryId": "id_8h2k4q",
"serverId": "id_8h2k4q",
"viewerFence": "string"
},
"sources": [
{
"audioCodec": "string",
"container": "string",
"duration": 0,
"durationState": "string",
"height": 0,
"id": "id_8h2k4q",
"itemId": "id_8h2k4q",
"occurrence": "string",
"videoCodec": "string",
"width": 0
}
],
"total": 0,
"variant": "sources",
"window": {
"limit": 1,
"nextCursor": "eyJvIjoyMH0",
"previousCursor": "eyJvIjoyMH0",
"queryId": "id_8h2k4q",
"reloadCursor": "eyJvIjoyMH0",
"returned": 0
}
}Schema
- basisstringrequiredlength 43–43pattern ^[A-Za-z0-9_-]{43}$
detailobjectrequired
revisionobjectrequired
- catalogintegerrequired
- viewerintegerrequired
scopeobjectrequired
- itemIdstringrequired
- libraryIdstringrequired
- serverIdstringrequired
- viewerFencestringrequired
- kind"file-info-sources"required
scopeobjectrequired
- itemIdstringrequired
- libraryIdstringrequired
- serverIdstringrequired
- viewerFencestringrequired
sourcesarray of objectrequired0–100 items
- audioCodecstringrequiredpattern ^[^ ]*$
- containerstringrequiredpattern ^[^ ]*$
- durationnumber
- durationStatestring
- heightintegerrequired
- idstringrequired
- itemIdstringrequired
- occurrencestringrequired
- videoCodecstringrequiredpattern ^[^ ]*$
- widthintegerrequired
- totalintegerrequired
- variant"sources"required
windowobjectrequired
- limitintegerrequired1–100
- nextCursorstringlength 154–154pattern ^[A-Za-z0-9_-]{154}$
- previousCursorstringlength 154–154pattern ^[A-Za-z0-9_-]{154}$
- queryIdstringrequiredlength 338–338pattern ^[A-Za-z0-9_-]{183}\.[A-Za-z0-9_-]{154}$
- reloadCursorstringlength 154–154pattern ^[A-Za-z0-9_-]{154}$
- returnedintegerrequired0–100
202Successapplication/json
Example
{
"detail": {
"revision": {
"catalog": 0,
"viewer": 0
},
"scope": {
"itemId": "id_8h2k4q",
"libraryId": "id_8h2k4q",
"serverId": "id_8h2k4q",
"viewerFence": "string"
}
},
"kind": "file-info-preparing",
"queryId": "id_8h2k4q",
"retryAfterMs": 1800000,
"state": "preparing",
"variant": "preparing"
}Schema
detailobjectrequired
revisionobjectrequired
- catalogintegerrequired
- viewerintegerrequired
scopeobjectrequired
- itemIdstringrequired
- libraryIdstringrequired
- serverIdstringrequired
- viewerFencestringrequired
- kind"file-info-preparing"required
- queryIdstringrequiredlength 338–338pattern ^[A-Za-z0-9_-]{183}\.[A-Za-z0-9_-]{154}$
- retryAfterMsintegerrequired≥ 1
- state"preparing"required
- variant"preparing"required
304Successapplication/json
Example
{
"basis": "string",
"detail": {
"revision": {
"catalog": 0,
"viewer": 0
},
"scope": {
"itemId": "id_8h2k4q",
"libraryId": "id_8h2k4q",
"serverId": "id_8h2k4q",
"viewerFence": "string"
}
},
"kind": "file-info-sources",
"scope": {
"itemId": "id_8h2k4q",
"libraryId": "id_8h2k4q",
"serverId": "id_8h2k4q",
"viewerFence": "string"
},
"sources": [
{
"audioCodec": "string",
"container": "string",
"duration": 0,
"durationState": "string",
"height": 0,
"id": "id_8h2k4q",
"itemId": "id_8h2k4q",
"occurrence": "string",
"videoCodec": "string",
"width": 0
}
],
"total": 0,
"variant": "sources",
"window": {
"limit": 1,
"nextCursor": "eyJvIjoyMH0",
"previousCursor": "eyJvIjoyMH0",
"queryId": "id_8h2k4q",
"reloadCursor": "eyJvIjoyMH0",
"returned": 0
}
}Schema
- basisstringrequiredlength 43–43pattern ^[A-Za-z0-9_-]{43}$
detailobjectrequired
revisionobjectrequired
- catalogintegerrequired
- viewerintegerrequired
scopeobjectrequired
- itemIdstringrequired
- libraryIdstringrequired
- serverIdstringrequired
- viewerFencestringrequired
- kind"file-info-sources"required
scopeobjectrequired
- itemIdstringrequired
- libraryIdstringrequired
- serverIdstringrequired
- viewerFencestringrequired
sourcesarray of objectrequired0–100 items
- audioCodecstringrequiredpattern ^[^ ]*$
- containerstringrequiredpattern ^[^ ]*$
- durationnumber
- durationStatestring
- heightintegerrequired
- idstringrequired
- itemIdstringrequired
- occurrencestringrequired
- videoCodecstringrequiredpattern ^[^ ]*$
- widthintegerrequired
- totalintegerrequired
- variant"sources"required
windowobjectrequired
- limitintegerrequired1–100
- nextCursorstringlength 154–154pattern ^[A-Za-z0-9_-]{154}$
- previousCursorstringlength 154–154pattern ^[A-Za-z0-9_-]{154}$
- queryIdstringrequiredlength 338–338pattern ^[A-Za-z0-9_-]{183}\.[A-Za-z0-9_-]{154}$
- reloadCursorstringlength 154–154pattern ^[A-Za-z0-9_-]{154}$
- returnedintegerrequired0–100
defaultRequest refused or unavailableapplication/json
Example
{
"error": {
"code": "string",
"message": "string"
}
}Schema
errorobjectrequired
- codestringrequired
- messagestringrequired
Error codesinvalid_requestunauthorizednot_permittednot_foundstale_continuationmetadata_unavailableinternaldatabase_busy
Example request
curl -X GET "http://127.0.0.1:32500/v1/items/{id}/file-info/sources" \
-H "Authorization: Bearer $PORTICO_API_KEY"GET/v1/items/{id}/file-info/tracksRead one file's raw audio or subtitle tracksread
- Audience
- Clients · Native API
- Authorization
- API key or personal access token with the read scope, or a signed-in session
- OpenAPI operation ID
get_item_file_info_tracks
Parameters
| Name | In | Type | Description |
|---|---|---|---|
idrequired | path | string | |
opening | query | string | |
cursor | query | string | |
limit | query | integer | ""1–100 | |
occurrence | query | string | |
lane | query | string |
Responses
200Successapplication/json
Example
{
"basis": "string",
"detail": {
"revision": {
"catalog": 0,
"viewer": 0
},
"scope": {
"itemId": "id_8h2k4q",
"libraryId": "id_8h2k4q",
"serverId": "id_8h2k4q",
"viewerFence": "string"
}
},
"kind": "file-info-tracks",
"lane": "audio",
"occurrence": "string",
"scope": {
"itemId": "id_8h2k4q",
"libraryId": "id_8h2k4q",
"serverId": "id_8h2k4q",
"viewerFence": "string"
},
"total": 0,
"tracks": [
{
"bitDepth": 0,
"bitRate": 0,
"channelLayout": "string",
"channels": 0,
"codec": "string",
"commentary": true,
"default": true,
"external": true,
"forced": true,
"hearingImpaired": true,
"language": "en",
"objectAudio": "string",
"ordinal": 0,
"profile": "string",
"sampleRate": 0,
"title": "Fargo"
}
],
"variant": "tracks",
"window": {
"limit": 1,
"nextCursor": "eyJvIjoyMH0",
"previousCursor": "eyJvIjoyMH0",
"queryId": "id_8h2k4q",
"reloadCursor": "eyJvIjoyMH0",
"returned": 0
}
}Schema
- basisstringrequiredlength 43–43pattern ^[A-Za-z0-9_-]{43}$
detailobjectrequired
revisionobjectrequired
- catalogintegerrequired
- viewerintegerrequired
scopeobjectrequired
- itemIdstringrequired
- libraryIdstringrequired
- serverIdstringrequired
- viewerFencestringrequired
- kind"file-info-tracks"required
- lanestringrequiredone of "audio", "subtitles"
- occurrencestringrequired
scopeobjectrequired
- itemIdstringrequired
- libraryIdstringrequired
- serverIdstringrequired
- viewerFencestringrequired
- totalintegerrequired
tracksarray of objectrequired0–100 items
- bitDepthinteger
- bitRateinteger
- channelLayoutstringpattern ^[^ ]*$
- channelsinteger
- codecstringrequiredpattern ^[^ ]*$
- commentaryboolean
- defaultboolean
- externalboolean
- forcedboolean
- hearingImpairedboolean
- languagestringpattern ^[^ ]*$
- objectAudiostringpattern ^[^ ]*$
- ordinalintegerrequired
- profilestringpattern ^[^ ]*$
- sampleRateinteger
- titlestringpattern ^[^ ]*$
- variant"tracks"required
windowobjectrequired
- limitintegerrequired1–100
- nextCursorstringlength 154–154pattern ^[A-Za-z0-9_-]{154}$
- previousCursorstringlength 154–154pattern ^[A-Za-z0-9_-]{154}$
- queryIdstringrequiredlength 338–338pattern ^[A-Za-z0-9_-]{183}\.[A-Za-z0-9_-]{154}$
- reloadCursorstringlength 154–154pattern ^[A-Za-z0-9_-]{154}$
- returnedintegerrequired0–100
202Successapplication/json
Example
{
"detail": {
"revision": {
"catalog": 0,
"viewer": 0
},
"scope": {
"itemId": "id_8h2k4q",
"libraryId": "id_8h2k4q",
"serverId": "id_8h2k4q",
"viewerFence": "string"
}
},
"kind": "file-info-preparing",
"queryId": "id_8h2k4q",
"retryAfterMs": 1800000,
"state": "preparing",
"variant": "preparing"
}Schema
detailobjectrequired
revisionobjectrequired
- catalogintegerrequired
- viewerintegerrequired
scopeobjectrequired
- itemIdstringrequired
- libraryIdstringrequired
- serverIdstringrequired
- viewerFencestringrequired
- kind"file-info-preparing"required
- queryIdstringrequiredlength 338–338pattern ^[A-Za-z0-9_-]{183}\.[A-Za-z0-9_-]{154}$
- retryAfterMsintegerrequired≥ 1
- state"preparing"required
- variant"preparing"required
304Successapplication/json
Example
{
"basis": "string",
"detail": {
"revision": {
"catalog": 0,
"viewer": 0
},
"scope": {
"itemId": "id_8h2k4q",
"libraryId": "id_8h2k4q",
"serverId": "id_8h2k4q",
"viewerFence": "string"
}
},
"kind": "file-info-tracks",
"lane": "audio",
"occurrence": "string",
"scope": {
"itemId": "id_8h2k4q",
"libraryId": "id_8h2k4q",
"serverId": "id_8h2k4q",
"viewerFence": "string"
},
"total": 0,
"tracks": [
{
"bitDepth": 0,
"bitRate": 0,
"channelLayout": "string",
"channels": 0,
"codec": "string",
"commentary": true,
"default": true,
"external": true,
"forced": true,
"hearingImpaired": true,
"language": "en",
"objectAudio": "string",
"ordinal": 0,
"profile": "string",
"sampleRate": 0,
"title": "Fargo"
}
],
"variant": "tracks",
"window": {
"limit": 1,
"nextCursor": "eyJvIjoyMH0",
"previousCursor": "eyJvIjoyMH0",
"queryId": "id_8h2k4q",
"reloadCursor": "eyJvIjoyMH0",
"returned": 0
}
}Schema
- basisstringrequiredlength 43–43pattern ^[A-Za-z0-9_-]{43}$
detailobjectrequired
revisionobjectrequired
- catalogintegerrequired
- viewerintegerrequired
scopeobjectrequired
- itemIdstringrequired
- libraryIdstringrequired
- serverIdstringrequired
- viewerFencestringrequired
- kind"file-info-tracks"required
- lanestringrequiredone of "audio", "subtitles"
- occurrencestringrequired
scopeobjectrequired
- itemIdstringrequired
- libraryIdstringrequired
- serverIdstringrequired
- viewerFencestringrequired
- totalintegerrequired
tracksarray of objectrequired0–100 items
- bitDepthinteger
- bitRateinteger
- channelLayoutstringpattern ^[^ ]*$
- channelsinteger
- codecstringrequiredpattern ^[^ ]*$
- commentaryboolean
- defaultboolean
- externalboolean
- forcedboolean
- hearingImpairedboolean
- languagestringpattern ^[^ ]*$
- objectAudiostringpattern ^[^ ]*$
- ordinalintegerrequired
- profilestringpattern ^[^ ]*$
- sampleRateinteger
- titlestringpattern ^[^ ]*$
- variant"tracks"required
windowobjectrequired
- limitintegerrequired1–100
- nextCursorstringlength 154–154pattern ^[A-Za-z0-9_-]{154}$
- previousCursorstringlength 154–154pattern ^[A-Za-z0-9_-]{154}$
- queryIdstringrequiredlength 338–338pattern ^[A-Za-z0-9_-]{183}\.[A-Za-z0-9_-]{154}$
- reloadCursorstringlength 154–154pattern ^[A-Za-z0-9_-]{154}$
- returnedintegerrequired0–100
defaultRequest refused or unavailableapplication/json
Example
{
"error": {
"code": "string",
"message": "string"
}
}Schema
errorobjectrequired
- codestringrequired
- messagestringrequired
Error codesinvalid_requestunauthorizednot_permittednot_foundstale_continuationmetadata_unavailableinternaldatabase_busy
Example request
curl -X GET "http://127.0.0.1:32500/v1/items/{id}/file-info/tracks" \
-H "Authorization: Bearer $PORTICO_API_KEY"GET/v1/items/{id}/listeningRead title listeningread
- Audience
- Clients · Native API
- Authorization
- API key or personal access token with the read scope, or a signed-in session
- OpenAPI operation ID
get_items_id_listening
Parameters
| Name | In | Type | Description |
|---|---|---|---|
idrequired | path | string |
Responses
200Successapplication/json
Example
{
"data": {
"albumId": "id_8h2k4q",
"artistId": "id_8h2k4q",
"bookEndAvailable": true,
"bookId": "id_8h2k4q",
"itemId": "id_8h2k4q",
"kind": "string",
"lastBookItemId": "id_8h2k4q",
"libraryId": "id_8h2k4q"
},
"scope": {
"accountId": "id_8h2k4q",
"authority": "string",
"profileId": "id_8h2k4q",
"serverId": "id_8h2k4q"
}
}Schema
dataobjectrequired
- albumIdstring
- artistIdstring
- bookEndAvailableboolean
- bookIdstring
- itemIdstringrequired
- kindstringrequired
- lastBookItemIdstring
- libraryIdstringrequired
scopeobjectrequired
- accountIdstringrequired
- authoritystringrequired
- profileIdstringrequired
- 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/items/{id}/listening" \
-H "Authorization: Bearer $PORTICO_API_KEY"GET/v1/items/{id}/lyricsRead title lyricsread
- Audience
- Clients · Native API
- Authorization
- API key or personal access token with the read scope, or a signed-in session
- OpenAPI operation ID
get_items_id_lyrics
Parameters
| Name | In | Type | Description |
|---|---|---|---|
idrequired | path | string | |
sessionId | query | string | |
sourceId | query | string | |
sourceVersion | query | string |
Responses
200Successapplication/json
Example
{
"canShare": true,
"librarySelection": {
"resource": {
"canManage": true,
"createdAt": "2026-10-18T19:30:00Z",
"deleted": true,
"digest": "string",
"document": {
"embeddedOffsetMs": 1800000,
"format": "2026-10-18T19:30:00Z",
"lines": [
{}
],
"text": "string"
},
"format": "2026-10-18T19:30:00Z",
"id": "id_8h2k4q",
"language": "en",
"offsetMs": 1800000,
"provenance": {
"label": "string",
"origin": "string",
"providerId": "id_8h2k4q",
"rights": "string"
},
"revision": 0,
"scope": "string"
},
"revision": 0
},
"providers": {
"configured": true,
"lrclib": true,
"revision": 0
},
"resources": [
{
"canManage": true,
"createdAt": "2026-10-18T19:30:00Z",
"deleted": true,
"digest": "string",
"document": {
"embeddedOffsetMs": 1800000,
"format": "2026-10-18T19:30:00Z",
"lines": [
{}
],
"text": "string"
},
"format": "2026-10-18T19:30:00Z",
"id": "id_8h2k4q",
"language": "en",
"offsetMs": 1800000,
"provenance": {
"label": "string",
"origin": "string",
"providerId": "id_8h2k4q",
"rights": "string"
},
"revision": 0,
"scope": "string"
}
],
"scope": {
"itemId": "id_8h2k4q",
"libraryId": "id_8h2k4q",
"serverId": "id_8h2k4q",
"sessionGeneration": 0,
"sessionId": "id_8h2k4q",
"viewerFence": "string"
},
"selection": {
"resource": {
"canManage": true,
"createdAt": "2026-10-18T19:30:00Z",
"deleted": true,
"digest": "string",
"document": {
"embeddedOffsetMs": 1800000,
"format": "2026-10-18T19:30:00Z",
"lines": [
{}
],
"text": "string"
},
"format": "2026-10-18T19:30:00Z",
"id": "id_8h2k4q",
"language": "en",
"offsetMs": 1800000,
"provenance": {
"label": "string",
"origin": "string",
"providerId": "id_8h2k4q",
"rights": "string"
},
"revision": 0,
"scope": "string"
},
"revision": 0
},
"source": {
"durationMs": 1800000,
"id": "id_8h2k4q",
"local": true,
"sourceDurationMs": 1800000,
"startMs": 1800000,
"version": "string"
},
"sources": [
{
"durationMs": 1800000,
"id": "id_8h2k4q",
"local": true,
"sourceDurationMs": 1800000,
"startMs": 1800000,
"version": "string"
}
]
}Schema
- canSharebooleanrequired
librarySelectionobject
resourceobject | any | nullrequired
- canManagebooleanrequired
- createdAtstringrequired
- deletedbooleanrequired
- digeststringrequired
documentobject
- embeddedOffsetMsintegerrequired
- formatstringrequired
linesarray of objectrequired
- atMsinteger | any | nullrequired
- textstringrequired
- textstringrequired
- formatstringrequired
- idstringrequired
- languagestringrequired
- offsetMsintegerrequired
provenanceobjectrequired
- labelstringrequired
- originstringrequired
- providerIdstringrequired
- rightsstringrequired
- revisionintegerrequired
- scopestringrequired
- revisionintegerrequired
providersobjectrequired
- configuredbooleanrequired
- lrclibbooleanrequired
- revisionintegerrequired
resourcesarray of objectrequired
- canManagebooleanrequired
- createdAtstringrequired
- deletedbooleanrequired
- digeststringrequired
documentobject
- embeddedOffsetMsintegerrequired
- formatstringrequired
linesarray of objectrequired
- atMsinteger | any | nullrequired
- textstringrequired
- textstringrequired
- formatstringrequired
- idstringrequired
- languagestringrequired
- offsetMsintegerrequired
provenanceobjectrequired
- labelstringrequired
- originstringrequired
- providerIdstringrequired
- rightsstringrequired
- revisionintegerrequired
- scopestringrequired
scopeobjectrequired
- itemIdstringrequired
- libraryIdstringrequired
- serverIdstringrequired
- sessionGenerationintegerrequired
- sessionIdstringrequired
- viewerFencestringrequired
selectionobjectrequired
resourceobject | any | nullrequired
- canManagebooleanrequired
- createdAtstringrequired
- deletedbooleanrequired
- digeststringrequired
documentobject
- embeddedOffsetMsintegerrequired
- formatstringrequired
linesarray of objectrequired
- atMsinteger | any | nullrequired
- textstringrequired
- textstringrequired
- formatstringrequired
- idstringrequired
- languagestringrequired
- offsetMsintegerrequired
provenanceobjectrequired
- labelstringrequired
- originstringrequired
- providerIdstringrequired
- rightsstringrequired
- revisionintegerrequired
- scopestringrequired
- revisionintegerrequired
sourceobject | any | nullrequired
- durationMsintegerrequired≥ 0
- idstringrequired
- localbooleanrequired
- sourceDurationMsintegerrequired≥ 0
- startMsintegerrequired≥ 0
- versionstringrequired
sourcesarray of objectrequired
- durationMsintegerrequired≥ 0
- idstringrequired
- localbooleanrequired
- sourceDurationMsintegerrequired≥ 0
- startMsintegerrequired≥ 0
- versionstringrequired
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/items/{id}/lyrics" \
-H "Authorization: Bearer $PORTICO_API_KEY"POST/v1/items/{id}/lyricsRun title lyricslibrary
- Audience
- Clients · Native API
- Authorization
- API key or personal access token with the library scope, or a signed-in session
- OpenAPI operation ID
post_items_id_lyrics- Max body
- 2 MiB
Parameters
| Name | In | Type | Description |
|---|---|---|---|
idrequired | path | string |
Request body application/json · required
Example
{
"candidateId": "id_8h2k4q",
"contentBase64": "string",
"expectedRevision": 0,
"format": "2026-10-18T19:30:00Z",
"language": "en",
"offsetMs": 1800000,
"resourceId": "id_8h2k4q",
"rights": "string",
"scope": "string",
"sessionId": "id_8h2k4q",
"sourceId": "id_8h2k4q",
"sourceVersion": "string",
"text": "string"
}Schema
- candidateIdstringrequired
- contentBase64stringrequired
- expectedRevisionintegerrequired
- formatstringrequired
- languagestringrequired
- offsetMsinteger | any | nullrequired
- resourceIdstringrequired
- rightsstringrequired
- scopestringrequired
- sessionIdstringrequired
- sourceIdstringrequired
- sourceVersionstringrequired
- textstringrequired
Responses
200Successapplication/json
Example
{
"canManage": true,
"createdAt": "2026-10-18T19:30:00Z",
"deleted": true,
"digest": "string",
"document": {
"embeddedOffsetMs": 1800000,
"format": "2026-10-18T19:30:00Z",
"lines": [
{
"atMs": 1800000,
"text": "string"
}
],
"text": "string"
},
"format": "2026-10-18T19:30:00Z",
"id": "id_8h2k4q",
"language": "en",
"offsetMs": 1800000,
"provenance": {
"label": "string",
"origin": "string",
"providerId": "id_8h2k4q",
"rights": "string"
},
"revision": 0,
"scope": "string"
}Schema
- canManagebooleanrequired
- createdAtstringrequired
- deletedbooleanrequired
- digeststringrequired
documentobject
- embeddedOffsetMsintegerrequired
- formatstringrequired
linesarray of objectrequired
- atMsinteger | any | nullrequired
- textstringrequired
- textstringrequired
- formatstringrequired
- idstringrequired
- languagestringrequired
- offsetMsintegerrequired
provenanceobjectrequired
- labelstringrequired
- originstringrequired
- providerIdstringrequired
- rightsstringrequired
- revisionintegerrequired
- scopestringrequired
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/items/{id}/lyrics" \
-H "Authorization: Bearer $PORTICO_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"candidateId": "id_8h2k4q",
"contentBase64": "string",
"expectedRevision": 0,
"format": "2026-10-18T19:30:00Z",
"language": "en",
"offsetMs": 1800000,
"resourceId": "id_8h2k4q",
"rights": "string",
"scope": "string",
"sessionId": "id_8h2k4q",
"sourceId": "id_8h2k4q",
"sourceVersion": "string",
"text": "string"
}'DELETE/v1/items/{id}/lyrics/{resource}Remove title lyricslibrary
- Audience
- Clients · Native API
- Authorization
- API key or personal access token with the library scope, or a signed-in session
- OpenAPI operation ID
delete_items_id_lyrics_resource- Max body
- 2 MiB
Parameters
| Name | In | Type | Description |
|---|---|---|---|
idrequired | path | string | |
resourcerequired | path | string |
Request body application/json · required
Example
{
"candidateId": "id_8h2k4q",
"contentBase64": "string",
"expectedRevision": 0,
"format": "2026-10-18T19:30:00Z",
"language": "en",
"offsetMs": 1800000,
"resourceId": "id_8h2k4q",
"rights": "string",
"scope": "string",
"sessionId": "id_8h2k4q",
"sourceId": "id_8h2k4q",
"sourceVersion": "string",
"text": "string"
}Schema
- candidateIdstringrequired
- contentBase64stringrequired
- expectedRevisionintegerrequired
- formatstringrequired
- languagestringrequired
- offsetMsinteger | any | nullrequired
- resourceIdstringrequired
- rightsstringrequired
- scopestringrequired
- sessionIdstringrequired
- sourceIdstringrequired
- sourceVersionstringrequired
- textstringrequired
Responses
200Successapplication/json
Example
{
"canManage": true,
"createdAt": "2026-10-18T19:30:00Z",
"deleted": true,
"digest": "string",
"document": {
"embeddedOffsetMs": 1800000,
"format": "2026-10-18T19:30:00Z",
"lines": [
{
"atMs": 1800000,
"text": "string"
}
],
"text": "string"
},
"format": "2026-10-18T19:30:00Z",
"id": "id_8h2k4q",
"language": "en",
"offsetMs": 1800000,
"provenance": {
"label": "string",
"origin": "string",
"providerId": "id_8h2k4q",
"rights": "string"
},
"revision": 0,
"scope": "string"
}Schema
- canManagebooleanrequired
- createdAtstringrequired
- deletedbooleanrequired
- digeststringrequired
documentobject
- embeddedOffsetMsintegerrequired
- formatstringrequired
linesarray of objectrequired
- atMsinteger | any | nullrequired
- textstringrequired
- textstringrequired
- formatstringrequired
- idstringrequired
- languagestringrequired
- offsetMsintegerrequired
provenanceobjectrequired
- labelstringrequired
- originstringrequired
- providerIdstringrequired
- rightsstringrequired
- revisionintegerrequired
- scopestringrequired
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 DELETE "http://127.0.0.1:32500/v1/items/{id}/lyrics/{resource}" \
-H "Authorization: Bearer $PORTICO_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"candidateId": "id_8h2k4q",
"contentBase64": "string",
"expectedRevision": 0,
"format": "2026-10-18T19:30:00Z",
"language": "en",
"offsetMs": 1800000,
"resourceId": "id_8h2k4q",
"rights": "string",
"scope": "string",
"sessionId": "id_8h2k4q",
"sourceId": "id_8h2k4q",
"sourceVersion": "string",
"text": "string"
}'PATCH/v1/items/{id}/lyrics/{resource}/offsetChange title lyrics offsetlibrary
- Audience
- Clients · Native API
- Authorization
- API key or personal access token with the library scope, or a signed-in session
- OpenAPI operation ID
patch_items_id_lyrics_resource_offset- Max body
- 2 MiB
Parameters
| Name | In | Type | Description |
|---|---|---|---|
idrequired | path | string | |
resourcerequired | path | string |
Request body application/json · required
Example
{
"candidateId": "id_8h2k4q",
"contentBase64": "string",
"expectedRevision": 0,
"format": "2026-10-18T19:30:00Z",
"language": "en",
"offsetMs": 1800000,
"resourceId": "id_8h2k4q",
"rights": "string",
"scope": "string",
"sessionId": "id_8h2k4q",
"sourceId": "id_8h2k4q",
"sourceVersion": "string",
"text": "string"
}Schema
- candidateIdstringrequired
- contentBase64stringrequired
- expectedRevisionintegerrequired
- formatstringrequired
- languagestringrequired
- offsetMsinteger | any | nullrequired
- resourceIdstringrequired
- rightsstringrequired
- scopestringrequired
- sessionIdstringrequired
- sourceIdstringrequired
- sourceVersionstringrequired
- textstringrequired
Responses
200Successapplication/json
Example
{
"canManage": true,
"createdAt": "2026-10-18T19:30:00Z",
"deleted": true,
"digest": "string",
"document": {
"embeddedOffsetMs": 1800000,
"format": "2026-10-18T19:30:00Z",
"lines": [
{
"atMs": 1800000,
"text": "string"
}
],
"text": "string"
},
"format": "2026-10-18T19:30:00Z",
"id": "id_8h2k4q",
"language": "en",
"offsetMs": 1800000,
"provenance": {
"label": "string",
"origin": "string",
"providerId": "id_8h2k4q",
"rights": "string"
},
"revision": 0,
"scope": "string"
}Schema
- canManagebooleanrequired
- createdAtstringrequired
- deletedbooleanrequired
- digeststringrequired
documentobject
- embeddedOffsetMsintegerrequired
- formatstringrequired
linesarray of objectrequired
- atMsinteger | any | nullrequired
- textstringrequired
- textstringrequired
- formatstringrequired
- idstringrequired
- languagestringrequired
- offsetMsintegerrequired
provenanceobjectrequired
- labelstringrequired
- originstringrequired
- providerIdstringrequired
- rightsstringrequired
- revisionintegerrequired
- scopestringrequired
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 PATCH "http://127.0.0.1:32500/v1/items/{id}/lyrics/{resource}/offset" \
-H "Authorization: Bearer $PORTICO_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"candidateId": "id_8h2k4q",
"contentBase64": "string",
"expectedRevision": 0,
"format": "2026-10-18T19:30:00Z",
"language": "en",
"offsetMs": 1800000,
"resourceId": "id_8h2k4q",
"rights": "string",
"scope": "string",
"sessionId": "id_8h2k4q",
"sourceId": "id_8h2k4q",
"sourceVersion": "string",
"text": "string"
}'GET/v1/items/{id}/lyrics/{resource}/revisions/{revision}Read title lyrics revisionsread
- Audience
- Clients · Native API
- Authorization
- API key or personal access token with the read scope, or a signed-in session
- OpenAPI operation ID
get_items_id_lyrics_resource_revisions_revision
Parameters
| Name | In | Type | Description |
|---|---|---|---|
idrequired | path | string | |
resourcerequired | path | string | |
revisionrequired | path | string | |
sessionId | query | string | |
sourceId | query | string | |
sourceVersion | query | string |
Responses
200Successapplication/json
Example
{
"canManage": true,
"createdAt": "2026-10-18T19:30:00Z",
"deleted": true,
"digest": "string",
"document": {
"embeddedOffsetMs": 1800000,
"format": "2026-10-18T19:30:00Z",
"lines": [
{
"atMs": 1800000,
"text": "string"
}
],
"text": "string"
},
"format": "2026-10-18T19:30:00Z",
"id": "id_8h2k4q",
"language": "en",
"offsetMs": 1800000,
"provenance": {
"label": "string",
"origin": "string",
"providerId": "id_8h2k4q",
"rights": "string"
},
"revision": 0,
"scope": "string"
}Schema
- canManagebooleanrequired
- createdAtstringrequired
- deletedbooleanrequired
- digeststringrequired
documentobject
- embeddedOffsetMsintegerrequired
- formatstringrequired
linesarray of objectrequired
- atMsinteger | any | nullrequired
- textstringrequired
- textstringrequired
- formatstringrequired
- idstringrequired
- languagestringrequired
- offsetMsintegerrequired
provenanceobjectrequired
- labelstringrequired
- originstringrequired
- providerIdstringrequired
- rightsstringrequired
- revisionintegerrequired
- scopestringrequired
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/items/{id}/lyrics/{resource}/revisions/{revision}" \
-H "Authorization: Bearer $PORTICO_API_KEY"POST/v1/items/{id}/lyrics/searchRun title lyrics searchlibrary
- Audience
- Clients · Native API
- Authorization
- API key or personal access token with the library scope, or a signed-in session
- OpenAPI operation ID
post_items_id_lyrics_search- Max body
- 2 MiB
Parameters
| Name | In | Type | Description |
|---|---|---|---|
idrequired | path | string |
Request body application/json · required
Example
{
"expectedRevision": 0,
"language": "en",
"provider": "string",
"query": "string",
"resourceId": "id_8h2k4q",
"sessionId": "id_8h2k4q",
"sourceId": "id_8h2k4q",
"sourceVersion": "string"
}Schema
- expectedRevisionintegerrequired
- languagestringrequired
- providerstringrequired
- querystringrequired
- resourceIdstringrequired
- sessionIdstringrequired
- sourceIdstringrequired
- sourceVersionstringrequired
Responses
200Successapplication/json
Example
{
"candidates": [
{
"format": "2026-10-18T19:30:00Z",
"id": "id_8h2k4q",
"language": "en",
"preview": "string",
"provenance": {
"label": "string",
"origin": "string",
"providerId": "id_8h2k4q",
"rights": "string"
}
}
],
"warnings": [
"string"
]
}Schema
candidatesarray of objectrequired
- formatstringrequired
- idstringrequired
- languagestringrequired
- previewstringrequired
provenanceobjectrequired
- labelstringrequired
- originstringrequired
- providerIdstringrequired
- rightsstringrequired
- warningsarray of stringrequired
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/items/{id}/lyrics/search" \
-H "Authorization: Bearer $PORTICO_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"expectedRevision": 0,
"language": "en",
"provider": "string",
"query": "string",
"resourceId": "id_8h2k4q",
"sessionId": "id_8h2k4q",
"sourceId": "id_8h2k4q",
"sourceVersion": "string"
}'PUT/v1/items/{id}/lyrics/selectionSave title lyrics selectionplayback
- Audience
- Clients · Native API
- Authorization
- API key or personal access token with the playback scope, or a signed-in session
- OpenAPI operation ID
put_items_id_lyrics_selection- Max body
- 2 MiB
Parameters
| Name | In | Type | Description |
|---|---|---|---|
idrequired | path | string |
Request body application/json · required
Example
{
"expectedSelectionRevision": 0,
"resourceId": "id_8h2k4q",
"revision": 0,
"scope": "string",
"sessionId": "id_8h2k4q",
"sourceId": "id_8h2k4q",
"sourceVersion": "string"
}Schema
- expectedSelectionRevisionintegerrequired
- resourceIdstringrequired
- revisionintegerrequired
- scopestring
- sessionIdstringrequired
- sourceIdstringrequired
- sourceVersionstringrequired
Responses
200Successapplication/json
Example
{
"resource": {
"canManage": true,
"createdAt": "2026-10-18T19:30:00Z",
"deleted": true,
"digest": "string",
"document": {
"embeddedOffsetMs": 1800000,
"format": "2026-10-18T19:30:00Z",
"lines": [
{
"atMs": 1800000,
"text": "string"
}
],
"text": "string"
},
"format": "2026-10-18T19:30:00Z",
"id": "id_8h2k4q",
"language": "en",
"offsetMs": 1800000,
"provenance": {
"label": "string",
"origin": "string",
"providerId": "id_8h2k4q",
"rights": "string"
},
"revision": 0,
"scope": "string"
},
"revision": 0
}Schema
resourceobject | any | nullrequired
- canManagebooleanrequired
- createdAtstringrequired
- deletedbooleanrequired
- digeststringrequired
documentobject
- embeddedOffsetMsintegerrequired
- formatstringrequired
linesarray of objectrequired
- atMsinteger | any | nullrequired
- textstringrequired
- textstringrequired
- formatstringrequired
- idstringrequired
- languagestringrequired
- offsetMsintegerrequired
provenanceobjectrequired
- labelstringrequired
- originstringrequired
- providerIdstringrequired
- rightsstringrequired
- revisionintegerrequired
- scopestringrequired
- 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/items/{id}/lyrics/selection" \
-H "Authorization: Bearer $PORTICO_API_KEY" \
-H "Content-Type: application/json" \
-d '{"expectedSelectionRevision":0,"resourceId":"id_8h2k4q","revision":0,"scope":"string","sessionId":"id_8h2k4q","sourceId":"id_8h2k4q","sourceVersion":"string"}'PUT/v1/items/{id}/main-titleChoose and analyze the main disc titlelibrary
- Audience
- Clients · Native API
- Authorization
- API key or personal access token with the library scope, or a signed-in session
- OpenAPI operation ID
put_disc_main_title
Parameters
| Name | In | Type | Description |
|---|---|---|---|
idrequired | path | string |
Responses
202Successapplication/json
Example
{
"kind": "bluray",
"packaging": "iso",
"ready": true,
"revision": "r12",
"titles": [
{
"chapterCount": 0,
"durationMs": 1800000,
"id": "id_8h2k4q",
"main": true,
"number": 0,
"ready": true,
"revision": "r12"
}
],
"versionId": "id_8h2k4q"
}Schema
- kindstringrequiredone of "bluray", "dvd"
- packagingstringrequiredone of "iso", "folder"
- readybooleanrequired
- revisionstringrequired
titlesarray of objectrequired
- chapterCountintegerrequired
- durationMsintegerrequired
- idstringrequired
- mainbooleanrequired
- numberintegerrequired
- readybooleanrequired
- revisionstring
- versionIdstringrequired
defaultRequest refused or unavailableapplication/json
Example
{
"error": {
"code": "string",
"message": "string"
}
}Schema
errorobjectrequired
- codestringrequired
- messagestringrequired
Error codesunauthorizednot_permittednot_foundinvalid_requestrevision_mismatchsource_unavailabletimeoutdatabase_busywriter_capacity
Example request
curl -X PUT "http://127.0.0.1:32500/v1/items/{id}/main-title" \
-H "Authorization: Bearer $PORTICO_API_KEY"POST/v1/items/{id}/metadata/local-audio/policyRun title metadata local audio policylibrary
- Audience
- Clients · Native API
- Authorization
- API key or personal access token with the library scope, or a signed-in session
- OpenAPI operation ID
post_items_id_metadata_local_audio_policy- Max body
- 64 KiB
Parameters
| Name | In | Type | Description |
|---|---|---|---|
idrequired | path | string |
Request body application/json · required
Example
{
"expectedRevision": 0,
"libraryId": "id_8h2k4q",
"localMode": "string"
}Schema
- expectedRevisionintegerrequired
- libraryIdstringrequired
- localModestringrequired
Responses
200Successapplication/json
Example
{
"entityId": "id_8h2k4q",
"status": "string"
}Schema
- entityIdstringrequired
- statusstringrequired
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/items/{id}/metadata/local-audio/policy" \
-H "Authorization: Bearer $PORTICO_API_KEY" \
-H "Content-Type: application/json" \
-d '{"expectedRevision":0,"libraryId":"id_8h2k4q","localMode":"string"}'GET/v1/items/{id}/metadata/manualRead title metadata manuallibrary
- Audience
- Clients · Native API
- Authorization
- API key or personal access token with the library scope, or a signed-in session
- OpenAPI operation ID
get_items_id_metadata_manual
Parameters
| Name | In | Type | Description |
|---|---|---|---|
idrequired | path | string |
Responses
200Successapplication/json
Example
{
"description": {
"automaticValue": "string",
"manual": true,
"value": "string"
},
"kind": "string",
"revision": "r12",
"scope": {
"itemId": "id_8h2k4q",
"libraryId": "id_8h2k4q",
"serverId": "id_8h2k4q",
"viewerFence": "string"
},
"title": {
"automaticValue": "string",
"manual": true,
"value": "string"
},
"updatedAt": "2026-10-18T19:30:00Z"
}Schema
descriptionobjectrequired
- automaticValuestringrequired
- manualbooleanrequired
- valuestringrequired
- kindstringrequired
- revisionstringrequired
scopeobjectrequired
- itemIdstringrequired
- libraryIdstringrequired
- serverIdstringrequired
- viewerFencestringrequired
titleobjectrequired
- automaticValuestringrequired
- manualbooleanrequired
- valuestringrequired
- updatedAtstring
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/items/{id}/metadata/manual" \
-H "Authorization: Bearer $PORTICO_API_KEY"PATCH/v1/items/{id}/metadata/manualChange title metadata manuallibrary
- Audience
- Clients · Native API
- Authorization
- API key or personal access token with the library scope, or a signed-in session
- OpenAPI operation ID
patch_items_id_metadata_manual- Max body
- 256 KiB
Parameters
| Name | In | Type | Description |
|---|---|---|---|
idrequired | path | string |
Request body application/json · required
Example
{
"description": {
"Present": true,
"Value": "string"
},
"expectedRevision": "r12",
"title": {
"Present": true,
"Value": "string"
}
}Schema
descriptionobjectrequired
- Presentbooleanrequired
- Valuestring | any | nullrequired
- expectedRevisionstringrequired
titleobjectrequired
- Presentbooleanrequired
- Valuestring | any | nullrequired
Responses
200Successapplication/json
Example
{
"description": {
"automaticValue": "string",
"manual": true,
"value": "string"
},
"kind": "string",
"revision": "r12",
"scope": {
"itemId": "id_8h2k4q",
"libraryId": "id_8h2k4q",
"serverId": "id_8h2k4q",
"viewerFence": "string"
},
"title": {
"automaticValue": "string",
"manual": true,
"value": "string"
},
"updatedAt": "2026-10-18T19:30:00Z"
}Schema
descriptionobjectrequired
- automaticValuestringrequired
- manualbooleanrequired
- valuestringrequired
- kindstringrequired
- revisionstringrequired
scopeobjectrequired
- itemIdstringrequired
- libraryIdstringrequired
- serverIdstringrequired
- viewerFencestringrequired
titleobjectrequired
- automaticValuestringrequired
- manualbooleanrequired
- valuestringrequired
- updatedAtstring
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 PATCH "http://127.0.0.1:32500/v1/items/{id}/metadata/manual" \
-H "Authorization: Bearer $PORTICO_API_KEY" \
-H "Content-Type: application/json" \
-d '{"description":{"Present":true,"Value":"string"},"expectedRevision":"r12","title":{"Present":true,"Value":"string"}}'GET/v1/items/{id}/metadata/musicbrainzRead title metadata musicbrainzlibrary
- Audience
- Clients · Native API
- Authorization
- API key or personal access token with the library scope, or a signed-in session
- OpenAPI operation ID
get_items_id_metadata_musicbrainz
Parameters
| Name | In | Type | Description |
|---|---|---|---|
idrequired | path | string |
Responses
200Successapplication/json
Example
{
"actions": [
"string"
],
"attempts": 0,
"attribution": "string",
"candidates": [
{
"artist": "string",
"confidence": 0,
"decision": "string",
"edition": "string",
"id": "id_8h2k4q",
"observedAt": "2026-10-18T19:30:00Z",
"reasons": [
"string"
],
"title": "Fargo"
}
],
"entityId": "id_8h2k4q",
"error": "string",
"kind": "string",
"libraryId": "id_8h2k4q",
"manual": true,
"nextAttempt": "string",
"observation": {
"algorithm": "string",
"confidence": 0,
"fingerprintStatus": "string",
"margin": 0,
"providerError": "string",
"strongSignals": 0
},
"policy": {
"acoustidConfigured": true,
"acoustidEnabled": true,
"fingerprintAllowed": true,
"localMode": "string",
"musicBrainzEnabled": true,
"revision": 0
},
"published": {
"artist": "string",
"country": "string",
"date": "string",
"details": {
"barcode": "string",
"credits": [
{
"artist": {},
"joinphrase": "string",
"name": "Fargo"
}
],
"isrcs": [
"string"
],
"labels": [
{
"catalog-number": "string",
"label": {}
}
],
"language": "en",
"packaging": "string",
"relations": [
{
"artist": {},
"attributes": [],
"direction": "string",
"target-type": "string",
"type": "string",
"type-id": "id_8h2k4q",
"work": {}
}
],
"script": "string",
"status": "string"
},
"matchedTracks": 0,
"observedAt": "2026-10-18T19:30:00Z",
"pendingTracks": 0,
"reconciliationPending": true,
"recordingId": "id_8h2k4q",
"releaseGroupId": "id_8h2k4q",
"releaseId": "id_8h2k4q",
"reviewTracks": 0,
"title": "Fargo",
"totalTracks": 0,
"trackId": "id_8h2k4q",
"trackStatus": "string",
"trackTitle": "Fargo"
},
"revision": 0,
"selectedId": "id_8h2k4q",
"serverId": "id_8h2k4q",
"status": "string",
"viewerFence": "string"
}Schema
- actionsarray of stringrequired
- attemptsintegerrequired
- attributionstringrequired
candidatesarray of objectrequired
- artiststringrequired
- confidencenumberrequired
- decisionstringrequired
- editionstringrequired
- idstringrequired
- observedAtstringrequired
- reasonsarray of stringrequired
- titlestringrequired
- entityIdstringrequired
- errorstringrequired
- kindstringrequired
- libraryIdstringrequired
- manualbooleanrequired
- nextAttemptstringrequired
observationobject
- algorithmstringrequired
- confidencenumberrequired
- fingerprintStatusstringrequired
- marginnumberrequired
- providerErrorstringrequired
- strongSignalsintegerrequired
policyobject
- acoustidConfiguredbooleanrequired
- acoustidEnabledbooleanrequired
- fingerprintAllowedbooleanrequired
- localModestringrequired
- musicBrainzEnabledbooleanrequired
- revisionintegerrequired
publishedobject
- artiststringrequired
- countrystringrequired
- datestringrequired
detailsobject
- barcodestring
creditsarray of objectrequired
artistobjectrequired
- disambiguationstringrequired
- idstringrequired
- namestringrequired
- sort-namestringrequired
- joinphrasestringrequired
- namestringrequired
- isrcsarray of stringrequired
labelsarray of objectrequired
- catalog-numberstringrequired
labelobject
- idstringrequired
- namestringrequired
- languagestring
- packagingstring
relationsarray of objectrequired
artistobject
- disambiguationstringrequired
- idstringrequired
- namestringrequired
- sort-namestringrequired
- attributesarray of string
- directionstring
- target-typestringrequired
- typestringrequired
- type-idstring
workobject
- disambiguationstring
- idstringrequired
- titlestringrequired
- typestring
- scriptstring
- statusstring
- matchedTracksintegerrequired
- observedAtstringrequired
- pendingTracksintegerrequired
- reconciliationPendingbooleanrequired
- recordingIdstringrequired
- releaseGroupIdstringrequired
- releaseIdstringrequired
- reviewTracksintegerrequired
- titlestringrequired
- totalTracksintegerrequired
- trackIdstringrequired
- trackStatusstringrequired
- trackTitlestringrequired
- revisionintegerrequired
- selectedIdstringrequired
- serverIdstringrequired
- statusstringrequired
- 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/items/{id}/metadata/musicbrainz" \
-H "Authorization: Bearer $PORTICO_API_KEY"PUT/v1/items/{id}/metadata/musicbrainzSave title metadata musicbrainzlibrary
- Audience
- Clients · Native API
- Authorization
- API key or personal access token with the library scope, or a signed-in session
- OpenAPI operation ID
put_items_id_metadata_musicbrainz- Max body
- 64 KiB
Parameters
| Name | In | Type | Description |
|---|---|---|---|
idrequired | path | string |
Request body application/json · required
Example
{
"expectedRevision": 0,
"providerId": "id_8h2k4q"
}Schema
- expectedRevisionintegerrequired
- providerIdstringrequired
Responses
202Successapplication/json
Example
{
"entityId": "id_8h2k4q",
"status": "string"
}Schema
- entityIdstringrequired
- statusstringrequired
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/items/{id}/metadata/musicbrainz" \
-H "Authorization: Bearer $PORTICO_API_KEY" \
-H "Content-Type: application/json" \
-d '{"expectedRevision":0,"providerId":"id_8h2k4q"}'POST/v1/items/{id}/metadata/musicbrainz/policyRun title metadata musicbrainz policylibrary
- Audience
- Clients · Native API
- Authorization
- API key or personal access token with the library scope, or a signed-in session
- OpenAPI operation ID
post_items_id_metadata_musicbrainz_policy- Max body
- 64 KiB
Parameters
| Name | In | Type | Description |
|---|---|---|---|
idrequired | path | string |
Request body application/json · required
Example
{
"acoustidEnabled": true,
"expectedPolicyRevision": 0,
"expectedRevision": 0,
"localMode": "string",
"musicBrainzEnabled": true
}Schema
- acoustidEnabledbooleanrequired
- expectedPolicyRevisionintegerrequired
- expectedRevisionintegerrequired
- localModestringrequired
- musicBrainzEnabledbooleanrequired
Responses
202Successapplication/json
Example
{
"entityId": "id_8h2k4q",
"status": "string"
}Schema
- entityIdstringrequired
- statusstringrequired
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/items/{id}/metadata/musicbrainz/policy" \
-H "Authorization: Bearer $PORTICO_API_KEY" \
-H "Content-Type: application/json" \
-d '{"acoustidEnabled":true,"expectedPolicyRevision":0,"expectedRevision":0,"localMode":"string","musicBrainzEnabled":true}'POST/v1/items/{id}/metadata/musicbrainz/retryRun title metadata musicbrainz retrylibrary
- Audience
- Clients · Native API
- Authorization
- API key or personal access token with the library scope, or a signed-in session
- OpenAPI operation ID
post_items_id_metadata_musicbrainz_retry- Max body
- 64 KiB
Parameters
| Name | In | Type | Description |
|---|---|---|---|
idrequired | path | string |
Request body application/json · required
Example
{
"expectedRevision": 0
}Schema
- expectedRevisionintegerrequired
Responses
202Successapplication/json
Example
{
"entityId": "id_8h2k4q",
"status": "string"
}Schema
- entityIdstringrequired
- statusstringrequired
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/items/{id}/metadata/musicbrainz/retry" \
-H "Authorization: Bearer $PORTICO_API_KEY" \
-H "Content-Type: application/json" \
-d '{"expectedRevision":0}'POST/v1/items/{id}/metadata/musicbrainz/searchRun title metadata musicbrainz searchlibrary
- Audience
- Clients · Native API
- Authorization
- API key or personal access token with the library scope, or a signed-in session
- OpenAPI operation ID
post_items_id_metadata_musicbrainz_search- Max body
- 64 KiB
Parameters
| Name | In | Type | Description |
|---|---|---|---|
idrequired | path | string |
Request body application/json · required
Example
{
"expectedRevision": 0
}Schema
- expectedRevisionintegerrequired
Responses
202Successapplication/json
Example
{
"entityId": "id_8h2k4q",
"status": "string"
}Schema
- entityIdstringrequired
- statusstringrequired
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/items/{id}/metadata/musicbrainz/search" \
-H "Authorization: Bearer $PORTICO_API_KEY" \
-H "Content-Type: application/json" \
-d '{"expectedRevision":0}'POST/v1/items/{id}/metadata/refreshFetch current metadata for a titlelibrary
- Audience
- Clients · Native API
- Authorization
- API key or personal access token with the library scope, or a signed-in session
- OpenAPI operation ID
refresh_items_metadata- Max body
- 4 KiB
Parameters
| Name | In | Type | Description |
|---|---|---|---|
idrequired | path | string |
Request body application/json
Example
{}Schema
object
Responses
202Successapplication/json
Example
{
"itemId": "id_8h2k4q",
"status": "string"
}Schema
- itemIdstringrequired
- statusstringrequired
defaultRequest refused or unavailableapplication/json
Example
{
"error": {
"code": "string",
"message": "string"
}
}Schema
errorobjectrequired
- codestringrequired
- messagestringrequired
Error codesunauthorizednot_permittednot_foundinvalid_requestinternaltimeoutdatabase_busywriter_capacity
Example request
curl -X POST "http://127.0.0.1:32500/v1/items/{id}/metadata/refresh" \
-H "Authorization: Bearer $PORTICO_API_KEY" \
-H "Content-Type: application/json" \
-d '{}'GET/v1/items/{id}/metadata/screenRead match evidence, field provenance and provider candidateslibrary
- Audience
- Clients · Native API
- Authorization
- API key or personal access token with the library scope, or a signed-in session
- OpenAPI operation ID
get_items_screen_metadata
Parameters
| Name | In | Type | Description |
|---|---|---|---|
idrequired | path | string |
Responses
200Successapplication/json
Example
{
"accepted": {
"adult": true,
"advisoryRuntimeMinutes": 0,
"aliases": [
"string"
],
"backdropPath": "string",
"certifications": [
{
"rating": "string",
"region": "string"
}
],
"coordinates": {
"absolute": 0,
"episode": 0,
"order": "string",
"originalEpisode": 0,
"originalSeason": 0,
"season": 0,
"showId": "id_8h2k4q"
},
"credits": [
{
"department": "string",
"id": "id_8h2k4q",
"name": "Fargo",
"ordinal": 0,
"role": "string"
}
],
"crosswalk": [
{
"id": "id_8h2k4q",
"provider": "string",
"type": "string"
}
],
"date": "string",
"episodeCount": 0,
"fieldLanguages": {
"key": "string"
},
"format": "2026-10-18T19:30:00Z",
"genres": [
{
"id": "id_8h2k4q",
"name": "Fargo"
}
],
"identity": {
"id": "id_8h2k4q",
"provider": "string",
"type": "string"
},
"language": "en",
"orders": [
{
"id": "id_8h2k4q",
"name": "Fargo"
}
],
"originalTitle": "Fargo",
"overview": "string",
"posterPath": "string",
"rating": {
"scale": 0,
"value": 0,
"votes": 0
},
"relations": [
{
"kind": "string",
"name": "Fargo",
"target": {
"id": "id_8h2k4q",
"provider": "string",
"type": "string"
}
}
],
"season": "string",
"similar": [
{
"id": "id_8h2k4q",
"provider": "string",
"type": "string"
}
],
"skipped": [
"string"
],
"sourceMaterial": "string",
"status": "string",
"stillPath": "string",
"tagline": "string",
"tags": [
{
"id": "id_8h2k4q",
"name": "Fargo"
}
],
"title": "Fargo",
"year": 0
},
"acceptedAt": "2026-10-18T19:30:00Z",
"acceptedConfidence": 0,
"actions": [
"string"
],
"attempts": 0,
"attribution": "string",
"candidates": [
{
"attribution": "string",
"confidence": 0,
"contradiction": true,
"format": "2026-10-18T19:30:00Z",
"key": "string",
"observedAt": "2026-10-18T19:30:00Z",
"orders": [
{
"id": "id_8h2k4q",
"name": "Fargo"
}
],
"overview": "string",
"provider": "string",
"providerId": "id_8h2k4q",
"reasons": [
"string"
],
"sourceKind": "string",
"sourceUrl": "https://example.com/…",
"strongSignals": 0,
"title": "Fargo",
"type": "string",
"year": 0
}
],
"entityId": "id_8h2k4q",
"episodeStatus": "string",
"error": "string",
"explanation": "string",
"fields": [
{
"confidence": 0,
"language": "en",
"name": "Fargo",
"observedAt": "2026-10-18T19:30:00Z",
"provider": "string",
"region": "string",
"selectionRevision": 0,
"sourceKind": "string",
"sourceUrl": "https://example.com/…",
"value": null
}
],
"kind": "string",
"libraryId": "id_8h2k4q",
"localIssues": [
"string"
],
"nextAttempt": "string",
"order": "string",
"parentId": "id_8h2k4q",
"policy": {
"agent": "string",
"availableProviders": [
"string"
],
"confirmed": true,
"consentRevision": 0,
"disclosure": "string",
"disclosureVersion": "string",
"enabled": true,
"language": "en",
"libraryId": "id_8h2k4q",
"libraryKind": "string",
"providers": [
"string"
],
"refreshMode": "string",
"region": "string",
"revision": 0,
"status": "string"
},
"revision": 0,
"seasons": [
{
"anilistId": "id_8h2k4q",
"number": 0,
"revision": 0
}
],
"selected": {
"id": "id_8h2k4q",
"provider": "string",
"type": "string"
},
"selectionMode": "string",
"selectionRevision": 0,
"serverId": "id_8h2k4q",
"status": "string",
"viewerFence": "string"
}Schema
acceptedobject
- adultboolean
- advisoryRuntimeMinutesinteger
- aliasesarray of string
- backdropPathstring
certificationsarray of object
- ratingstringrequired
- regionstringrequired
coordinatesobject
- absoluteinteger
- episodeintegerrequired
- orderstringrequired
- originalEpisodeinteger
- originalSeasoninteger
- seasoninteger
- showIdstringrequired
creditsarray of object
- departmentstringrequired
- idstringrequired
- namestringrequired
- ordinalintegerrequired
- rolestringrequired
crosswalkarray of object
- idstringrequired
- providerstringrequired
- typestringrequired
- datestring
- episodeCountinteger
- fieldLanguagesobject
- formatstring
genresarray of object
- idstringrequired
- namestringrequired
identityobjectrequired
- idstringrequired
- providerstringrequired
- typestringrequired
- languagestring
ordersarray of object
- idstringrequired
- namestringrequired
- originalTitlestring
- overviewstring
- posterPathstring
ratingobject
- scaleintegerrequired
- valuenumberrequired
- votesintegerrequired
relationsarray of object
- kindstringrequired
- namestring
targetobjectrequired
- idstringrequired
- providerstringrequired
- typestringrequired
- seasonstring
similararray of object
- idstringrequired
- providerstringrequired
- typestringrequired
- skippedarray of string
- sourceMaterialstring
- statusstring
- stillPathstring
- taglinestring
tagsarray of object
- idstringrequired
- namestringrequired
- titlestringrequired
- yearinteger
- acceptedAtstringrequired
- acceptedConfidencenumberrequired
- actionsarray of stringrequired
- attemptsintegerrequired
- attributionstringrequired
candidatesarray of objectrequired
- attributionstringrequired
- confidencenumberrequired
- contradictionbooleanrequired
- formatstringrequired
- keystringrequired
- observedAtstringrequired
ordersarray of objectrequired
- idstringrequired
- namestringrequired
- overviewstringrequired
- providerstringrequired
- providerIdstringrequired
- reasonsarray of stringrequired
- sourceKindstringrequired
- sourceUrlstringrequired
- strongSignalsintegerrequired
- titlestringrequired
- typestringrequired
- yearintegerrequired
- entityIdstringrequired
- episodeStatusstringrequired
- errorstringrequired
- explanationstringrequired
fieldsarray of objectrequired
- confidencenumberrequired
- languagestringrequired
- namestringrequired
- observedAtstringrequired
- providerstringrequired
- regionstringrequired
- selectionRevisionintegerrequired
- sourceKindstringrequired
- sourceUrlstringrequired
- valueanyrequired
- kindstringrequired
- libraryIdstringrequired
- localIssuesarray of stringrequired
- nextAttemptstringrequired
- orderstringrequired
- parentIdstringrequired
policyobjectrequired
- agentstringrequired
- availableProvidersarray of stringrequired
- confirmedbooleanrequired
- consentRevisionintegerrequired
- disclosurestringrequired
- disclosureVersionstringrequired
- enabledbooleanrequired
- languagestringrequired
- libraryIdstringrequired
- libraryKindstringrequired
- providersarray of stringrequired
- refreshModestringrequired
- regionstringrequired
- revisionintegerrequired
- statusstringrequired
- revisionintegerrequired
seasonsarray of objectrequired
- anilistIdstringrequired
- numberintegerrequired
- revisionintegerrequired
selectedobjectrequired
- idstringrequired
- providerstringrequired
- typestringrequired
- selectionModestringrequired
- selectionRevisionintegerrequired
- serverIdstringrequired
- statusstringrequired
- viewerFencestringrequired
defaultRequest refused or unavailableapplication/json
Example
{
"error": {
"code": "string",
"message": "string"
}
}Schema
errorobjectrequired
- codestringrequired
- messagestringrequired
Error codesunauthorizednot_permittednot_foundinternaltimeoutdatabase_busy
Example request
curl -X GET "http://127.0.0.1:32500/v1/items/{id}/metadata/screen" \
-H "Authorization: Bearer $PORTICO_API_KEY"PUT/v1/items/{id}/metadata/screenSave title metadata screenlibrary
- Audience
- Clients · Native API
- Authorization
- API key or personal access token with the library scope, or a signed-in session
- OpenAPI operation ID
put_items_id_metadata_screen- Max body
- 64 KiB
Parameters
| Name | In | Type | Description |
|---|---|---|---|
idrequired | path | string |
Request body application/json · required
Example
{
"candidateKey": "string",
"expectedRevision": 0,
"order": "string"
}Schema
- candidateKeystringrequired
- expectedRevisionintegerrequired
- orderstringrequired
Responses
202Successapplication/json
Example
{
"entityId": "id_8h2k4q",
"status": "string"
}Schema
- entityIdstringrequired
- statusstringrequired
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/items/{id}/metadata/screen" \
-H "Authorization: Bearer $PORTICO_API_KEY" \
-H "Content-Type: application/json" \
-d '{"candidateKey":"string","expectedRevision":0,"order":"string"}'POST/v1/items/{id}/metadata/screen/retryRun title metadata screen retrylibrary
- Audience
- Clients · Native API
- Authorization
- API key or personal access token with the library scope, or a signed-in session
- OpenAPI operation ID
post_items_id_metadata_screen_retry- Max body
- 64 KiB
Parameters
| Name | In | Type | Description |
|---|---|---|---|
idrequired | path | string |
Request body application/json · required
Example
{
"expectedRevision": 0
}Schema
- expectedRevisionintegerrequired
Responses
202Successapplication/json
Example
{
"entityId": "id_8h2k4q",
"status": "string"
}Schema
- entityIdstringrequired
- statusstringrequired
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/items/{id}/metadata/screen/retry" \
-H "Authorization: Bearer $PORTICO_API_KEY" \
-H "Content-Type: application/json" \
-d '{"expectedRevision":0}'POST/v1/items/{id}/metadata/screen/searchRun title metadata screen searchlibrary
- Audience
- Clients · Native API
- Authorization
- API key or personal access token with the library scope, or a signed-in session
- OpenAPI operation ID
post_items_id_metadata_screen_search- Max body
- 64 KiB
Parameters
| Name | In | Type | Description |
|---|---|---|---|
idrequired | path | string |
Request body application/json · required
Example
{
"expectedRevision": 0,
"provider": "string",
"query": "string"
}Schema
- expectedRevisionintegerrequired
- providerstringrequired
- querystringrequired
Responses
202Successapplication/json
Example
{
"entityId": "id_8h2k4q",
"status": "string"
}Schema
- entityIdstringrequired
- statusstringrequired
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/items/{id}/metadata/screen/search" \
-H "Authorization: Bearer $PORTICO_API_KEY" \
-H "Content-Type: application/json" \
-d '{"expectedRevision":0,"provider":"string","query":"string"}'POST/v1/items/{id}/optimizationsRun title optimizationslibrary
- Audience
- Clients · Native API
- Authorization
- API key or personal access token with the library scope, or a signed-in session
- OpenAPI operation ID
post_items_id_optimizations- Max body
- 64 KiB
Parameters
| Name | In | Type | Description |
|---|---|---|---|
idrequired | path | string |
Request body application/json · required
Example
{
"expectedSourceRevision": "r12",
"idempotencyKey": "string",
"itemId": "id_8h2k4q",
"profileId": "id_8h2k4q",
"sourceId": "id_8h2k4q",
"targetId": "id_8h2k4q"
}Schema
- expectedSourceRevisionstringrequired
- idempotencyKeystringrequired
- itemIdstringrequired
- profileIdstringrequired
- sourceIdstringrequired
- targetIdstringrequired
Responses
200Successapplication/json
Example
{
"bytes": 0,
"createdMs": 1800000,
"errorCode": "string",
"generation": 0,
"id": "id_8h2k4q",
"itemId": "id_8h2k4q",
"phase": "string",
"profileId": "id_8h2k4q",
"revision": 0,
"sourceId": "id_8h2k4q",
"state": "string",
"targetId": "id_8h2k4q",
"updatedMs": 1800000,
"versionId": "id_8h2k4q"
}Schema
- bytesintegerrequired
- createdMsintegerrequired
- errorCodestringrequired
- generationintegerrequired
- idstringrequired
- itemIdstringrequired
- phasestringrequired
- profileIdstringrequired
- revisionintegerrequired
- sourceIdstringrequired
- statestringrequired
- targetIdstringrequired
- updatedMsintegerrequired
- versionIdstringrequired
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/items/{id}/optimizations" \
-H "Authorization: Bearer $PORTICO_API_KEY" \
-H "Content-Type: application/json" \
-d '{"expectedSourceRevision":"r12","idempotencyKey":"string","itemId":"id_8h2k4q","profileId":"id_8h2k4q","sourceId":"id_8h2k4q","targetId":"id_8h2k4q"}'PUT/v1/items/{id}/personal-stateRead or update the selected projectionplayback
- Audience
- Clients · Native API
- Authorization
- API key or personal access token with the playback scope, or a signed-in session
- OpenAPI operation ID
put_items_id_personal_state- Max body
- 1 MiB
Parameters
| Name | In | Type | Description |
|---|---|---|---|
idrequired | path | string | |
Idempotency-Key | header | string | |
Portico-Mutation-Root | header | string |
Request body application/json · required
Example
{
"continueDismissed": true,
"expectedRevision": 0,
"favorite": true,
"notInterested": true,
"offline": {
"authoredAt": "2026-10-18T19:30:00Z",
"baseRevision": 0,
"deviceId": "id_8h2k4q",
"deviceMutationId": "id_8h2k4q",
"sequence": 0
},
"operationId": "id_8h2k4q",
"progressMs": 1800000,
"rating": 0,
"resolution": {
"choiceOperationId": "id_8h2k4q",
"conflictId": "id_8h2k4q"
},
"watched": true,
"watchlisted": true
}Schema
- continueDismissedboolean
- expectedRevisionintegerrequired
- favoriteboolean
- notInterestedboolean
offlineobject
- authoredAtstringrequired
- baseRevisionintegerrequired
- deviceIdstringrequired
- deviceMutationIdstringrequired
- sequenceintegerrequired
- operationIdstringrequired
- progressMsinteger≥ 0
- ratinginteger | any | null
resolutionobject
- choiceOperationIdstringrequired
- conflictIdstringrequired
- watchedboolean
- watchlistedboolean
Responses
200Successapplication/json
Example
{
"current": {
"conflicts": [
{
"baseRevision": 0,
"baseValue": null,
"choices": [
{}
],
"field": "string",
"id": "id_8h2k4q"
}
],
"continueDismissed": true,
"favorite": true,
"lastPlayedAt": "2026-10-18T19:30:00Z",
"notInterested": true,
"progressMs": 1800000,
"rating": 0,
"revision": 0,
"status": "string",
"watched": true,
"watchlisted": true
},
"itemId": "id_8h2k4q",
"libraryId": "id_8h2k4q",
"operationId": "id_8h2k4q",
"personal": {
"conflicts": [
{
"baseRevision": 0,
"baseValue": null,
"choices": [
{}
],
"field": "string",
"id": "id_8h2k4q"
}
],
"continueDismissed": true,
"favorite": true,
"lastPlayedAt": "2026-10-18T19:30:00Z",
"notInterested": true,
"progressMs": 1800000,
"rating": 0,
"revision": 0,
"status": "string",
"watched": true,
"watchlisted": true
},
"receiptLifetimeMs": 1800000,
"serverId": "id_8h2k4q",
"viewerFence": "string"
}Schema
currentobject
conflictsarray of objectrequired
- baseRevisionintegerrequired
- baseValueanyrequired
choicesarray of objectrequired
- authoredAtstringrequired
- deviceIdstringrequired
- operationIdstringrequired
- valueanyrequired
- fieldstringrequired
- idstringrequired
- continueDismissedboolean
- favoritebooleanrequired
- lastPlayedAtstringrequired
- notInterestedboolean
- progressMsintegerrequired≥ 0
- ratinginteger | any | nullrequired
- revisionintegerrequired
- statusstringrequired
- watchedbooleanrequired
- watchlistedbooleanrequired
- itemIdstringrequired
- libraryIdstringrequired
- operationIdstringrequired
personalobjectrequired
conflictsarray of objectrequired
- baseRevisionintegerrequired
- baseValueanyrequired
choicesarray of objectrequired
- authoredAtstringrequired
- deviceIdstringrequired
- operationIdstringrequired
- valueanyrequired
- fieldstringrequired
- idstringrequired
- continueDismissedboolean
- favoritebooleanrequired
- lastPlayedAtstringrequired
- notInterestedboolean
- progressMsintegerrequired≥ 0
- ratinginteger | any | nullrequired
- revisionintegerrequired
- statusstringrequired
- watchedbooleanrequired
- watchlistedbooleanrequired
- 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 PUT "http://127.0.0.1:32500/v1/items/{id}/personal-state" \
-H "Authorization: Bearer $PORTICO_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"continueDismissed": true,
"expectedRevision": 0,
"favorite": true,
"notInterested": true,
"offline": {
"authoredAt": "2026-10-18T19:30:00Z",
"baseRevision": 0,
"deviceId": "id_8h2k4q",
"deviceMutationId": "id_8h2k4q",
"sequence": 0
},
"operationId": "id_8h2k4q",
"progressMs": 1800000,
"rating": 0,
"resolution": {
"choiceOperationId": "id_8h2k4q",
"conflictId": "id_8h2k4q"
},
"watched": true,
"watchlisted": true
}'GET/v1/items/{id}/playback-offersRead title playback offersread
- Audience
- Clients · Native API
- Authorization
- API key or personal access token with the read scope, or a signed-in session
- OpenAPI operation ID
get_items_id_playback_offers
Parameters
| Name | In | Type | Description |
|---|---|---|---|
idrequired | path | string | |
revision | query | string | |
sessionId | query | string |
Responses
200Successapplication/json
Example
{
"controls": [
{
"enabled": true,
"id": "id_8h2k4q",
"reason": "string"
}
],
"current": {
"audioSelection": "string",
"delivery": "string",
"generation": 0,
"preparedVersionId": "id_8h2k4q",
"qualityId": "id_8h2k4q",
"sessionId": "id_8h2k4q",
"sourceId": "id_8h2k4q",
"state": "string",
"subtitleSelection": "Fargo"
},
"deliveryPlan": {
"airPlay": true,
"audioAction": "string",
"audioBitrateBps": 0,
"audioChannels": 0,
"audioLossless": true,
"audioPassthrough": true,
"audioRenditions": [
{
"action": "string",
"bitDepth": 0,
"bitrateBps": 0,
"channelLayout": "string",
"channels": 0,
"codec": "string",
"commentary": true,
"default": true,
"downmix": "string",
"failure": "string",
"label": "string",
"language": "en",
"ordinal": 0,
"profile": "string",
"sampleRate": 0,
"streamIndex": 0,
"title": "Fargo"
}
],
"audioStream": 0,
"burnIn": {
"format": "2026-10-18T19:30:00Z",
"resourceId": "id_8h2k4q",
"revision": 0
},
"deinterlace": true,
"downmix": "string",
"durationMs": 1800000,
"engine": "string",
"factsRevision": 0,
"hardwareBackend": "string",
"maxFrameRate": 0,
"mode": "string",
"outputAudioCodec": "string",
"outputBitDepth": 0,
"outputContainer": "string",
"outputRange": "string",
"outputVideoCodec": "string",
"policy": {
"allowHDR": true,
"clamps": [
{
"applied": 0,
"field": "string",
"requested": 0,
"source": "string"
}
],
"directPlay": "string",
"directStream": "string",
"maxAudioBitrateBps": 0,
"maxVideoBitrateBps": 0,
"maxVideoHeight": 0,
"networkClass": "string",
"planningPolicy": "string",
"preferenceLane": "string",
"qualityMode": "string",
"serverLocality": "string",
"transcode": "string",
"transportClass": "string"
},
"prepared": {
"digest": "string",
"facts": {
"audioBitDepth": 0,
"audioChannels": 0,
"audioCodec": "string",
"audioSampleRate": 0,
"audioTracks": 0,
"container": "string",
"durationMs": 1800000,
"height": 0,
"videoCodec": "string",
"width": 0
},
"revision": 0,
"size": 0,
"sourceRevision": "r12",
"versionId": "id_8h2k4q"
},
"profile": "string",
"qualityId": "id_8h2k4q",
"reason": "string",
"reasonCodes": [
"string"
],
"sourceAudioCodec": "string",
"sourceContainer": "string",
"sourceId": "id_8h2k4q",
"sourceVideoCodec": "string",
"strategy": "string",
"targetDisplayHeight": 0,
"targetDisplayWidth": 0,
"toneMap": true,
"toneMapAlgorithm": "string",
"toneMapOff": true,
"trace": {
"audio": {
"bitDepth": 0,
"channels": 0,
"chosenBy": "string",
"codec": "string",
"language": "en",
"layout": "string",
"lossless": true,
"objectAudio": "string",
"profile": "string",
"sampleRate": 0,
"streamIndex": 0,
"tracks": 0,
"variant": "string"
},
"bitRate": 0,
"client": {
"engine": "string",
"engineName": "Fargo",
"evidence": "string",
"family": "string",
"model": "string",
"platform": "string",
"published": true,
"revision": "r12"
},
"container": "string",
"notes": [
"string"
],
"routes": [
{
"admissible": true,
"chosen": true,
"rejections": [],
"route": "string",
"transport": "string"
}
],
"version": 0,
"video": {
"bitDepth": 0,
"bitRate": 0,
"chromaSubsampling": "string",
"codec": "string",
"dolbyVisionBaseLayer": true,
"dolbyVisionCmVersion": "string",
"dolbyVisionCompatibility": 0,
"dolbyVisionEnhancementType": "string",
"dolbyVisionLevel": 0,
"dolbyVisionProfile": 0,
"dolbyVisionRpu": true,
"dynamicRange": "string",
"frameRate": 0,
"frameRateDenominator": 0,
"frameRateMode": "string",
"frameRateNumerator": 0,
"hdr10Plus": true,
"height": 0,
"interlaced": true,
"level": 0,
"masterDisplay": "string",
"maxCll": "string",
"outputRange": "string",
"profile": "string",
"rotation": 0,
"sampleAspectRatio": "string",
"width": 0
}
},
"videoAction": "string",
"videoBitrateBps": 0
},
"deliveryPolicy": {
"allowHDR": true,
"clamps": [
{
"applied": 0,
"field": "string",
"requested": 0,
"source": "string"
}
],
"directPlay": "string",
"directStream": "string",
"maxAudioBitrateBps": 0,
"maxVideoBitrateBps": 0,
"maxVideoHeight": 0,
"networkClass": "string",
"planningPolicy": "string",
"preferenceLane": "string",
"qualityMode": "string",
"serverLocality": "string",
"transcode": "string",
"transportClass": "string"
},
"markers": {
"markers": [
{
"automaticSafe": true,
"endMs": 1800000,
"id": "id_8h2k4q",
"kind": "string",
"startMs": 1800000
}
],
"revision": "r12",
"sourceId": "id_8h2k4q"
},
"offersRevision": "r12",
"preparedOffersRevision": "r12",
"preparedVersions": [
{
"createdMs": 1800000,
"digest": "string",
"editionId": "id_8h2k4q",
"facts": {
"audioBitDepth": 0,
"audioChannels": 0,
"audioCodec": "string",
"audioSampleRate": 0,
"audioTracks": 0,
"container": "string",
"durationMs": 1800000,
"height": 0,
"videoCodec": "string",
"width": 0
},
"id": "id_8h2k4q",
"itemId": "id_8h2k4q",
"partIndex": 0,
"profileId": "id_8h2k4q",
"reason": "string",
"revision": 0,
"selectable": true,
"size": 0,
"sourceId": "id_8h2k4q",
"sourceRevision": "r12",
"state": "string",
"targetId": "id_8h2k4q"
}
],
"revision": "r12",
"scope": {
"itemId": "id_8h2k4q",
"libraryId": "id_8h2k4q",
"serverId": "id_8h2k4q",
"viewerFence": "string"
},
"sources": [
{
"audioCodec": "string",
"available": true,
"boundary": "string",
"container": "string",
"durationMs": 1800000,
"enabled": true,
"factsRevision": 0,
"factsStatus": "string",
"height": 0,
"id": "id_8h2k4q",
"qualities": [
{
"dataGBPerHour": 0,
"enabled": true,
"id": "id_8h2k4q",
"kind": "string",
"label": "string",
"maxAudioBitrateBps": 0,
"maxVideoBitrateBps": 0,
"reason": "string",
"sameAsOriginal": true,
"targetDisplayHeight": 0
}
],
"reason": "string",
"relation": "string",
"streams": [
{
"channelLayout": "string",
"channels": 0,
"codec": "string",
"colorPrimaries": "string",
"colorTransfer": "string",
"default": true,
"enabled": true,
"forced": true,
"index": 0,
"language": "en",
"reason": "string",
"title": "Fargo",
"type": "string"
}
],
"videoCodec": "string",
"width": 0
}
],
"subtitlePlan": {
"appliedRevision": 0,
"catalogRevision": 0,
"discovered": [
{
"default": true,
"enabled": true,
"forced": true,
"format": "2026-10-18T19:30:00Z",
"hearingImpaired": true,
"id": "id_8h2k4q",
"language": "en",
"origin": "string",
"reason": "string",
"revision": 0,
"sourceId": "id_8h2k4q",
"title": "Fargo"
}
],
"documentUrl": "https://example.com/…",
"generation": 0,
"mode": "string",
"offAvailable": true,
"offsetUs": "string",
"presentation": {
"generation": 0,
"mode": "string",
"positionUs": "string",
"sessionId": "id_8h2k4q",
"streamUrl": "https://example.com/…"
},
"renderer": "string",
"resources": [
{
"attribution": "string",
"canManage": true,
"default": true,
"deliveries": [
{}
],
"discoveryId": "id_8h2k4q",
"enabled": true,
"forced": true,
"format": "2026-10-18T19:30:00Z",
"hearingImpaired": true,
"id": "id_8h2k4q",
"language": "en",
"manifestName": "Fargo",
"offsetUs": "string",
"origin": "string",
"pinned": true,
"provider": "string",
"reason": "string",
"renderer": "string",
"retired": true,
"revision": 0,
"rights": "string",
"scope": "string",
"sourceId": "id_8h2k4q",
"title": "Fargo"
}
],
"revision": 0,
"selected": {
"attribution": "string",
"canManage": true,
"default": true,
"deliveries": [
{
"companionUrl": "https://example.com/…",
"fontsUrl": "https://example.com/…",
"format": "2026-10-18T19:30:00Z",
"linesUrl": "https://example.com/…",
"url": "https://example.com/…"
}
],
"discoveryId": "id_8h2k4q",
"enabled": true,
"forced": true,
"format": "2026-10-18T19:30:00Z",
"hearingImpaired": true,
"id": "id_8h2k4q",
"language": "en",
"manifestName": "Fargo",
"offsetUs": "string",
"origin": "string",
"pinned": true,
"provider": "string",
"reason": "string",
"renderer": "string",
"retired": true,
"revision": 0,
"rights": "string",
"scope": "string",
"sourceId": "id_8h2k4q",
"title": "Fargo"
},
"sessionId": "id_8h2k4q",
"sourceId": "id_8h2k4q",
"version": 0
},
"subtitlePlanUnavailableReason": "Fargo",
"transcodingEnabled": true
}Schema
controlsarray of objectrequired
- enabledbooleanrequired
- idstringrequired
- reasonstringrequired
currentobject | any | nullrequired
- audioSelectionstringrequired
- deliverystringrequired
- generationintegerrequired
- preparedVersionIdstring
- qualityIdstringrequired
- sessionIdstringrequired
- sourceIdstringrequired
- statestringrequired
- subtitleSelectionstringrequired
deliveryPlanobject | any | nullrequired
- airPlayboolean
- audioActionstringrequired
- audioBitrateBpsinteger
- audioChannelsintegerrequired
- audioLosslessboolean
- audioPassthroughboolean
audioRenditionsarray of object
- actionstringrequired
- bitDepthinteger
- bitrateBpsintegerrequired
- channelLayoutstring
- channelsintegerrequired
- codecstringrequired
- commentaryboolean
- defaultbooleanrequired
- downmixstring
- failurestring
- labelstringrequired
- languagestringrequired
- ordinalintegerrequired
- profilestring
- sampleRateinteger
- streamIndexintegerrequired
- titlestring
- audioStreamintegerrequired
burnInobject
- formatstringrequired
- resourceIdstringrequired
- revisionintegerrequired
- deinterlaceboolean
- downmixstring
- durationMsintegerrequired≥ 0
- enginestringrequired
- factsRevisionintegerrequired
- hardwareBackendstringrequired
- maxFrameRatenumber
- modestringrequired
- outputAudioCodecstringrequired
- outputBitDepthinteger
- outputContainerstringrequired
- outputRangestring
- outputVideoCodecstringrequired
policyobject
- allowHDRbooleanrequired
clampsarray of objectrequired
- appliedintegerrequired
- fieldstringrequired
- requestedintegerrequired
- sourcestringrequired
- directPlaystringrequired
- directStreamstringrequired
- maxAudioBitrateBpsintegerrequired
- maxVideoBitrateBpsintegerrequired
- maxVideoHeightintegerrequired
- networkClassstringrequired
- planningPolicystringrequired
- preferenceLanestringrequired
- qualityModestringrequired
- serverLocalitystringrequired
- transcodestringrequired
- transportClassstringrequired
preparedobject
- digeststringrequired
factsobjectrequired
- audioBitDepthinteger
- audioChannelsinteger
- audioCodecstringrequired
- audioSampleRateinteger
- audioTracksintegerrequired
- containerstringrequired
- durationMsintegerrequired≥ 0
- heightintegerrequired
- videoCodecstringrequired
- widthintegerrequired
- revisionintegerrequired
- sizeintegerrequired
- sourceRevisionstringrequired
- versionIdstringrequired
- profilestringrequired
- qualityIdstringrequired
- reasonstringrequired
- reasonCodesarray of stringrequired
- sourceAudioCodecstringrequired
- sourceContainerstringrequired
- sourceIdstringrequired
- sourceVideoCodecstringrequired
- strategystringrequired
- targetDisplayHeightinteger
- targetDisplayWidthinteger
- toneMapbooleanrequired
- toneMapAlgorithmstring
- toneMapOffboolean
traceobject
audioobject
- bitDepthinteger
- channelsinteger
- chosenBystringrequired
- codecstringrequired
- languagestring
- layoutstring
- losslessboolean
- objectAudiostring
- profilestring
- sampleRateinteger
- streamIndexintegerrequired
- tracksintegerrequired
- variantstring
- bitRateinteger
clientobjectrequired
- enginestring
- engineNamestring
- evidencestringrequired
- familystringrequired
- modelstring
- platformstring
- publishedbooleanrequired
- revisionstringrequired
- containerstringrequired
- notesarray of stringrequired
routesarray of objectrequired
- admissiblebooleanrequired
- chosenbooleanrequired
rejectionsarray of objectrequired
- codestringrequired
- detailstring
- routestringrequired
- transportstring
- versionintegerrequired
videoobject
- bitDepthinteger
- bitRateinteger
- chromaSubsamplingstring
- codecstringrequired
- dolbyVisionBaseLayerboolean
- dolbyVisionCmVersionstring
- dolbyVisionCompatibilityinteger
- dolbyVisionEnhancementTypestring
- dolbyVisionLevelinteger
- dolbyVisionProfileinteger
- dolbyVisionRpuboolean
- dynamicRangestring
- frameRatenumber
- frameRateDenominatorinteger
- frameRateModestring
- frameRateNumeratorinteger
- hdr10Plusboolean
- heightinteger
- interlacedboolean
- levelinteger
- masterDisplaystring
- maxCllstring
- outputRangestring
- profilestring
- rotationinteger
- sampleAspectRatiostring
- widthinteger
- videoActionstringrequired
- videoBitrateBpsinteger
deliveryPolicyobject | any | nullrequired
- allowHDRbooleanrequired
clampsarray of objectrequired
- appliedintegerrequired
- fieldstringrequired
- requestedintegerrequired
- sourcestringrequired
- directPlaystringrequired
- directStreamstringrequired
- maxAudioBitrateBpsintegerrequired
- maxVideoBitrateBpsintegerrequired
- maxVideoHeightintegerrequired
- networkClassstringrequired
- planningPolicystringrequired
- preferenceLanestringrequired
- qualityModestringrequired
- serverLocalitystringrequired
- transcodestringrequired
- transportClassstringrequired
markersobject | any | nullrequired
markersarray of objectrequired
- automaticSafebooleanrequired
- endMsintegerrequired≥ 0
- idstringrequired
- kindstringrequired
- startMsintegerrequired≥ 0
- revisionstringrequired
- sourceIdstringrequired
- offersRevisionstringrequired
- preparedOffersRevisionstringrequired
preparedVersionsarray of objectrequired
- createdMsintegerrequired
- digeststringrequired
- editionIdstring | any | nullrequired
factsobjectrequired
- audioBitDepthinteger
- audioChannelsinteger
- audioCodecstringrequired
- audioSampleRateinteger
- audioTracksintegerrequired
- containerstringrequired
- durationMsintegerrequired≥ 0
- heightintegerrequired
- videoCodecstringrequired
- widthintegerrequired
- idstringrequired
- itemIdstringrequired
- partIndexintegerrequired
- profileIdstringrequired
- reasonstringrequired
- revisionintegerrequired
- selectablebooleanrequired
- sizeintegerrequired
- sourceIdstringrequired
- sourceRevisionstringrequired
- statestringrequired
- targetIdstringrequired
- revisionstringrequired
scopeobjectrequired
- itemIdstringrequired
- libraryIdstringrequired
- serverIdstringrequired
- viewerFencestringrequired
sourcesarray of objectrequired
- audioCodecstringrequired
- availablebooleanrequired
- boundarystringrequired
- containerstringrequired
- durationMsintegerrequired≥ 0
- enabledbooleanrequired
- factsRevisionintegerrequired
- factsStatusstringrequired
- heightintegerrequired
- idstringrequired
qualitiesarray of objectrequired
- dataGBPerHournumber
- enabledbooleanrequired
- idstringrequired
- kindstringrequired
- labelstringrequired
- maxAudioBitrateBpsinteger
- maxVideoBitrateBpsinteger
- reasonstring
- sameAsOriginalbooleanrequired
- targetDisplayHeightinteger
- reasonstringrequired
- relationstringrequired
streamsarray of objectrequired
- channelLayoutstring
- channelsinteger
- codecstringrequired
- colorPrimariesstring
- colorTransferstring
- defaultbooleanrequired
- enabledbooleanrequired
- forcedbooleanrequired
- indexintegerrequired
- languagestring
- reasonstringrequired
- titlestring
- typestringrequired
- videoCodecstringrequired
- widthintegerrequired
subtitlePlanobject | any | nullrequired
- appliedRevisioninteger
- catalogRevisionintegerrequired
discoveredarray of objectrequired
- defaultbooleanrequired
- enabledbooleanrequired
- forcedbooleanrequired
- formatstringrequired
- hearingImpairedbooleanrequired
- idstringrequired
- languagestringrequired
- originstringrequired
- reasonstring
- revisionintegerrequired
- sourceIdstringrequired
- titlestringrequired
- documentUrlstring
- generationintegerrequired
- modestringrequired
- offAvailablebooleanrequired
- offsetUsstringrequired
presentationobject
- generationintegerrequired
- modestringrequired
- positionUsstringrequired
- sessionIdstringrequired
- streamUrlstringrequired
- rendererstringrequired
resourcesarray of objectrequired
- attributionstring
- canManagebooleanrequired
- defaultbooleanrequired
deliveriesarray of objectrequired
- companionUrlstring
- fontsUrlstring
- formatstringrequired
- linesUrlstring
- urlstring
- discoveryIdstring
- enabledbooleanrequired
- forcedbooleanrequired
- formatstringrequired
- hearingImpairedbooleanrequired
- idstringrequired
- languagestringrequired
- manifestNamestring
- offsetUsstringrequired
- originstringrequired
- pinnedboolean
- providerstring
- reasonstring
- rendererstringrequired
- retiredboolean
- revisionintegerrequired
- rightsstringrequired
- scopestringrequired
- sourceIdstringrequired
- titlestringrequired
- revisionintegerrequired
selectedobject | any | nullrequired
- attributionstring
- canManagebooleanrequired
- defaultbooleanrequired
deliveriesarray of objectrequired
- companionUrlstring
- fontsUrlstring
- formatstringrequired
- linesUrlstring
- urlstring
- discoveryIdstring
- enabledbooleanrequired
- forcedbooleanrequired
- formatstringrequired
- hearingImpairedbooleanrequired
- idstringrequired
- languagestringrequired
- manifestNamestring
- offsetUsstringrequired
- originstringrequired
- pinnedboolean
- providerstring
- reasonstring
- rendererstringrequired
- retiredboolean
- revisionintegerrequired
- rightsstringrequired
- scopestringrequired
- sourceIdstringrequired
- titlestringrequired
- sessionIdstringrequired
- sourceIdstringrequired
- versionintegerrequired
- subtitlePlanUnavailableReasonstring | any | nullrequired
- transcodingEnabledbooleanrequired
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/items/{id}/playback-offers" \
-H "Authorization: Bearer $PORTICO_API_KEY"GET/v1/items/{id}/prepared-versionsRead title prepared versionsread
- Audience
- Clients · Native API
- Authorization
- API key or personal access token with the read scope, or a signed-in session
- OpenAPI operation ID
get_items_id_prepared_versions
Parameters
| Name | In | Type | Description |
|---|---|---|---|
idrequired | path | string |
Responses
200Successapplication/json
Example
{
"canManage": true,
"configurationReason": "string",
"configured": true,
"itemId": "id_8h2k4q",
"jobs": [
{
"bytes": 0,
"createdMs": 1800000,
"errorCode": "string",
"generation": 0,
"id": "id_8h2k4q",
"itemId": "id_8h2k4q",
"phase": "string",
"profileId": "id_8h2k4q",
"revision": 0,
"sourceId": "id_8h2k4q",
"state": "string",
"targetId": "id_8h2k4q",
"updatedMs": 1800000,
"versionId": "id_8h2k4q"
}
],
"pollAfterMs": 1800000,
"preparedOffersRevision": "r12",
"profiles": [
{
"audioKbps": 0,
"description": "string",
"height": 0,
"id": "id_8h2k4q",
"kind": "string",
"name": "Fargo",
"videoKbps": 0,
"width": 0
}
],
"sources": [
{
"available": true,
"container": "string",
"height": 0,
"id": "id_8h2k4q",
"partIndex": 0,
"reason": "string",
"revision": "r12"
}
],
"targets": [
{
"id": "id_8h2k4q",
"name": "Fargo"
}
],
"versions": [
{
"createdMs": 1800000,
"digest": "string",
"editionId": "id_8h2k4q",
"facts": {
"audioBitDepth": 0,
"audioChannels": 0,
"audioCodec": "string",
"audioSampleRate": 0,
"audioTracks": 0,
"container": "string",
"durationMs": 1800000,
"height": 0,
"videoCodec": "string",
"width": 0
},
"id": "id_8h2k4q",
"itemId": "id_8h2k4q",
"partIndex": 0,
"profileId": "id_8h2k4q",
"reason": "string",
"revision": 0,
"selectable": true,
"size": 0,
"sourceId": "id_8h2k4q",
"sourceRevision": "r12",
"state": "string",
"targetId": "id_8h2k4q"
}
]
}Schema
- canManagebooleanrequired
- configurationReasonstringrequired
- configuredbooleanrequired
- itemIdstringrequired
jobsarray of objectrequired
- bytesintegerrequired
- createdMsintegerrequired
- errorCodestringrequired
- generationintegerrequired
- idstringrequired
- itemIdstringrequired
- phasestringrequired
- profileIdstringrequired
- revisionintegerrequired
- sourceIdstringrequired
- statestringrequired
- targetIdstringrequired
- updatedMsintegerrequired
- versionIdstringrequired
- pollAfterMsintegerrequired
- preparedOffersRevisionstringrequired
profilesarray of objectrequired
- audioKbpsintegerrequired
- descriptionstringrequired
- heightintegerrequired
- idstringrequired
- kindstringrequired
- namestringrequired
- videoKbpsintegerrequired
- widthintegerrequired
sourcesarray of objectrequired
- availablebooleanrequired
- containerstringrequired
- heightintegerrequired
- idstringrequired
- partIndexintegerrequired
- reasonstringrequired
- revisionstringrequired
targetsarray of objectrequired
- idstringrequired
- namestringrequired
versionsarray of objectrequired
- createdMsintegerrequired
- digeststringrequired
- editionIdstring | any | nullrequired
factsobjectrequired
- audioBitDepthinteger
- audioChannelsinteger
- audioCodecstringrequired
- audioSampleRateinteger
- audioTracksintegerrequired
- containerstringrequired
- durationMsintegerrequired≥ 0
- heightintegerrequired
- videoCodecstringrequired
- widthintegerrequired
- idstringrequired
- itemIdstringrequired
- partIndexintegerrequired
- profileIdstringrequired
- reasonstringrequired
- revisionintegerrequired
- selectablebooleanrequired
- sizeintegerrequired
- sourceIdstringrequired
- sourceRevisionstringrequired
- statestringrequired
- targetIdstringrequired
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/items/{id}/prepared-versions" \
-H "Authorization: Bearer $PORTICO_API_KEY"GET/v1/items/{id}/recommendationsRead title recommendationsread
- Audience
- Clients · Native API
- Authorization
- API key or personal access token with the read scope, or a signed-in session
- OpenAPI operation ID
get_items_id_recommendations
Parameters
| Name | In | Type | Description |
|---|---|---|---|
idrequired | path | string | |
limit | query | integer | ""≥ 1 |
Responses
200Successapplication/json
Example
{
"itemId": "id_8h2k4q",
"revision": {
"catalog": 0,
"viewer": 0
},
"rows": [
{
"anchorId": "id_8h2k4q",
"artworkShape": "string",
"cacheTtlMs": 1800000,
"children": [
{
"anchorId": "id_8h2k4q",
"artworkShape": "string",
"cacheTtlMs": 1800000,
"collection": {},
"critical": true,
"cursorCapable": true,
"deferred": false,
"displayTargets": [],
"endpoint": "string",
"entries": [],
"evidenceId": "id_8h2k4q",
"explanation": "string",
"family": "string",
"hasMore": true,
"hideable": true,
"id": "id_8h2k4q",
"kind": "string",
"libraryId": "id_8h2k4q",
"limit": 0,
"live": {},
"nextCursor": "eyJvIjoyMH0",
"period": {},
"platforms": [],
"policyState": "string",
"priority": 0,
"privacySensitivity": "string",
"provider": "string",
"reason": {},
"relation": "string",
"reorderable": true,
"required": true,
"resumes": [],
"revision": {},
"seeAll": {},
"start": 0,
"subtitleText": {},
"title": "Fargo",
"titleText": {},
"total": 0,
"viewerFence": "string",
"why": {},
"whyTitles": []
}
],
"collection": {
"actions": {
"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
},
"backdropUrl": "https://example.com/…",
"collection": {
"id": "id_8h2k4q",
"itemCount": 0,
"libraryId": "id_8h2k4q",
"name": "Fargo",
"origin": "string",
"revision": 0
},
"firstYear": 0,
"lastTitle": "Fargo",
"mediaKind": "string",
"members": [
{}
]
},
"critical": true,
"cursorCapable": true,
"deferred": true,
"displayTargets": [
{
"entryId": "id_8h2k4q",
"membershipId": "id_8h2k4q"
}
],
"endpoint": "string",
"entries": [
{
"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
}
],
"evidenceId": "id_8h2k4q",
"explanation": "string",
"family": "string",
"hasMore": true,
"hideable": true,
"id": "id_8h2k4q",
"kind": "string",
"libraryId": "id_8h2k4q",
"limit": 0,
"live": {
"channels": [
{}
],
"expiresAt": "2026-10-18T19:30:00Z",
"group": "string",
"groups": [
{}
],
"observedAt": "2026-10-18T19:30:00Z",
"revision": "r12",
"sort": "favorites"
},
"nextCursor": "eyJvIjoyMH0",
"period": {
"days": 0,
"end": "string",
"metric": "string",
"start": "string",
"text": {
"code": "string",
"fallback": "string",
"params": {}
}
},
"platforms": [
"string"
],
"policyState": "string",
"priority": 0,
"privacySensitivity": "string",
"provider": "string",
"reason": {
"kind": "string",
"libraryId": "id_8h2k4q",
"source": {
"id": "id_8h2k4q",
"name": "Fargo"
},
"text": {
"code": "string",
"fallback": "string",
"params": {}
}
},
"relation": "string",
"reorderable": true,
"required": true,
"resumes": [
{
"entryId": "id_8h2k4q",
"target": {}
}
],
"revision": {
"catalog": 0,
"viewer": 0
},
"seeAll": {
"group": "string",
"sourceId": "id_8h2k4q",
"type": "guide"
},
"start": 0,
"subtitleText": {
"code": "string",
"fallback": "string",
"params": {
"key": "string"
}
},
"title": "Fargo",
"titleText": {
"code": "string",
"fallback": "string",
"params": {
"key": "string"
}
},
"total": 0,
"viewerFence": "string",
"why": {
"code": "string",
"fallback": "string",
"params": {
"key": "string"
}
},
"whyTitles": [
{
"id": "id_8h2k4q",
"name": "Fargo"
}
]
}
]
}Schema
- itemIdstringrequired
revisionobjectrequired
- catalogintegerrequired
- viewerintegerrequired
rowsarray of objectrequired
- anchorIdstring
- artworkShapestringrequired
- cacheTtlMsintegerrequired
childrenarray of object0–5 items
- anchorIdstring
- artworkShapestringrequired
- cacheTtlMsintegerrequired
collectionobject
actionsobject
- 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
- backdropUrlstring
collectionobjectrequired
- idstringrequired
- itemCountintegerrequired
- libraryIdstringrequired
- namestringrequired
- originstringrequired
- revisionintegerrequired
- firstYearinteger
- lastTitlestring
- mediaKindstringrequired
membersarray of objectrequired0–4 items
- 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
- 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
- stateobjectrequired
- 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
- 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
- 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
- criticalbooleanrequired
- cursorCapablebooleanrequired
- deferredbooleanone of false
displayTargetsarray of object0–60 items
- entryIdstringrequired
- membershipIdstringrequired
- endpointstringrequired
entriesarray of objectrequired0–200 items
- 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
- 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
- evidenceIdstring
- explanationstring
- familystring
- hasMorebooleanrequired
- hideablebooleanrequired
- idstringrequired
- kindstringrequired
- libraryIdstring
- limitintegerrequired
liveobject
channelsarray of objectrequired0–50 items
actionsobjectrequired
- favoritebooleanrequired
- playbooleanrequired
channelobjectrequired
- favoritebooleanrequired
- generationstringrequired
- groupstringrequired
- hiddenbooleanrequired
- idstringrequired
- logoPathstring
markobject
- seedstringrequired
- textstringrequired
- namestringrequired
- numberstringrequired
- preferenceRevisionintegerrequired
programmesarray of objectrequired
- categoriesarray of stringrequired
- channelIdstringrequired
- descriptionstring
- endstringrequired
- episodeobject
- episodeIdstring
- flagsobjectrequired
- idstringrequired
- imagestring
- lineagestringrequired
- newEvidencestring
- ratingobject
- recordingIdstring
- recordingStatestring
- seriesIdstring
- starRatingstring
- startstringrequired
- subtitlestring
- titlestringrequired
- yearinteger
- provenancestringrequired
- recordAvailablebooleanrequired
- recordUnavailableReasonstringrequired
- serverHiddenbooleanrequired
- sourceIdstringrequired
- tuneAvailablebooleanrequired
- tuneUnavailableReasonstringrequired
sourceobjectrequired
- availableEndstringrequired
- availableStartstringrequired
- generationstringrequired
- idstringrequired
- namestringrequired
- provenancestringrequired
- publishedAtstringrequired
- refreshStatestringrequired
- expiresAtstringrequired
- groupstringrequired
groupsarray of objectrequired0–2000 items
- countintegerrequired
- namestringrequired
- observedAtstringrequired
- revisionstringrequired
- sortstringrequiredone of "favorites"
- nextCursorstringrequired
periodobject
- daysintegerrequired
- endstringrequired
- metricstringrequired
- startstringrequired
textobjectrequired
- codestringrequired
- fallbackstringrequired
- paramsobject
- platformsarray of string
- policyStatestringrequired
- priorityintegerrequired
- privacySensitivitystringrequired
- providerstring
reasonobject
- kindstringrequired
- libraryIdstring
sourceobject
- idstringrequired
- namestringrequired
textobjectrequired
- codestringrequired
- fallbackstringrequired
- paramsobject
- relationstring
- reorderablebooleanrequired
- requiredbooleanrequired
resumesarray of object
- entryIdstringrequired
targetobjectrequired
- 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
- 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
- stateobjectrequired
- 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
- 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
- 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
revisionobjectrequired
- catalogintegerrequired
- viewerintegerrequired
seeAllobject
- groupstringlength 1–256
- libraryIdstringlength 1–256
- pivotstringlength 1–256
- queryobject
- resourceIdstringlength 1–256
- rowIdstringlength 1–256
sortarray of object1–1 items
- directionstringrequiredone of "asc", "desc"
- fieldstringrequiredlength 1–256
- sourceIdstringlength 1–256
- typestringrequiredone of "library", "row", "saved_view", "collection", "guide"
- startintegerrequired
subtitleTextobject
- codestringrequired
- fallbackstringrequired
- paramsobject
- titlestringrequired
titleTextobjectrequired
- codestringrequired
- fallbackstringrequired
- paramsobject
- totalintegerrequired
- viewerFencestringrequired
whyobject
- codestringrequired
- fallbackstringrequired
- paramsobject
whyTitlesarray of object0–3 items
- idstringrequired
- namestringrequired
collectionobject
actionsobject
- 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
- backdropUrlstring
collectionobjectrequired
- idstringrequired
- itemCountintegerrequired
- libraryIdstringrequired
- namestringrequired
- originstringrequired
- revisionintegerrequired
- firstYearinteger
- lastTitlestring
- mediaKindstringrequired
membersarray of objectrequired0–4 items
- 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
- 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
- criticalbooleanrequired
- cursorCapablebooleanrequired
- deferredboolean
displayTargetsarray of object0–60 items
- entryIdstringrequired
- membershipIdstringrequired
- endpointstringrequired
entriesarray of objectrequired0–200 items
- 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
- evidenceIdstring
- explanationstring
- familystring
- hasMorebooleanrequired
- hideablebooleanrequired
- idstringrequired
- kindstringrequired
- libraryIdstring
- limitintegerrequired
liveobject
channelsarray of objectrequired0–50 items
actionsobjectrequired
- favoritebooleanrequired
- playbooleanrequired
channelobjectrequired
- favoritebooleanrequired
- generationstringrequired
- groupstringrequired
- hiddenbooleanrequired
- idstringrequired
- logoPathstring
markobject
- seedstringrequired
- textstringrequired
- namestringrequired
- numberstringrequired
- preferenceRevisionintegerrequired
programmesarray of objectrequired
- categoriesarray of stringrequired
- channelIdstringrequired
- descriptionstring
- endstringrequired
episodeobject
- displaystring
- numberinteger
- seasoninteger
- episodeIdstring
flagsobjectrequired
- livebooleanrequired
- newbooleanrequired
- premierebooleanrequired
- repeatbooleanrequired
- idstringrequired
- imagestring
- lineagestringrequired
- newEvidencestring
ratingobject
- systemstringrequired
- valuestringrequired
- recordingIdstring
- recordingStatestring
- seriesIdstring
- starRatingstring
- startstringrequired
- subtitlestring
- titlestringrequired
- yearinteger
- provenancestringrequired
- recordAvailablebooleanrequired
- recordUnavailableReasonstringrequired
- serverHiddenbooleanrequired
- sourceIdstringrequired
- tuneAvailablebooleanrequired
- tuneUnavailableReasonstringrequired
sourceobjectrequired
- availableEndstringrequired
- availableStartstringrequired
- generationstringrequired
- idstringrequired
- namestringrequired
- provenancestringrequired
- publishedAtstringrequired
- refreshStatestringrequired
- expiresAtstringrequired
- groupstringrequired
groupsarray of objectrequired0–2000 items
- countintegerrequired
- namestringrequired
- observedAtstringrequired
- revisionstringrequired
- sortstringrequiredone of "favorites"
- nextCursorstringrequired
periodobject
- daysintegerrequired
- endstringrequired
- metricstringrequired
- startstringrequired
textobjectrequired
- codestringrequired
- fallbackstringrequired
- paramsobject
- platformsarray of string
- policyStatestringrequired
- priorityintegerrequired
- privacySensitivitystringrequired
- providerstring
reasonobject
- kindstringrequired
- libraryIdstring
sourceobject
- idstringrequired
- namestringrequired
textobjectrequired
- codestringrequired
- fallbackstringrequired
- paramsobject
- relationstring
- reorderablebooleanrequired
- requiredbooleanrequired
resumesarray of object
- entryIdstringrequired
targetobjectrequired
- 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
- 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
revisionobjectrequired
- catalogintegerrequired
- viewerintegerrequired
seeAllobject
- groupstringlength 1–256
- libraryIdstringlength 1–256
- pivotstringlength 1–256
- queryobject
- resourceIdstringlength 1–256
- rowIdstringlength 1–256
sortarray of object1–1 items
- directionstringrequiredone of "asc", "desc"
- fieldstringrequiredlength 1–256
- sourceIdstringlength 1–256
- typestringrequiredone of "library", "row", "saved_view", "collection", "guide"
- startintegerrequired
subtitleTextobject
- codestringrequired
- fallbackstringrequired
- paramsobject
- titlestringrequired
titleTextobjectrequired
- codestringrequired
- fallbackstringrequired
- paramsobject
- totalintegerrequired
- viewerFencestringrequired
whyobject
- codestringrequired
- fallbackstringrequired
- paramsobject
whyTitlesarray of object0–3 items
- idstringrequired
- namestringrequired
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/items/{id}/recommendations" \
-H "Authorization: Bearer $PORTICO_API_KEY"GET/v1/items/{id}/recommendations/rows/{row}Page a title recommendation row to exhaustionread
- Audience
- Clients · Native API
- Authorization
- API key or personal access token with the read scope, or a signed-in session
- OpenAPI operation ID
get_items_id_recommendations_row
Parameters
| Name | In | Type | Description |
|---|---|---|---|
idrequired | path | string | |
rowrequired | path | string | |
cursor | query | string | |
limit | query | integer | ""1–200 |
Responses
200Successapplication/json
Example
{
"anchorId": "id_8h2k4q",
"artworkShape": "string",
"cacheTtlMs": 1800000,
"children": [
{
"anchorId": "id_8h2k4q",
"artworkShape": "string",
"cacheTtlMs": 1800000,
"collection": {
"actions": {
"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
},
"backdropUrl": "https://example.com/…",
"collection": {
"id": "id_8h2k4q",
"itemCount": 0,
"libraryId": "id_8h2k4q",
"name": "Fargo",
"origin": "string",
"revision": 0
},
"firstYear": 0,
"lastTitle": "Fargo",
"mediaKind": "string",
"members": [
{}
]
},
"critical": true,
"cursorCapable": true,
"deferred": false,
"displayTargets": [
{
"entryId": "id_8h2k4q",
"membershipId": "id_8h2k4q"
}
],
"endpoint": "string",
"entries": [
{
"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
}
],
"evidenceId": "id_8h2k4q",
"explanation": "string",
"family": "string",
"hasMore": true,
"hideable": true,
"id": "id_8h2k4q",
"kind": "string",
"libraryId": "id_8h2k4q",
"limit": 0,
"live": {
"channels": [
{}
],
"expiresAt": "2026-10-18T19:30:00Z",
"group": "string",
"groups": [
{}
],
"observedAt": "2026-10-18T19:30:00Z",
"revision": "r12",
"sort": "favorites"
},
"nextCursor": "eyJvIjoyMH0",
"period": {
"days": 0,
"end": "string",
"metric": "string",
"start": "string",
"text": {
"code": "string",
"fallback": "string",
"params": {}
}
},
"platforms": [
"string"
],
"policyState": "string",
"priority": 0,
"privacySensitivity": "string",
"provider": "string",
"reason": {
"kind": "string",
"libraryId": "id_8h2k4q",
"source": {
"id": "id_8h2k4q",
"name": "Fargo"
},
"text": {
"code": "string",
"fallback": "string",
"params": {}
}
},
"relation": "string",
"reorderable": true,
"required": true,
"resumes": [
{
"entryId": "id_8h2k4q",
"target": {}
}
],
"revision": {
"catalog": 0,
"viewer": 0
},
"seeAll": {
"group": "string",
"sourceId": "id_8h2k4q",
"type": "guide"
},
"start": 0,
"subtitleText": {
"code": "string",
"fallback": "string",
"params": {
"key": "string"
}
},
"title": "Fargo",
"titleText": {
"code": "string",
"fallback": "string",
"params": {
"key": "string"
}
},
"total": 0,
"viewerFence": "string",
"why": {
"code": "string",
"fallback": "string",
"params": {
"key": "string"
}
},
"whyTitles": [
{
"id": "id_8h2k4q",
"name": "Fargo"
}
]
}
],
"collection": {
"actions": {
"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": {
"collection": true,
"delete": true,
"download": true,
"edit": true,
"favorite": true,
"myList": true,
"play": true,
"playlist": true,
"queue": true,
"refresh": true,
"watched": true
},
"state": {
"containerRevision": 0,
"favorite": true,
"personalRevision": 0,
"rating": 0,
"watched": true,
"watchlisted": true
},
"watched": true
},
"backdropUrl": "https://example.com/…",
"collection": {
"id": "id_8h2k4q",
"itemCount": 0,
"libraryId": "id_8h2k4q",
"name": "Fargo",
"origin": "string",
"revision": 0
},
"firstYear": 0,
"lastTitle": "Fargo",
"mediaKind": "string",
"members": [
{
"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
}
]
},
"critical": true,
"cursorCapable": true,
"deferred": true,
"displayTargets": [
{
"entryId": "id_8h2k4q",
"membershipId": "id_8h2k4q"
}
],
"endpoint": "string",
"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": [
{
"bitDepth": 17,
"codec": "string",
"sampleRate": 1,
"variant": "lossless"
}
],
"bookProgress": {
"bookId": "id_8h2k4q",
"chapter": {
"endMs": 1800000,
"index": 0,
"startMs": 1800000,
"title": "Fargo"
},
"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": {
"collection": true,
"delete": true,
"download": true,
"edit": true,
"favorite": true,
"myList": true,
"play": true,
"playlist": true,
"queue": true,
"refresh": true,
"watched": true
},
"state": {
"containerRevision": 0,
"favorite": true,
"personalRevision": 0,
"rating": 0,
"watched": true,
"watchlisted": true
},
"watched": true
},
"homeTitleContext": {
"genres": [
"string"
],
"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": {
"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"
],
"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",
"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
},
"missing": true,
"narrators": [
"string"
],
"navigation": {
"browse": {
"pivot": "string",
"query": {},
"sort": []
},
"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": [
{
"name": "Fargo",
"position": "string"
}
],
"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
}
],
"evidenceId": "id_8h2k4q",
"explanation": "string",
"family": "string",
"hasMore": true,
"hideable": true,
"id": "id_8h2k4q",
"kind": "string",
"libraryId": "id_8h2k4q",
"limit": 0,
"live": {
"channels": [
{
"actions": {
"favorite": true,
"play": true
},
"channel": {
"favorite": true,
"generation": "string",
"group": "string",
"hidden": true,
"id": "id_8h2k4q",
"logoPath": "string",
"mark": {},
"name": "Fargo",
"number": "string",
"preferenceRevision": 0,
"programmes": [],
"provenance": "string",
"recordAvailable": true,
"recordUnavailableReason": "string",
"serverHidden": true,
"sourceId": "id_8h2k4q",
"tuneAvailable": true,
"tuneUnavailableReason": "string"
},
"source": {
"availableEnd": "string",
"availableStart": "string",
"generation": "string",
"id": "id_8h2k4q",
"name": "Fargo",
"provenance": "string",
"publishedAt": "2026-10-18T19:30:00Z",
"refreshState": "string"
}
}
],
"expiresAt": "2026-10-18T19:30:00Z",
"group": "string",
"groups": [
{
"count": 0,
"name": "Fargo"
}
],
"observedAt": "2026-10-18T19:30:00Z",
"revision": "r12",
"sort": "favorites"
},
"nextCursor": "eyJvIjoyMH0",
"period": {
"days": 0,
"end": "string",
"metric": "string",
"start": "string",
"text": {
"code": "string",
"fallback": "string",
"params": {
"key": "string"
}
}
},
"platforms": [
"string"
],
"policyState": "string",
"priority": 0,
"privacySensitivity": "string",
"provider": "string",
"reason": {
"kind": "string",
"libraryId": "id_8h2k4q",
"source": {
"id": "id_8h2k4q",
"name": "Fargo"
},
"text": {
"code": "string",
"fallback": "string",
"params": {
"key": "string"
}
}
},
"relation": "string",
"reorderable": true,
"required": true,
"resumes": [
{
"entryId": "id_8h2k4q",
"target": {
"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
}
}
],
"revision": {
"catalog": 0,
"viewer": 0
},
"seeAll": {
"group": "string",
"sourceId": "id_8h2k4q",
"type": "guide"
},
"start": 0,
"subtitleText": {
"code": "string",
"fallback": "string",
"params": {
"key": "string"
}
},
"title": "Fargo",
"titleText": {
"code": "string",
"fallback": "string",
"params": {
"key": "string"
}
},
"total": 0,
"viewerFence": "string",
"why": {
"code": "string",
"fallback": "string",
"params": {
"key": "string"
}
},
"whyTitles": [
{
"id": "id_8h2k4q",
"name": "Fargo"
}
]
}Schema
- anchorIdstring
- artworkShapestringrequired
- cacheTtlMsintegerrequired
childrenarray of object0–5 items
- anchorIdstring
- artworkShapestringrequired
- cacheTtlMsintegerrequired
collectionobject
actionsobject
- 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
- backdropUrlstring
collectionobjectrequired
- idstringrequired
- itemCountintegerrequired
- libraryIdstringrequired
- namestringrequired
- originstringrequired
- revisionintegerrequired
- firstYearinteger
- lastTitlestring
- mediaKindstringrequired
membersarray of objectrequired0–4 items
- 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
- 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
- criticalbooleanrequired
- cursorCapablebooleanrequired
- deferredbooleanone of false
displayTargetsarray of object0–60 items
- entryIdstringrequired
- membershipIdstringrequired
- endpointstringrequired
entriesarray of objectrequired0–200 items
- 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
- evidenceIdstring
- explanationstring
- familystring
- hasMorebooleanrequired
- hideablebooleanrequired
- idstringrequired
- kindstringrequired
- libraryIdstring
- limitintegerrequired
liveobject
channelsarray of objectrequired0–50 items
actionsobjectrequired
- favoritebooleanrequired
- playbooleanrequired
channelobjectrequired
- favoritebooleanrequired
- generationstringrequired
- groupstringrequired
- hiddenbooleanrequired
- idstringrequired
- logoPathstring
markobject
- seedstringrequired
- textstringrequired
- namestringrequired
- numberstringrequired
- preferenceRevisionintegerrequired
programmesarray of objectrequired
- categoriesarray of stringrequired
- channelIdstringrequired
- descriptionstring
- endstringrequired
episodeobject
- displaystring
- numberinteger
- seasoninteger
- episodeIdstring
flagsobjectrequired
- livebooleanrequired
- newbooleanrequired
- premierebooleanrequired
- repeatbooleanrequired
- idstringrequired
- imagestring
- lineagestringrequired
- newEvidencestring
ratingobject
- systemstringrequired
- valuestringrequired
- recordingIdstring
- recordingStatestring
- seriesIdstring
- starRatingstring
- startstringrequired
- subtitlestring
- titlestringrequired
- yearinteger
- provenancestringrequired
- recordAvailablebooleanrequired
- recordUnavailableReasonstringrequired
- serverHiddenbooleanrequired
- sourceIdstringrequired
- tuneAvailablebooleanrequired
- tuneUnavailableReasonstringrequired
sourceobjectrequired
- availableEndstringrequired
- availableStartstringrequired
- generationstringrequired
- idstringrequired
- namestringrequired
- provenancestringrequired
- publishedAtstringrequired
- refreshStatestringrequired
- expiresAtstringrequired
- groupstringrequired
groupsarray of objectrequired0–2000 items
- countintegerrequired
- namestringrequired
- observedAtstringrequired
- revisionstringrequired
- sortstringrequiredone of "favorites"
- nextCursorstringrequired
periodobject
- daysintegerrequired
- endstringrequired
- metricstringrequired
- startstringrequired
textobjectrequired
- codestringrequired
- fallbackstringrequired
- paramsobject
- platformsarray of string
- policyStatestringrequired
- priorityintegerrequired
- privacySensitivitystringrequired
- providerstring
reasonobject
- kindstringrequired
- libraryIdstring
sourceobject
- idstringrequired
- namestringrequired
textobjectrequired
- codestringrequired
- fallbackstringrequired
- paramsobject
- relationstring
- reorderablebooleanrequired
- requiredbooleanrequired
resumesarray of object
- entryIdstringrequired
targetobjectrequired
- 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
- 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
revisionobjectrequired
- catalogintegerrequired
- viewerintegerrequired
seeAllobject
- groupstringlength 1–256
- libraryIdstringlength 1–256
- pivotstringlength 1–256
- queryobject
- resourceIdstringlength 1–256
- rowIdstringlength 1–256
sortarray of object1–1 items
- directionstringrequiredone of "asc", "desc"
- fieldstringrequiredlength 1–256
- sourceIdstringlength 1–256
- typestringrequiredone of "library", "row", "saved_view", "collection", "guide"
- startintegerrequired
subtitleTextobject
- codestringrequired
- fallbackstringrequired
- paramsobject
- titlestringrequired
titleTextobjectrequired
- codestringrequired
- fallbackstringrequired
- paramsobject
- totalintegerrequired
- viewerFencestringrequired
whyobject
- codestringrequired
- fallbackstringrequired
- paramsobject
whyTitlesarray of object0–3 items
- idstringrequired
- namestringrequired
collectionobject
actionsobject
- 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
- backdropUrlstring
collectionobjectrequired
- idstringrequired
- itemCountintegerrequired
- libraryIdstringrequired
- namestringrequired
- originstringrequired
- revisionintegerrequired
- firstYearinteger
- lastTitlestring
- mediaKindstringrequired
membersarray of objectrequired0–4 items
- 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
- criticalbooleanrequired
- cursorCapablebooleanrequired
- deferredboolean
displayTargetsarray of object0–60 items
- entryIdstringrequired
- membershipIdstringrequired
- endpointstringrequired
entriesarray of objectrequired0–200 items
- 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
- evidenceIdstring
- explanationstring
- familystring
- hasMorebooleanrequired
- hideablebooleanrequired
- idstringrequired
- kindstringrequired
- libraryIdstring
- limitintegerrequired
liveobject
channelsarray of objectrequired0–50 items
actionsobjectrequired
- favoritebooleanrequired
- playbooleanrequired
channelobjectrequired
- favoritebooleanrequired
- generationstringrequired
- groupstringrequired
- hiddenbooleanrequired
- idstringrequired
- logoPathstring
markobject
- seedstringrequired
- textstringrequired
- namestringrequired
- numberstringrequired
- preferenceRevisionintegerrequired
programmesarray of objectrequired
- categoriesarray of stringrequired
- channelIdstringrequired
- descriptionstring
- endstringrequired
episodeobject
- displaystring
- numberinteger
- seasoninteger
- episodeIdstring
flagsobjectrequired
- livebooleanrequired
- newbooleanrequired
- premierebooleanrequired
- repeatbooleanrequired
- idstringrequired
- imagestring
- lineagestringrequired
- newEvidencestring
ratingobject
- systemstringrequired
- valuestringrequired
- recordingIdstring
- recordingStatestring
- seriesIdstring
- starRatingstring
- startstringrequired
- subtitlestring
- titlestringrequired
- yearinteger
- provenancestringrequired
- recordAvailablebooleanrequired
- recordUnavailableReasonstringrequired
- serverHiddenbooleanrequired
- sourceIdstringrequired
- tuneAvailablebooleanrequired
- tuneUnavailableReasonstringrequired
sourceobjectrequired
- availableEndstringrequired
- availableStartstringrequired
- generationstringrequired
- idstringrequired
- namestringrequired
- provenancestringrequired
- publishedAtstringrequired
- refreshStatestringrequired
- expiresAtstringrequired
- groupstringrequired
groupsarray of objectrequired0–2000 items
- countintegerrequired
- namestringrequired
- observedAtstringrequired
- revisionstringrequired
- sortstringrequiredone of "favorites"
- nextCursorstringrequired
periodobject
- daysintegerrequired
- endstringrequired
- metricstringrequired
- startstringrequired
textobjectrequired
- codestringrequired
- fallbackstringrequired
- paramsobject
- platformsarray of string
- policyStatestringrequired
- priorityintegerrequired
- privacySensitivitystringrequired
- providerstring
reasonobject
- kindstringrequired
- libraryIdstring
sourceobject
- idstringrequired
- namestringrequired
textobjectrequired
- codestringrequired
- fallbackstringrequired
- paramsobject
- relationstring
- reorderablebooleanrequired
- requiredbooleanrequired
resumesarray of object
- entryIdstringrequired
targetobjectrequired
- 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
revisionobjectrequired
- catalogintegerrequired
- viewerintegerrequired
seeAllobject
- groupstringlength 1–256
- libraryIdstringlength 1–256
- pivotstringlength 1–256
- queryobject
- resourceIdstringlength 1–256
- rowIdstringlength 1–256
sortarray of object1–1 items
- directionstringrequiredone of "asc", "desc"
- fieldstringrequiredlength 1–256
- sourceIdstringlength 1–256
- typestringrequiredone of "library", "row", "saved_view", "collection", "guide"
- startintegerrequired
subtitleTextobject
- codestringrequired
- fallbackstringrequired
- paramsobject
- titlestringrequired
titleTextobjectrequired
- codestringrequired
- fallbackstringrequired
- paramsobject
- totalintegerrequired
- viewerFencestringrequired
whyobject
- codestringrequired
- fallbackstringrequired
- paramsobject
whyTitlesarray of object0–3 items
- idstringrequired
- namestringrequired
defaultRequest refused or unavailableapplication/json
Example
{
"error": {
"code": "string",
"message": "string"
}
}Schema
errorobjectrequired
- codestringrequired
- messagestringrequired
Error codesinvalid_requestunauthorizednot_permittednot_foundstale_continuationinternaltimeoutdatabase_busy
Example request
curl -X GET "http://127.0.0.1:32500/v1/items/{id}/recommendations/rows/{row}" \
-H "Authorization: Bearer $PORTICO_API_KEY"GET/v1/items/{id}/similarRead locally ranked permitted listening titlesread
- Audience
- Clients · Native API
- Authorization
- API key or personal access token with the read scope, or a signed-in session
- OpenAPI operation ID
get_items_id_similar
Parameters
| Name | In | Type | Description |
|---|---|---|---|
idrequired | path | string | |
limit | query | integer | ""1–100 | |
by | query | string | |
cursor | query | string |
Responses
200Successapplication/json
Example
{
"data": {
"bySound": true,
"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
}
],
"hasMore": true,
"itemId": "id_8h2k4q",
"libraryId": "id_8h2k4q",
"nextCursor": "eyJvIjoyMH0",
"revision": {
"catalog": 0,
"viewer": 0
}
},
"scope": {
"accountId": "id_8h2k4q",
"authority": "string",
"profileId": "id_8h2k4q",
"serverId": "id_8h2k4q"
}
}Schema
dataobjectrequired
- bySoundbooleanrequired
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
- hasMorebooleanrequired
- itemIdstringrequired
- libraryIdstringrequired
- nextCursorstring
revisionobjectrequired
- catalogintegerrequired
- viewerintegerrequired
scopeobjectrequired
- accountIdstringrequired
- authoritystringrequired
- profileIdstringrequired
- serverIdstringrequired
defaultRequest refused or unavailableapplication/json
Example
{
"error": {
"code": "string",
"message": "string"
}
}Schema
errorobjectrequired
- codestringrequired
- messagestringrequired
Error codesinvalid_requestunauthorizednot_permittednot_foundstale_continuationinternaldatabase_busy
Example request
curl -X GET "http://127.0.0.1:32500/v1/items/{id}/similar" \
-H "Authorization: Bearer $PORTICO_API_KEY"GET/v1/items/{id}/source-availabilityRead title source availabilityread
- Audience
- Clients · Native API
- Authorization
- API key or personal access token with the read scope, or a signed-in session
- OpenAPI operation ID
get_items_id_source_availability
Parameters
| Name | In | Type | Description |
|---|---|---|---|
idrequired | path | string |
Responses
200Successapplication/json
Example
{
"itemId": "id_8h2k4q",
"state": "string"
}Schema
- itemIdstringrequired
- statestringrequired
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/items/{id}/source-availability" \
-H "Authorization: Bearer $PORTICO_API_KEY"GET/v1/items/{id}/trickplayRead title trickplayread
- Audience
- Clients · Native API
- Authorization
- API key or personal access token with the read scope, or a signed-in session
- OpenAPI operation ID
get_items_id_trickplay
Parameters
| Name | In | Type | Description |
|---|---|---|---|
idrequired | path | string |
Responses
200Successapplication/json
Example
{
"scope": {
"itemId": "id_8h2k4q",
"libraryId": "id_8h2k4q",
"serverId": "id_8h2k4q",
"sessionGeneration": 0,
"sessionId": "id_8h2k4q",
"viewerFence": "string"
},
"sets": [
{
"columns": 0,
"durationMs": 1800000,
"frameCount": 0,
"height": 0,
"id": "id_8h2k4q",
"intervalMs": 1800000,
"revision": "r12",
"rows": 0,
"sourceId": "id_8h2k4q",
"sourceOffsetMs": 1800000,
"sourceRevision": "r12",
"stale": true,
"thumbnailsUrl": "https://example.com/…",
"tileCount": 0,
"tileHeight": 0,
"tileWidth": 0,
"tilesUrl": "https://example.com/…",
"width": 0
}
]
}Schema
scopeobjectrequired
- itemIdstringrequired
- libraryIdstringrequired
- serverIdstringrequired
- sessionGenerationintegerrequired
- sessionIdstringrequired
- viewerFencestringrequired
setsarray of objectrequired
- columnsintegerrequired
- durationMsintegerrequired≥ 0
- frameCountintegerrequired
- heightintegerrequired
- idstringrequired
- intervalMsintegerrequired≥ 0
- revisionstringrequired
- rowsintegerrequired
- sourceIdstringrequired
- sourceOffsetMsintegerrequired≥ 0
- sourceRevisionstringrequired
- stalebooleanrequired
- thumbnailsUrlstringrequired
- tileCountintegerrequired
- tileHeightintegerrequired
- tileWidthintegerrequired
- tilesUrlstringrequired
- widthintegerrequired
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/items/{id}/trickplay" \
-H "Authorization: Bearer $PORTICO_API_KEY"GET/v1/items/{id}/trickplay/{set}/thumbnails.vttRead title trickplay thumbnails.vttread
- Audience
- Clients · Native API
- Authorization
- API key or personal access token with the read scope, or a signed-in session
- OpenAPI operation ID
get_items_id_trickplay_set_thumbnails_vtt
Parameters
| Name | In | Type | Description |
|---|---|---|---|
idrequired | path | string | |
setrequired | path | string |
Responses
200Successapplication/octet-stream
Example
"string"Schema
string (binary)
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/items/{id}/trickplay/{set}/thumbnails.vtt" \
-H "Authorization: Bearer $PORTICO_API_KEY"GET/v1/items/{id}/trickplay/{set}/tiles/{tile}.jpgRead or change authorized subtitlesread
- Audience
- Clients · Native API
- Authorization
- API key or personal access token with the read scope, or a signed-in session
- OpenAPI operation ID
get_v1_items_id_trickplay_set_tiles_tile_jpg
Parameters
| Name | In | Type | Description |
|---|---|---|---|
idrequired | path | string | |
setrequired | path | string | |
tilerequired | path | string | |
segment | query | string |
Responses
200Successimage/jpeg
Example
"string"Schema
string (binary)
defaultRequest refused or unavailableapplication/json
Example
{
"error": {
"code": "string",
"message": "string"
}
}Schema
errorobjectrequired
- codestringrequired
- messagestringrequired
Error codesunauthorizednot_permittednot_foundinvalid_requestinternalsubtitle_unavailablesubtitle_not_foundsubtitle_renderer_platform_unsupportedsubtitle_renderer_configurationsubtitle_conflictsubtitle_operation_conflictsubtitle_capacitysubtitle_unsupportedsubtitle_invalid_inputsubtitle_provider_not_configuredsubtitle_provider_key_rejectedsubtitle_provider_sign_in_failedsubtitle_provider_sign_in_requiredsubtitle_provider_quotasubtitle_provider_busydatabase_busy
Example request
curl -X GET "http://127.0.0.1:32500/v1/items/{id}/trickplay/{set}/tiles/{tile}.jpg" \
-H "Authorization: Bearer $PORTICO_API_KEY"GET/v1/items/{itemId}/download-optionsList offline qualities this device can play and this server can produceread
- Audience
- Clients · Native API
- Authorization
- API key or personal access token with the read scope, or a signed-in session
- OpenAPI operation ID
get_download_options
Parameters
| Name | In | Type | Description |
|---|---|---|---|
itemIdrequired | path | string | |
versionId | query | string |
Responses
200Successapplication/json
Example
{
"defaultQuality": "string",
"itemId": "id_8h2k4q",
"kind": "string",
"options": [
{
"available": true,
"dataGBPerHour": 0,
"effectiveQuality": "string",
"estimated": true,
"estimatedBytes": 0,
"kind": "string",
"label": "string",
"maxAudioBitrateBps": 0,
"maxVideoBitrateBps": 0,
"preparationId": "id_8h2k4q",
"preparationState": "string",
"preparedProfileId": "id_8h2k4q",
"preparedVersionId": "id_8h2k4q",
"quality": "string",
"reason": "string",
"requiresPreparation": true,
"sameAsOriginal": true,
"targetDisplayHeight": 0
}
],
"policy": {
"allowDownloads": true,
"reason": "string"
},
"source": {
"audioCodec": "string",
"available": true,
"bytes": 0,
"container": "string",
"durationMs": 1800000,
"height": 0,
"videoCodec": "string"
},
"storage": {
"committedBytes": 0,
"maxPreparedBytes": 0,
"remainingBytes": 0,
"retentionDays": 0
}
}Schema
- defaultQualitystringrequired
- itemIdstringrequired
- kindstringrequired
optionsarray of objectrequired
- availablebooleanrequired
- dataGBPerHournumber
- effectiveQualitystringrequired
- estimatedbooleanrequired
- estimatedBytesintegerrequired
- kindstringrequired
- labelstringrequired
- maxAudioBitrateBpsinteger
- maxVideoBitrateBpsinteger
- preparationIdstring
- preparationStatestring
- preparedProfileIdstring
- preparedVersionIdstring
- qualitystringrequired
- reasonstring
- requiresPreparationbooleanrequired
- sameAsOriginalbooleanrequired
- targetDisplayHeightinteger
policyobjectrequired
- allowDownloadsbooleanrequired
- reasonstring
sourceobjectrequired
- audioCodecstring
- availablebooleanrequired
- bytesintegerrequired
- containerstringrequired
- durationMsintegerrequired≥ 0
- heightinteger
- videoCodecstring
storageobjectrequired
- committedBytesintegerrequired
- maxPreparedBytesintegerrequired
- remainingBytesinteger | any | nullrequired
- retentionDaysintegerrequired
defaultRequest refused or unavailableapplication/json
Example
{
"error": {
"code": "string",
"message": "string"
}
}Schema
errorobjectrequired
- codestringrequired
- messagestringrequired
Error codesinvalid_requestunauthorizednot_permittedfeature_restrictednot_founddownloads_not_alloweddownloads_unavailableinternaltimeoutdatabase_busy
Example request
curl -X GET "http://127.0.0.1:32500/v1/items/{itemId}/download-options" \
-H "Authorization: Bearer $PORTICO_API_KEY"GET/v1/items/{itemId}/playback-optionsRead what a title offers and what this device would getread
- Audience
- Clients · Native API
- Authorization
- API key or personal access token with the read scope, or a signed-in session
- OpenAPI operation ID
get_playback_options
Parameters
| Name | In | Type | Description |
|---|---|---|---|
itemIdrequired | path | string | |
discTitleId | query | string | |
discTitleRevision | query | string | |
versionId | query | string | |
partId | query | string | |
audioId | query | string | |
subtitleId | query | string | |
quality | query | string | |
qualityId | query | string | |
maxVideoBitrateKbps | query | string | |
maxHeight | query | string | |
maxAudioBitrateKbps | query | string | |
throughputKbps | query | string |
Responses
200Successapplication/json
Example
{
"alternatives": [
{
"label": "string",
"versionId": "id_8h2k4q"
}
],
"chapters": [
{
"startMs": 1800000,
"title": "Fargo"
}
],
"collection": {
"id": "id_8h2k4q",
"next": {
"backdropUrl": "https://example.com/…",
"genres": [
"string"
],
"id": "id_8h2k4q",
"title": "Fargo",
"year": 0
},
"title": "Fargo"
},
"itemId": "id_8h2k4q",
"kind": "string",
"markers": [
{
"automaticSafe": true,
"confidence": "string",
"endMs": 1800000,
"id": "id_8h2k4q",
"startMs": 1800000,
"type": "string"
}
],
"plan": {
"engine": "string",
"estimatedBitrateKbps": 0,
"mode": "string",
"quality": {
"id": "id_8h2k4q",
"maxAudioBitrateKbps": 0,
"maxHeight": 0,
"maxVideoBitrateKbps": 0,
"mode": "string",
"step": "string"
},
"streams": [
{
"action": "string",
"id": "id_8h2k4q",
"reasons": [
"string"
],
"to": "string"
}
],
"versionId": "id_8h2k4q"
},
"preferred": {
"audioId": "id_8h2k4q",
"quality": {
"id": "id_8h2k4q",
"maxAudioBitrateKbps": 0,
"maxHeight": 0,
"maxVideoBitrateKbps": 0,
"mode": "string",
"step": "string"
},
"reason": "string",
"versionId": "id_8h2k4q"
},
"qualities": [
{
"applicable": true,
"dataGBPerHour": 0,
"id": "id_8h2k4q",
"maxAudioBitrateKbps": 0,
"maxHeight": 0,
"maxVideoBitrateKbps": 0,
"mode": "string",
"sameAsOriginal": true
}
],
"resume": {
"partIndex": 0,
"positionMs": 1800000,
"updatedAt": "2026-10-18T19:30:00Z"
},
"versions": [
{
"audio": [
{
"atmos": true,
"bitDepth": 0,
"channels": 0,
"codec": "string",
"commentary": true,
"default": true,
"dtsx": true,
"id": "id_8h2k4q",
"language": "en",
"layout": "string",
"objectAudio": "string",
"profile": "string",
"sampleRate": 0,
"title": "Fargo",
"variant": "string",
"visualImpaired": true
}
],
"bitrateKbps": 0,
"container": "string",
"disc": {
"chapterCount": 0,
"kind": "bluray",
"packaging": "iso",
"titleNumber": 0
},
"discTitle": {
"id": "id_8h2k4q",
"revision": "r12"
},
"discTitles": {
"kind": "bluray",
"packaging": "iso",
"ready": true,
"revision": "r12",
"titles": [
{}
],
"versionId": "id_8h2k4q"
},
"durationMs": 1800000,
"edition": "string",
"id": "id_8h2k4q",
"label": "string",
"parts": [
{
"durationMs": 1800000,
"id": "id_8h2k4q",
"index": 0,
"sizeBytes": 0
}
],
"sizeBytes": 0,
"subtitles": [
{
"default": true,
"deliveries": [],
"forced": true,
"format": "2026-10-18T19:30:00Z",
"id": "id_8h2k4q",
"language": "en",
"sdh": true,
"source": "string",
"title": "Fargo"
}
],
"video": [
{
"bitDepth": 0,
"bitrateKbps": 0,
"chromaSubsampling": "string",
"codec": "string",
"dolbyVisionBaseLayer": true,
"dolbyVisionCmVersion": "string",
"dolbyVisionCompatibility": 0,
"dolbyVisionEnhancementType": "string",
"dolbyVisionProfile": 0,
"dolbyVisionRpu": true,
"fps": 0,
"frameRateDenominator": 0,
"frameRateMode": "string",
"frameRateNumerator": 0,
"hdr": "string",
"hdr10Plus": true,
"height": 0,
"id": "id_8h2k4q",
"interlaced": true,
"level": 0,
"masterDisplay": "string",
"maxCll": "string",
"profile": "string",
"width": 0
}
]
}
]
}Schema
alternativesarray of objectrequired
- labelstringrequired
- versionIdstringrequired
chaptersarray of objectrequired
- startMsintegerrequired
- titlestringrequired
collectionobject
- idstringrequired
nextobjectrequired
- backdropUrlstring
- genresarray of stringrequired
- idstringrequired
- titlestringrequired
- yearinteger
- titlestringrequired
- itemIdstringrequired
- kindstringrequired
markersarray of objectrequired
- automaticSafebooleanrequired
- confidencestringrequired
- endMsintegerrequired
- idstringrequired
- startMsintegerrequired
- typestringrequired
planobject
- enginestringrequired
- estimatedBitrateKbpsinteger
- modestringrequired
qualityobjectrequired
- idstring
- maxAudioBitrateKbpsinteger
- maxHeightinteger
- maxVideoBitrateKbpsinteger
- modestringrequired
- stepstring
streamsarray of objectrequired
- actionstringrequired
- idstringrequired
- reasonsarray of stringrequired
- tostring
- versionIdstringrequired
preferredobject
- audioIdstring
qualityobjectrequired
- idstring
- maxAudioBitrateKbpsinteger
- maxHeightinteger
- maxVideoBitrateKbpsinteger
- modestringrequired
- stepstring
- reasonstringrequired
- versionIdstringrequired
qualitiesarray of objectrequired
- applicablebooleanrequired
- dataGBPerHournumber
- idstring
- maxAudioBitrateKbpsinteger
- maxHeightinteger
- maxVideoBitrateKbpsinteger
- modestringrequired
- sameAsOriginalbooleanrequired
resumeobject
- partIndexintegerrequired
- positionMsintegerrequired
- updatedAtstring
versionsarray of objectrequired
audioarray of objectrequired
- atmosbooleanrequired
- bitDepthinteger
- channelsinteger
- codecstringrequired
- commentarybooleanrequired
- defaultbooleanrequired
- dtsxbooleanrequired
- idstringrequired
- languagestring
- layoutstring
- objectAudiostring
- profilestring
- sampleRateinteger
- titlestring
- variantstring
- visualImpairedbooleanrequired
- bitrateKbpsinteger
- containerstring
discobject
- chapterCountintegerrequired
- kindstringrequiredone of "bluray", "dvd"
- packagingstringrequiredone of "iso", "folder"
- titleNumberintegerrequired
discTitleobject
- idstringrequired
- revisionstringrequired
discTitlesobject
- kindstringrequiredone of "bluray", "dvd"
- packagingstringrequiredone of "iso", "folder"
- readybooleanrequired
- revisionstringrequired
titlesarray of objectrequired
- chapterCountintegerrequired
- durationMsintegerrequired
- idstringrequired
- mainbooleanrequired
- numberintegerrequired
- readybooleanrequired
- revisionstring
- versionIdstringrequired
- durationMsintegerrequired
- editionstring
- idstringrequired
- labelstringrequired
partsarray of objectrequired
- durationMsintegerrequired
- idstringrequired
- indexintegerrequired
- sizeBytesintegerrequired
- sizeBytesintegerrequired
subtitlesarray of objectrequired
- defaultbooleanrequired
deliveriesarray of objectrequired
- companionUrlstring
- fontsUrlstring
- formatstringrequired
- linesUrlstring
- urlstring
- forcedbooleanrequired
- formatstringrequired
- idstringrequired
- languagestring
- sdhbooleanrequired
- sourcestringrequired
- titlestring
videoarray of objectrequired
- bitDepthinteger
- bitrateKbpsinteger
- chromaSubsamplingstring
- codecstringrequired
- dolbyVisionBaseLayerbooleanrequired
- dolbyVisionCmVersionstring
- dolbyVisionCompatibilityinteger
- dolbyVisionEnhancementTypestring
- dolbyVisionProfileinteger
- dolbyVisionRpubooleanrequired
- fpsnumber
- frameRateDenominatorinteger
- frameRateModestring
- frameRateNumeratorinteger
- hdrstring
- hdr10Plusbooleanrequired
- heightinteger
- idstringrequired
- interlacedboolean
- levelinteger
- masterDisplaystring
- maxCllstring
- profilestring
- widthinteger
defaultRequest refused or unavailableapplication/json
Example
{
"error": {
"code": "string",
"message": "string"
}
}Schema
errorobjectrequired
- codestringrequired
- messagestringrequired
Error codesinvalid_requestunauthorizednot_foundtimeoutdatabase_busy
Example request
curl -X GET "http://127.0.0.1:32500/v1/items/{itemId}/playback-options" \
-H "Authorization: Bearer $PORTICO_API_KEY"GET/v1/items/{itemId}/playback/{session}/subtitlesRead or change authorized subtitlesread
- Audience
- Clients · Native API
- Authorization
- API key or personal access token with the read scope, or a signed-in session
- OpenAPI operation ID
get_v1_items_itemId_playback_session_subtitles
Parameters
| Name | In | Type | Description |
|---|---|---|---|
itemIdrequired | path | string | |
sessionrequired | path | string | |
segment | query | string |
Responses
200Successapplication/json
Example
{
"appliedRevision": 0,
"catalogRevision": 0,
"discovered": [
{
"default": true,
"enabled": true,
"forced": true,
"format": "2026-10-18T19:30:00Z",
"hearingImpaired": true,
"id": "id_8h2k4q",
"language": "en",
"origin": "string",
"reason": "string",
"revision": 0,
"sourceId": "id_8h2k4q",
"title": "Fargo"
}
],
"documentUrl": "https://example.com/…",
"generation": 0,
"mode": "string",
"offAvailable": true,
"offsetUs": "string",
"presentation": {
"generation": 0,
"mode": "string",
"positionUs": "string",
"sessionId": "id_8h2k4q",
"streamUrl": "https://example.com/…"
},
"renderer": "string",
"resources": [
{
"attribution": "string",
"canManage": true,
"default": true,
"deliveries": [
{
"companionUrl": "https://example.com/…",
"fontsUrl": "https://example.com/…",
"format": "2026-10-18T19:30:00Z",
"linesUrl": "https://example.com/…",
"url": "https://example.com/…"
}
],
"discoveryId": "id_8h2k4q",
"enabled": true,
"forced": true,
"format": "2026-10-18T19:30:00Z",
"hearingImpaired": true,
"id": "id_8h2k4q",
"language": "en",
"manifestName": "Fargo",
"offsetUs": "string",
"origin": "string",
"pinned": true,
"provider": "string",
"reason": "string",
"renderer": "string",
"retired": true,
"revision": 0,
"rights": "string",
"scope": "string",
"sourceId": "id_8h2k4q",
"title": "Fargo"
}
],
"revision": 0,
"selected": {
"attribution": "string",
"canManage": true,
"default": true,
"deliveries": [
{
"companionUrl": "https://example.com/…",
"fontsUrl": "https://example.com/…",
"format": "2026-10-18T19:30:00Z",
"linesUrl": "https://example.com/…",
"url": "https://example.com/…"
}
],
"discoveryId": "id_8h2k4q",
"enabled": true,
"forced": true,
"format": "2026-10-18T19:30:00Z",
"hearingImpaired": true,
"id": "id_8h2k4q",
"language": "en",
"manifestName": "Fargo",
"offsetUs": "string",
"origin": "string",
"pinned": true,
"provider": "string",
"reason": "string",
"renderer": "string",
"retired": true,
"revision": 0,
"rights": "string",
"scope": "string",
"sourceId": "id_8h2k4q",
"title": "Fargo"
},
"sessionId": "id_8h2k4q",
"sourceId": "id_8h2k4q",
"version": 0
}Schema
- appliedRevisioninteger
- catalogRevisionintegerrequired
discoveredarray of objectrequired
- defaultbooleanrequired
- enabledbooleanrequired
- forcedbooleanrequired
- formatstringrequired
- hearingImpairedbooleanrequired
- idstringrequired
- languagestringrequired
- originstringrequired
- reasonstring
- revisionintegerrequired
- sourceIdstringrequired
- titlestringrequired
- documentUrlstring
- generationintegerrequired
- modestringrequired
- offAvailablebooleanrequired
- offsetUsstringrequired
presentationobject
- generationintegerrequired
- modestringrequired
- positionUsstringrequired
- sessionIdstringrequired
- streamUrlstringrequired
- rendererstringrequired
resourcesarray of objectrequired
- attributionstring
- canManagebooleanrequired
- defaultbooleanrequired
deliveriesarray of objectrequired
- companionUrlstring
- fontsUrlstring
- formatstringrequired
- linesUrlstring
- urlstring
- discoveryIdstring
- enabledbooleanrequired
- forcedbooleanrequired
- formatstringrequired
- hearingImpairedbooleanrequired
- idstringrequired
- languagestringrequired
- manifestNamestring
- offsetUsstringrequired
- originstringrequired
- pinnedboolean
- providerstring
- reasonstring
- rendererstringrequired
- retiredboolean
- revisionintegerrequired
- rightsstringrequired
- scopestringrequired
- sourceIdstringrequired
- titlestringrequired
- revisionintegerrequired
selectedobject | any | nullrequired
- attributionstring
- canManagebooleanrequired
- defaultbooleanrequired
deliveriesarray of objectrequired
- companionUrlstring
- fontsUrlstring
- formatstringrequired
- linesUrlstring
- urlstring
- discoveryIdstring
- enabledbooleanrequired
- forcedbooleanrequired
- formatstringrequired
- hearingImpairedbooleanrequired
- idstringrequired
- languagestringrequired
- manifestNamestring
- offsetUsstringrequired
- originstringrequired
- pinnedboolean
- providerstring
- reasonstring
- rendererstringrequired
- retiredboolean
- revisionintegerrequired
- rightsstringrequired
- scopestringrequired
- sourceIdstringrequired
- titlestringrequired
- sessionIdstringrequired
- sourceIdstringrequired
- versionintegerrequired
defaultRequest refused or unavailableapplication/json
Example
{
"error": {
"code": "string",
"message": "string"
}
}Schema
errorobjectrequired
- codestringrequired
- messagestringrequired
Error codesunauthorizednot_permittednot_foundinvalid_requestinternalsubtitle_unavailablesubtitle_not_foundsubtitle_renderer_platform_unsupportedsubtitle_renderer_configurationsubtitle_conflictsubtitle_operation_conflictsubtitle_capacitysubtitle_unsupportedsubtitle_invalid_inputsubtitle_provider_not_configuredsubtitle_provider_key_rejectedsubtitle_provider_sign_in_failedsubtitle_provider_sign_in_requiredsubtitle_provider_quotasubtitle_provider_busydatabase_busy
Example request
curl -X GET "http://127.0.0.1:32500/v1/items/{itemId}/playback/{session}/subtitles" \
-H "Authorization: Bearer $PORTICO_API_KEY"GET/v1/items/{itemId}/reading/favoriteRead this profile's Reading Favorite flagread
- Audience
- Clients · Native API
- Authorization
- API key or personal access token with the read scope, or a signed-in session
- OpenAPI operation ID
get_items_itemId_reading_favorite
Parameters
| Name | In | Type | Description |
|---|---|---|---|
itemIdrequired | path | string |
Responses
200Successapplication/json
Example
{
"favorite": true,
"itemId": "id_8h2k4q",
"operationId": "id_8h2k4q",
"revision": 0,
"serverId": "id_8h2k4q",
"viewerFence": "string"
}Schema
- favoritebooleanrequired
- itemIdstringrequiredlength 1–64pattern ^[A-Za-z0-9_-]{1,64}$
- operationIdstringlength 1–128
- revisionintegerrequired≥ 0
- serverIdstringrequiredlength 1–128
- viewerFencestringrequiredlength 1–128
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/items/{itemId}/reading/favorite" \
-H "Authorization: Bearer $PORTICO_API_KEY"PUT/v1/items/{itemId}/reading/favoriteSet Reading Favorite flag without changing progressplayback
- Audience
- Clients · Native API
- Authorization
- API key or personal access token with the playback scope, or a signed-in session
- OpenAPI operation ID
put_items_itemId_reading_favorite- Max body
- 4 KiB
Parameters
| Name | In | Type | Description |
|---|---|---|---|
itemIdrequired | path | string | |
Idempotency-Key | header | string | |
Portico-Mutation-Root | header | string |
Request body application/json · required
Example
{
"expectedRevision": 0,
"favorite": true,
"operationId": "id_8h2k4q"
}Schema
- expectedRevisionintegerrequired≥ 0
- favoritebooleanrequired
- operationIdstringrequiredlength 1–128pattern ^[A-Za-z0-9_-]{1,128}$
Responses
200Successapplication/json
Example
{
"favorite": true,
"itemId": "id_8h2k4q",
"operationId": "id_8h2k4q",
"revision": 0,
"serverId": "id_8h2k4q",
"viewerFence": "string"
}Schema
- favoritebooleanrequired
- itemIdstringrequiredlength 1–64pattern ^[A-Za-z0-9_-]{1,64}$
- operationIdstringlength 1–128
- revisionintegerrequired≥ 0
- serverIdstringrequiredlength 1–128
- viewerFencestringrequiredlength 1–128
defaultRequest refused or unavailableapplication/json
Example
{
"error": {
"code": "string",
"message": "string"
}
}Schema
errorobjectrequired
- codestringrequired
- messagestringrequired
Error codesinvalid_requestunauthorizednot_permittednot_foundinternalrate_limitedpersonal_state_conflictpersonal_needs_resolutionpersonal_needs_reviewoperation_expiredidempotency_key_reusedstale_continuationidempotency_conflictreceipt_expiredinvalid_mutation_keydatabase_busywriter_capacity
Example request
curl -X PUT "http://127.0.0.1:32500/v1/items/{itemId}/reading/favorite" \
-H "Authorization: Bearer $PORTICO_API_KEY" \
-H "Content-Type: application/json" \
-d '{"expectedRevision":0,"favorite":true,"operationId":"id_8h2k4q"}'GET/v1/items/{itemId}/reading/markRead this profile's explicit Reading completion markread
- Audience
- Clients · Native API
- Authorization
- API key or personal access token with the read scope, or a signed-in session
- OpenAPI operation ID
get_items_itemId_reading_mark
Parameters
| Name | In | Type | Description |
|---|---|---|---|
itemIdrequired | path | string |
Responses
200Successapplication/json
Example
{
"itemId": "id_8h2k4q",
"operationId": "id_8h2k4q",
"read": true,
"revision": 0,
"serverId": "id_8h2k4q",
"viewerFence": "string"
}Schema
- itemIdstringrequiredlength 1–64pattern ^[A-Za-z0-9_-]{1,64}$
- operationIdstringlength 1–128
- readbooleanrequired
- revisionintegerrequired≥ 0
- serverIdstringrequiredlength 1–128
- viewerFencestringrequiredlength 1–128
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/items/{itemId}/reading/mark" \
-H "Authorization: Bearer $PORTICO_API_KEY"PUT/v1/items/{itemId}/reading/markSet an explicit Reading completion mark without changing its locationplayback
- Audience
- Clients · Native API
- Authorization
- API key or personal access token with the playback scope, or a signed-in session
- OpenAPI operation ID
put_items_itemId_reading_mark- Max body
- 4 KiB
Parameters
| Name | In | Type | Description |
|---|---|---|---|
itemIdrequired | path | string | |
Idempotency-Key | header | string | |
Portico-Mutation-Root | header | string |
Request body application/json · required
Example
{
"expectedRevision": 0,
"operationId": "id_8h2k4q",
"read": true
}Schema
- expectedRevisionintegerrequired≥ 0
- operationIdstringrequiredlength 1–128pattern ^[A-Za-z0-9_-]{1,128}$
- readbooleanrequired
Responses
200Successapplication/json
Example
{
"itemId": "id_8h2k4q",
"operationId": "id_8h2k4q",
"read": true,
"revision": 0,
"serverId": "id_8h2k4q",
"viewerFence": "string"
}Schema
- itemIdstringrequiredlength 1–64pattern ^[A-Za-z0-9_-]{1,64}$
- operationIdstringlength 1–128
- readbooleanrequired
- revisionintegerrequired≥ 0
- serverIdstringrequiredlength 1–128
- viewerFencestringrequiredlength 1–128
defaultRequest refused or unavailableapplication/json
Example
{
"error": {
"code": "string",
"message": "string"
}
}Schema
errorobjectrequired
- codestringrequired
- messagestringrequired
Error codesinvalid_requestunauthorizednot_permittednot_foundinternalrate_limitedpersonal_state_conflictpersonal_needs_resolutionpersonal_needs_reviewoperation_expiredidempotency_key_reusedstale_continuationidempotency_conflictreceipt_expiredinvalid_mutation_keydatabase_busywriter_capacity
Example request
curl -X PUT "http://127.0.0.1:32500/v1/items/{itemId}/reading/mark" \
-H "Authorization: Bearer $PORTICO_API_KEY" \
-H "Content-Type: application/json" \
-d '{"expectedRevision":0,"operationId":"id_8h2k4q","read":true}'GET/v1/items/{itemId}/reading/my-listRead this profile's Reading My List membershipread
- Audience
- Clients · Native API
- Authorization
- API key or personal access token with the read scope, or a signed-in session
- OpenAPI operation ID
get_items_itemId_reading_my_list
Parameters
| Name | In | Type | Description |
|---|---|---|---|
itemIdrequired | path | string |
Responses
200Successapplication/json
Example
{
"itemId": "id_8h2k4q",
"listed": true,
"operationId": "id_8h2k4q",
"revision": 0,
"serverId": "id_8h2k4q",
"viewerFence": "string"
}Schema
- itemIdstringrequiredlength 1–64pattern ^[A-Za-z0-9_-]{1,64}$
- listedbooleanrequired
- operationIdstringlength 1–128
- revisionintegerrequired≥ 0
- serverIdstringrequiredlength 1–128
- viewerFencestringrequiredlength 1–128
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/items/{itemId}/reading/my-list" \
-H "Authorization: Bearer $PORTICO_API_KEY"PUT/v1/items/{itemId}/reading/my-listSet Reading My List membership without changing progressplayback
- Audience
- Clients · Native API
- Authorization
- API key or personal access token with the playback scope, or a signed-in session
- OpenAPI operation ID
put_items_itemId_reading_my_list- Max body
- 4 KiB
Parameters
| Name | In | Type | Description |
|---|---|---|---|
itemIdrequired | path | string | |
Idempotency-Key | header | string | |
Portico-Mutation-Root | header | string |
Request body application/json · required
Example
{
"expectedRevision": 0,
"listed": true,
"operationId": "id_8h2k4q"
}Schema
- expectedRevisionintegerrequired≥ 0
- listedbooleanrequired
- operationIdstringrequiredlength 1–128pattern ^[A-Za-z0-9_-]{1,128}$
Responses
200Successapplication/json
Example
{
"itemId": "id_8h2k4q",
"listed": true,
"operationId": "id_8h2k4q",
"revision": 0,
"serverId": "id_8h2k4q",
"viewerFence": "string"
}Schema
- itemIdstringrequiredlength 1–64pattern ^[A-Za-z0-9_-]{1,64}$
- listedbooleanrequired
- operationIdstringlength 1–128
- revisionintegerrequired≥ 0
- serverIdstringrequiredlength 1–128
- viewerFencestringrequiredlength 1–128
defaultRequest refused or unavailableapplication/json
Example
{
"error": {
"code": "string",
"message": "string"
}
}Schema
errorobjectrequired
- codestringrequired
- messagestringrequired
Error codesinvalid_requestunauthorizednot_permittednot_foundinternalrate_limitedpersonal_state_conflictpersonal_needs_resolutionpersonal_needs_reviewoperation_expiredidempotency_key_reusedstale_continuationidempotency_conflictreceipt_expiredinvalid_mutation_keydatabase_busywriter_capacity
Example request
curl -X PUT "http://127.0.0.1:32500/v1/items/{itemId}/reading/my-list" \
-H "Authorization: Bearer $PORTICO_API_KEY" \
-H "Content-Type: application/json" \
-d '{"expectedRevision":0,"listed":true,"operationId":"id_8h2k4q"}'POST/v1/items/{itemId}/reading/rereadRe-read the exact reading source and refresh file metadataplayback
- Audience
- Clients · Native API
- Authorization
- API key or personal access token with the playback scope, or a signed-in session
- OpenAPI operation ID
post_items_itemId_reading_reread- Max body
- 4 KiB
Parameters
| Name | In | Type | Description |
|---|---|---|---|
itemIdrequired | path | string |
Request body application/json · required
Example
{
"expectedMetadataRevision": "r12",
"expectedSourceRevision": "r12",
"sourceId": "id_8h2k4q"
}Schema
- expectedMetadataRevisionstringrequired
- expectedSourceRevisionstringrequired
- sourceIdstringrequired
Responses
200Successapplication/json
Example
{
"metadataRevision": "r12",
"refreshed": [
"string"
],
"sourceId": "id_8h2k4q",
"sourceRevision": "r12",
"unknown": [
"string"
]
}Schema
- metadataRevisionstringrequired
- refreshedarray of stringrequired
- sourceIdstringrequired
- sourceRevisionstringrequired
- unknownarray of string
defaultRequest refused or unavailableapplication/json
Example
{
"error": {
"code": "string",
"message": "string"
}
}Schema
errorobjectrequired
- codestringrequired
- messagestringrequired
Error codesinvalid_requestunauthorizednot_permittednot_foundrevision_requiredrevision_mismatchrequest_in_progressbody_too_largeinternalmetadata_conflictsource_unavailabledatabase_busywriter_capacity
Example request
curl -X POST "http://127.0.0.1:32500/v1/items/{itemId}/reading/reread" \
-H "Authorization: Bearer $PORTICO_API_KEY" \
-H "Content-Type: application/json" \
-d '{"expectedMetadataRevision":"r12","expectedSourceRevision":"r12","sourceId":"id_8h2k4q"}'GET/v1/items/{itemId}/reading/versionsList a reading publication's actual versionsread
- Audience
- Clients · Native API
- Authorization
- API key or personal access token with the read scope, or a signed-in session
- OpenAPI operation ID
get_items_itemId_reading_versions
Parameters
| Name | In | Type | Description |
|---|---|---|---|
itemIdrequired | path | string |
Responses
200Successapplication/json
Example
{
"chosenSourceId": "id_8h2k4q",
"versions": [
{
"format": "epub",
"inventoryAvailable": true,
"size": 0,
"sourceId": "id_8h2k4q"
}
]
}Schema
- chosenSourceIdstring
versionsarray of objectrequired
- formatstringrequiredone of "epub", "pdf", "cbz", "mobi", "azw3", "cb7", "cbr"
- inventoryAvailablebooleanrequired
- sizeintegerrequired
- sourceIdstringrequired
defaultRequest refused or unavailableapplication/json
Example
{
"error": {
"code": "string",
"message": "string"
}
}Schema
errorobjectrequired
- codestringrequired
- messagestringrequired
Error codesinvalid_requestunauthorizednot_permittednot_foundrevision_requiredrevision_mismatchrequest_in_progressbody_too_largeinternaldatabase_busy
Example request
curl -X GET "http://127.0.0.1:32500/v1/items/{itemId}/reading/versions" \
-H "Authorization: Bearer $PORTICO_API_KEY"GET/v1/items/{itemId}/subtitlesRead or change authorized subtitlesread
- Audience
- Clients · Native API
- Authorization
- API key or personal access token with the read scope, or a signed-in session
- OpenAPI operation ID
get_v1_items_itemId_subtitles
Parameters
| Name | In | Type | Description |
|---|---|---|---|
itemIdrequired | path | string | |
segment | query | string |
Responses
200Successapplication/json
Example
{
"canShare": true,
"discovered": [
{
"default": true,
"enabled": true,
"forced": true,
"format": "2026-10-18T19:30:00Z",
"hearingImpaired": true,
"id": "id_8h2k4q",
"language": "en",
"origin": "string",
"reason": "string",
"revision": 0,
"sourceId": "id_8h2k4q",
"title": "Fargo"
}
],
"itemId": "id_8h2k4q",
"provider": {
"enabled": true,
"id": "id_8h2k4q",
"reason": "string",
"resetsAt": "2026-10-18T19:30:00Z",
"retryAt": "2026-10-18T19:30:00Z"
},
"resources": [
{
"attribution": "string",
"canManage": true,
"default": true,
"deliveries": [
{
"companionUrl": "https://example.com/…",
"fontsUrl": "https://example.com/…",
"format": "2026-10-18T19:30:00Z",
"linesUrl": "https://example.com/…",
"url": "https://example.com/…"
}
],
"discoveryId": "id_8h2k4q",
"enabled": true,
"forced": true,
"format": "2026-10-18T19:30:00Z",
"hearingImpaired": true,
"id": "id_8h2k4q",
"language": "en",
"manifestName": "Fargo",
"offsetUs": "string",
"origin": "string",
"pinned": true,
"provider": "string",
"reason": "string",
"renderer": "string",
"retired": true,
"revision": 0,
"rights": "string",
"scope": "string",
"sourceId": "id_8h2k4q",
"title": "Fargo"
}
],
"revision": 0,
"sources": [
{
"available": true,
"durationUs": "string",
"id": "id_8h2k4q",
"inventoryRevision": 0,
"timingKnown": true
}
],
"version": 0
}Schema
- canSharebooleanrequired
discoveredarray of objectrequired
- defaultbooleanrequired
- enabledbooleanrequired
- forcedbooleanrequired
- formatstringrequired
- hearingImpairedbooleanrequired
- idstringrequired
- languagestringrequired
- originstringrequired
- reasonstring
- revisionintegerrequired
- sourceIdstringrequired
- titlestringrequired
- itemIdstringrequired
providerobjectrequired
- enabledbooleanrequired
- idstringrequired
- reasonstring
- resetsAtstring
- retryAtstring
resourcesarray of objectrequired
- attributionstring
- canManagebooleanrequired
- defaultbooleanrequired
deliveriesarray of objectrequired
- companionUrlstring
- fontsUrlstring
- formatstringrequired
- linesUrlstring
- urlstring
- discoveryIdstring
- enabledbooleanrequired
- forcedbooleanrequired
- formatstringrequired
- hearingImpairedbooleanrequired
- idstringrequired
- languagestringrequired
- manifestNamestring
- offsetUsstringrequired
- originstringrequired
- pinnedboolean
- providerstring
- reasonstring
- rendererstringrequired
- retiredboolean
- revisionintegerrequired
- rightsstringrequired
- scopestringrequired
- sourceIdstringrequired
- titlestringrequired
- revisionintegerrequired
sourcesarray of objectrequired
- availablebooleanrequired
- durationUsstringrequired
- idstringrequired
- inventoryRevisionintegerrequired
- timingKnownbooleanrequired
- versionintegerrequired
defaultRequest refused or unavailableapplication/json
Example
{
"error": {
"code": "string",
"message": "string"
}
}Schema
errorobjectrequired
- codestringrequired
- messagestringrequired
Error codesunauthorizednot_permittednot_foundinvalid_requestinternalsubtitle_unavailablesubtitle_not_foundsubtitle_renderer_platform_unsupportedsubtitle_renderer_configurationsubtitle_conflictsubtitle_operation_conflictsubtitle_capacitysubtitle_unsupportedsubtitle_invalid_inputsubtitle_provider_not_configuredsubtitle_provider_key_rejectedsubtitle_provider_sign_in_failedsubtitle_provider_sign_in_requiredsubtitle_provider_quotasubtitle_provider_busydatabase_busy
Example request
curl -X GET "http://127.0.0.1:32500/v1/items/{itemId}/subtitles" \
-H "Authorization: Bearer $PORTICO_API_KEY"POST/v1/items/{itemId}/subtitlesRead or change authorized subtitleslibrary
- Audience
- Clients · Native API
- Authorization
- API key or personal access token with the library scope, or a signed-in session
- OpenAPI operation ID
post_v1_items_itemId_subtitles- Max body
- 768 MiB
Parameters
| Name | In | Type | Description |
|---|---|---|---|
itemIdrequired | path | string | |
segment | query | string |
Request body application/json · required
Example
{
"companion": "string",
"content": "string",
"data": "string",
"default": true,
"expectedRevision": 0,
"forced": true,
"format": "2026-10-18T19:30:00Z",
"language": "en",
"offsetUs": "string",
"operationId": "id_8h2k4q",
"render": "string",
"resourceId": "id_8h2k4q",
"rights": "string",
"scope": "string",
"sourceId": "id_8h2k4q",
"title": "Fargo"
}Schema
- companionstring (byte)
- contentstring
- datastring (byte)
- defaultboolean
- expectedRevisionintegerrequired
- forcedboolean
- formatstringrequired
- languagestringrequired
- offsetUsstringrequired
- operationIdstringrequired
- renderstring
- resourceIdstring
- rightsstringrequired
- scopestringrequired
- sourceIdstringrequired
- titlestringrequired
Responses
200Successapplication/json
Example
{
"catalogRevision": 0,
"deleted": true,
"operationId": "id_8h2k4q",
"resourceId": "id_8h2k4q",
"revision": 0
}Schema
- catalogRevisionintegerrequired
- deletedbooleanrequired
- operationIdstringrequired
- resourceIdstringrequired
- revisionintegerrequired
defaultRequest refused or unavailableapplication/json
Example
{
"error": {
"code": "string",
"message": "string"
}
}Schema
errorobjectrequired
- codestringrequired
- messagestringrequired
Error codesunauthorizednot_permittednot_foundinvalid_requestinternalsubtitle_unavailablesubtitle_not_foundsubtitle_renderer_platform_unsupportedsubtitle_renderer_configurationsubtitle_conflictsubtitle_operation_conflictsubtitle_capacitysubtitle_unsupportedsubtitle_invalid_inputsubtitle_provider_not_configuredsubtitle_provider_key_rejectedsubtitle_provider_sign_in_failedsubtitle_provider_sign_in_requiredsubtitle_provider_quotasubtitle_provider_busydatabase_busywriter_capacity
Example request
curl -X POST "http://127.0.0.1:32500/v1/items/{itemId}/subtitles" \
-H "Authorization: Bearer $PORTICO_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"companion": "string",
"content": "string",
"data": "string",
"default": true,
"expectedRevision": 0,
"forced": true,
"format": "2026-10-18T19:30:00Z",
"language": "en",
"offsetUs": "string",
"operationId": "id_8h2k4q",
"render": "string",
"resourceId": "id_8h2k4q",
"rights": "string",
"scope": "string",
"sourceId": "id_8h2k4q",
"title": "Fargo"
}'DELETE/v1/items/{itemId}/subtitles/{resource}Read or change authorized subtitleslibrary
- Audience
- Clients · Native API
- Authorization
- API key or personal access token with the library scope, or a signed-in session
- OpenAPI operation ID
delete_v1_items_itemId_subtitles_resource- Max body
- 768 MiB
Parameters
| Name | In | Type | Description |
|---|---|---|---|
itemIdrequired | path | string | |
resourcerequired | path | string | |
segment | query | string |
Request body application/json · required
Example
{
"expectedRevision": 0,
"operationId": "id_8h2k4q"
}Schema
- expectedRevisionintegerrequired
- operationIdstringrequired
Responses
200Successapplication/json
Example
{
"catalogRevision": 0,
"deleted": true,
"operationId": "id_8h2k4q",
"resourceId": "id_8h2k4q",
"revision": 0
}Schema
- catalogRevisionintegerrequired
- deletedbooleanrequired
- operationIdstringrequired
- resourceIdstringrequired
- revisionintegerrequired
defaultRequest refused or unavailableapplication/json
Example
{
"error": {
"code": "string",
"message": "string"
}
}Schema
errorobjectrequired
- codestringrequired
- messagestringrequired
Error codesunauthorizednot_permittednot_foundinvalid_requestinternalsubtitle_unavailablesubtitle_not_foundsubtitle_renderer_platform_unsupportedsubtitle_renderer_configurationsubtitle_conflictsubtitle_operation_conflictsubtitle_capacitysubtitle_unsupportedsubtitle_invalid_inputsubtitle_provider_not_configuredsubtitle_provider_key_rejectedsubtitle_provider_sign_in_failedsubtitle_provider_sign_in_requiredsubtitle_provider_quotasubtitle_provider_busydatabase_busywriter_capacity
Example request
curl -X DELETE "http://127.0.0.1:32500/v1/items/{itemId}/subtitles/{resource}" \
-H "Authorization: Bearer $PORTICO_API_KEY" \
-H "Content-Type: application/json" \
-d '{"expectedRevision":0,"operationId":"id_8h2k4q"}'PUT/v1/items/{itemId}/subtitles/{resource}Read or change authorized subtitleslibrary
- Audience
- Clients · Native API
- Authorization
- API key or personal access token with the library scope, or a signed-in session
- OpenAPI operation ID
put_v1_items_itemId_subtitles_resource- Max body
- 768 MiB
Parameters
| Name | In | Type | Description |
|---|---|---|---|
itemIdrequired | path | string | |
resourcerequired | path | string | |
segment | query | string |
Request body application/json · required
Example
{
"companion": "string",
"content": "string",
"data": "string",
"default": true,
"expectedRevision": 0,
"forced": true,
"format": "2026-10-18T19:30:00Z",
"language": "en",
"offsetUs": "string",
"operationId": "id_8h2k4q",
"render": "string",
"resourceId": "id_8h2k4q",
"rights": "string",
"scope": "string",
"sourceId": "id_8h2k4q",
"title": "Fargo"
}Schema
- companionstring (byte)
- contentstring
- datastring (byte)
- defaultboolean
- expectedRevisionintegerrequired
- forcedboolean
- formatstringrequired
- languagestringrequired
- offsetUsstringrequired
- operationIdstringrequired
- renderstring
- resourceIdstring
- rightsstringrequired
- scopestringrequired
- sourceIdstringrequired
- titlestringrequired
Responses
200Successapplication/json
Example
{
"catalogRevision": 0,
"deleted": true,
"operationId": "id_8h2k4q",
"resourceId": "id_8h2k4q",
"revision": 0
}Schema
- catalogRevisionintegerrequired
- deletedbooleanrequired
- operationIdstringrequired
- resourceIdstringrequired
- revisionintegerrequired
defaultRequest refused or unavailableapplication/json
Example
{
"error": {
"code": "string",
"message": "string"
}
}Schema
errorobjectrequired
- codestringrequired
- messagestringrequired
Error codesunauthorizednot_permittednot_foundinvalid_requestinternalsubtitle_unavailablesubtitle_not_foundsubtitle_renderer_platform_unsupportedsubtitle_renderer_configurationsubtitle_conflictsubtitle_operation_conflictsubtitle_capacitysubtitle_unsupportedsubtitle_invalid_inputsubtitle_provider_not_configuredsubtitle_provider_key_rejectedsubtitle_provider_sign_in_failedsubtitle_provider_sign_in_requiredsubtitle_provider_quotasubtitle_provider_busydatabase_busywriter_capacity
Example request
curl -X PUT "http://127.0.0.1:32500/v1/items/{itemId}/subtitles/{resource}" \
-H "Authorization: Bearer $PORTICO_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"companion": "string",
"content": "string",
"data": "string",
"default": true,
"expectedRevision": 0,
"forced": true,
"format": "2026-10-18T19:30:00Z",
"language": "en",
"offsetUs": "string",
"operationId": "id_8h2k4q",
"render": "string",
"resourceId": "id_8h2k4q",
"rights": "string",
"scope": "string",
"sourceId": "id_8h2k4q",
"title": "Fargo"
}'POST/v1/items/{itemId}/subtitles/applyRead or change authorized subtitleslibrary
- Audience
- Clients · Native API
- Authorization
- API key or personal access token with the library scope, or a signed-in session
- OpenAPI operation ID
post_v1_items_itemId_subtitles_apply- Max body
- 768 MiB
Parameters
| Name | In | Type | Description |
|---|---|---|---|
itemIdrequired | path | string | |
segment | query | string |
Request body application/json · required
Example
{
"candidateId": "id_8h2k4q",
"operationId": "id_8h2k4q",
"rights": "string",
"scope": "string"
}Schema
- candidateIdstringrequired
- operationIdstringrequired
- rightsstringrequired
- scopestringrequired
Responses
200Successapplication/json
Example
{
"catalogRevision": 0,
"deleted": true,
"operationId": "id_8h2k4q",
"resourceId": "id_8h2k4q",
"revision": 0
}Schema
- catalogRevisionintegerrequired
- deletedbooleanrequired
- operationIdstringrequired
- resourceIdstringrequired
- revisionintegerrequired
defaultRequest refused or unavailableapplication/json
Example
{
"error": {
"code": "string",
"message": "string"
}
}Schema
errorobjectrequired
- codestringrequired
- messagestringrequired
Error codesunauthorizednot_permittednot_foundinvalid_requestinternalsubtitle_unavailablesubtitle_not_foundsubtitle_renderer_platform_unsupportedsubtitle_renderer_configurationsubtitle_conflictsubtitle_operation_conflictsubtitle_capacitysubtitle_unsupportedsubtitle_invalid_inputsubtitle_provider_not_configuredsubtitle_provider_key_rejectedsubtitle_provider_sign_in_failedsubtitle_provider_sign_in_requiredsubtitle_provider_quotasubtitle_provider_busydatabase_busywriter_capacity
Example request
curl -X POST "http://127.0.0.1:32500/v1/items/{itemId}/subtitles/apply" \
-H "Authorization: Bearer $PORTICO_API_KEY" \
-H "Content-Type: application/json" \
-d '{"candidateId":"id_8h2k4q","operationId":"id_8h2k4q","rights":"string","scope":"string"}'POST/v1/items/{itemId}/subtitles/importRead or change authorized subtitleslibrary
- Audience
- Clients · Native API
- Authorization
- API key or personal access token with the library scope, or a signed-in session
- OpenAPI operation ID
post_v1_items_itemId_subtitles_import- Max body
- 768 MiB
Parameters
| Name | In | Type | Description |
|---|---|---|---|
itemIdrequired | path | string | |
segment | query | string |
Request body application/json · required
Example
{
"discoveryId": "id_8h2k4q",
"expectedRevision": 0,
"operationId": "id_8h2k4q",
"render": "string",
"scope": "string",
"sourceId": "id_8h2k4q"
}Schema
- discoveryIdstringrequired
- expectedRevisionintegerrequired
- operationIdstringrequired
- renderstring
- scopestringrequired
- sourceIdstringrequired
Responses
200Successapplication/json
Example
{
"catalogRevision": 0,
"deleted": true,
"operationId": "id_8h2k4q",
"resourceId": "id_8h2k4q",
"revision": 0
}Schema
- catalogRevisionintegerrequired
- deletedbooleanrequired
- operationIdstringrequired
- resourceIdstringrequired
- revisionintegerrequired
defaultRequest refused or unavailableapplication/json
Example
{
"error": {
"code": "string",
"message": "string"
}
}Schema
errorobjectrequired
- codestringrequired
- messagestringrequired
Error codesunauthorizednot_permittednot_foundinvalid_requestinternalsubtitle_unavailablesubtitle_not_foundsubtitle_renderer_platform_unsupportedsubtitle_renderer_configurationsubtitle_conflictsubtitle_operation_conflictsubtitle_capacitysubtitle_unsupportedsubtitle_invalid_inputsubtitle_provider_not_configuredsubtitle_provider_key_rejectedsubtitle_provider_sign_in_failedsubtitle_provider_sign_in_requiredsubtitle_provider_quotasubtitle_provider_busydatabase_busywriter_capacity
Example request
curl -X POST "http://127.0.0.1:32500/v1/items/{itemId}/subtitles/import" \
-H "Authorization: Bearer $PORTICO_API_KEY" \
-H "Content-Type: application/json" \
-d '{"discoveryId":"id_8h2k4q","expectedRevision":0,"operationId":"id_8h2k4q","render":"string","scope":"string","sourceId":"id_8h2k4q"}'POST/v1/items/{itemId}/subtitles/refreshRead or change authorized subtitleslibrary
- Audience
- Clients · Native API
- Authorization
- API key or personal access token with the library scope, or a signed-in session
- OpenAPI operation ID
post_v1_items_itemId_subtitles_refresh- Max body
- 768 MiB
Parameters
| Name | In | Type | Description |
|---|---|---|---|
itemIdrequired | path | string | |
segment | query | string |
Request body application/json · required
Example
{
"sourceId": "id_8h2k4q"
}Schema
- sourceIdstringrequired
Responses
200Successapplication/json
Example
{
"canShare": true,
"discovered": [
{
"default": true,
"enabled": true,
"forced": true,
"format": "2026-10-18T19:30:00Z",
"hearingImpaired": true,
"id": "id_8h2k4q",
"language": "en",
"origin": "string",
"reason": "string",
"revision": 0,
"sourceId": "id_8h2k4q",
"title": "Fargo"
}
],
"itemId": "id_8h2k4q",
"provider": {
"enabled": true,
"id": "id_8h2k4q",
"reason": "string",
"resetsAt": "2026-10-18T19:30:00Z",
"retryAt": "2026-10-18T19:30:00Z"
},
"resources": [
{
"attribution": "string",
"canManage": true,
"default": true,
"deliveries": [
{
"companionUrl": "https://example.com/…",
"fontsUrl": "https://example.com/…",
"format": "2026-10-18T19:30:00Z",
"linesUrl": "https://example.com/…",
"url": "https://example.com/…"
}
],
"discoveryId": "id_8h2k4q",
"enabled": true,
"forced": true,
"format": "2026-10-18T19:30:00Z",
"hearingImpaired": true,
"id": "id_8h2k4q",
"language": "en",
"manifestName": "Fargo",
"offsetUs": "string",
"origin": "string",
"pinned": true,
"provider": "string",
"reason": "string",
"renderer": "string",
"retired": true,
"revision": 0,
"rights": "string",
"scope": "string",
"sourceId": "id_8h2k4q",
"title": "Fargo"
}
],
"revision": 0,
"sources": [
{
"available": true,
"durationUs": "string",
"id": "id_8h2k4q",
"inventoryRevision": 0,
"timingKnown": true
}
],
"version": 0
}Schema
- canSharebooleanrequired
discoveredarray of objectrequired
- defaultbooleanrequired
- enabledbooleanrequired
- forcedbooleanrequired
- formatstringrequired
- hearingImpairedbooleanrequired
- idstringrequired
- languagestringrequired
- originstringrequired
- reasonstring
- revisionintegerrequired
- sourceIdstringrequired
- titlestringrequired
- itemIdstringrequired
providerobjectrequired
- enabledbooleanrequired
- idstringrequired
- reasonstring
- resetsAtstring
- retryAtstring
resourcesarray of objectrequired
- attributionstring
- canManagebooleanrequired
- defaultbooleanrequired
deliveriesarray of objectrequired
- companionUrlstring
- fontsUrlstring
- formatstringrequired
- linesUrlstring
- urlstring
- discoveryIdstring
- enabledbooleanrequired
- forcedbooleanrequired
- formatstringrequired
- hearingImpairedbooleanrequired
- idstringrequired
- languagestringrequired
- manifestNamestring
- offsetUsstringrequired
- originstringrequired
- pinnedboolean
- providerstring
- reasonstring
- rendererstringrequired
- retiredboolean
- revisionintegerrequired
- rightsstringrequired
- scopestringrequired
- sourceIdstringrequired
- titlestringrequired
- revisionintegerrequired
sourcesarray of objectrequired
- availablebooleanrequired
- durationUsstringrequired
- idstringrequired
- inventoryRevisionintegerrequired
- timingKnownbooleanrequired
- versionintegerrequired
defaultRequest refused or unavailableapplication/json
Example
{
"error": {
"code": "string",
"message": "string"
}
}Schema
errorobjectrequired
- codestringrequired
- messagestringrequired
Error codesunauthorizednot_permittednot_foundinvalid_requestinternalsubtitle_unavailablesubtitle_not_foundsubtitle_renderer_platform_unsupportedsubtitle_renderer_configurationsubtitle_conflictsubtitle_operation_conflictsubtitle_capacitysubtitle_unsupportedsubtitle_invalid_inputsubtitle_provider_not_configuredsubtitle_provider_key_rejectedsubtitle_provider_sign_in_failedsubtitle_provider_sign_in_requiredsubtitle_provider_quotasubtitle_provider_busydatabase_busywriter_capacity
Example request
curl -X POST "http://127.0.0.1:32500/v1/items/{itemId}/subtitles/refresh" \
-H "Authorization: Bearer $PORTICO_API_KEY" \
-H "Content-Type: application/json" \
-d '{"sourceId":"id_8h2k4q"}'POST/v1/items/{itemId}/subtitles/remoteRead or change authorized subtitleslibrary
- Audience
- Clients · Native API
- Authorization
- API key or personal access token with the library scope, or a signed-in session
- OpenAPI operation ID
post_v1_items_itemId_subtitles_remote- Max body
- 768 MiB
Parameters
| Name | In | Type | Description |
|---|---|---|---|
itemIdrequired | path | string | |
segment | query | string |
Request body application/json · required
Example
{
"format": "2026-10-18T19:30:00Z",
"language": "en",
"name": "Fargo",
"operationId": "id_8h2k4q",
"rights": "string",
"scope": "string",
"sourceId": "id_8h2k4q",
"title": "Fargo"
}Schema
- formatstringrequired
- languagestringrequired
- namestringrequired
- operationIdstringrequired
- rightsstringrequired
- scopestringrequired
- sourceIdstringrequired
- titlestringrequired
Responses
200Successapplication/json
Example
{
"catalogRevision": 0,
"deleted": true,
"operationId": "id_8h2k4q",
"resourceId": "id_8h2k4q",
"revision": 0
}Schema
- catalogRevisionintegerrequired
- deletedbooleanrequired
- operationIdstringrequired
- resourceIdstringrequired
- revisionintegerrequired
defaultRequest refused or unavailableapplication/json
Example
{
"error": {
"code": "string",
"message": "string"
}
}Schema
errorobjectrequired
- codestringrequired
- messagestringrequired
Error codesunauthorizednot_permittednot_foundinvalid_requestinternalsubtitle_unavailablesubtitle_not_foundsubtitle_renderer_platform_unsupportedsubtitle_renderer_configurationsubtitle_conflictsubtitle_operation_conflictsubtitle_capacitysubtitle_unsupportedsubtitle_invalid_inputsubtitle_provider_not_configuredsubtitle_provider_key_rejectedsubtitle_provider_sign_in_failedsubtitle_provider_sign_in_requiredsubtitle_provider_quotasubtitle_provider_busydatabase_busywriter_capacity
Example request
curl -X POST "http://127.0.0.1:32500/v1/items/{itemId}/subtitles/remote" \
-H "Authorization: Bearer $PORTICO_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"format": "2026-10-18T19:30:00Z",
"language": "en",
"name": "Fargo",
"operationId": "id_8h2k4q",
"rights": "string",
"scope": "string",
"sourceId": "id_8h2k4q",
"title": "Fargo"
}'POST/v1/items/{itemId}/subtitles/searchRead or change authorized subtitleslibrary
- Audience
- Clients · Native API
- Authorization
- API key or personal access token with the library scope, or a signed-in session
- OpenAPI operation ID
post_v1_items_itemId_subtitles_search- Max body
- 768 MiB
Parameters
| Name | In | Type | Description |
|---|---|---|---|
itemIdrequired | path | string | |
segment | query | string |
Request body application/json · required
Example
{
"language": "en",
"page": 0,
"query": "string",
"sourceId": "id_8h2k4q"
}Schema
- languagestringrequired
- pageintegerrequired
- querystringrequired
- sourceIdstringrequired
Responses
200Successapplication/json
Example
{
"candidates": [
{
"attribution": "string",
"id": "id_8h2k4q",
"language": "en",
"title": "Fargo"
}
],
"expiresAt": "2026-10-18T19:30:00Z",
"page": 0,
"version": 0
}Schema
candidatesarray of objectrequired
- attributionstringrequired
- idstringrequired
- languagestringrequired
- titlestringrequired
- expiresAtstringrequired
- pageintegerrequired
- versionintegerrequired
defaultRequest refused or unavailableapplication/json
Example
{
"error": {
"code": "string",
"message": "string"
}
}Schema
errorobjectrequired
- codestringrequired
- messagestringrequired
Error codesunauthorizednot_permittednot_foundinvalid_requestinternalsubtitle_unavailablesubtitle_not_foundsubtitle_renderer_platform_unsupportedsubtitle_renderer_configurationsubtitle_conflictsubtitle_operation_conflictsubtitle_capacitysubtitle_unsupportedsubtitle_invalid_inputsubtitle_provider_not_configuredsubtitle_provider_key_rejectedsubtitle_provider_sign_in_failedsubtitle_provider_sign_in_requiredsubtitle_provider_quotasubtitle_provider_busydatabase_busywriter_capacity
Example request
curl -X POST "http://127.0.0.1:32500/v1/items/{itemId}/subtitles/search" \
-H "Authorization: Bearer $PORTICO_API_KEY" \
-H "Content-Type: application/json" \
-d '{"language":"en","page":0,"query":"string","sourceId":"id_8h2k4q"}'PUT/v1/items/personal-state:batchRead or update the selected projectionplayback
- Audience
- Clients · Native API
- Authorization
- API key or personal access token with the playback scope, or a signed-in session
- OpenAPI operation ID
put_items_personal_state_batch- Max body
- 1 MiB
Parameters
| Name | In | Type | Description |
|---|---|---|---|
Idempotency-Key | header | string | |
Portico-Mutation-Root | header | string |
Request body application/json · required
Example
{
"items": [
{
"expectedRevision": 0,
"favorite": true,
"itemId": "id_8h2k4q",
"notInterested": true,
"watched": true,
"watchlisted": true
}
],
"operationId": "id_8h2k4q"
}Schema
itemsarray of objectrequired
- expectedRevisioninteger
- favoriteboolean
- itemIdstringrequired
- notInterestedboolean
- watchedboolean
- watchlistedboolean
- operationIdstringrequired
Responses
200Successapplication/json
Example
{
"failed": 0,
"operationId": "id_8h2k4q",
"receiptLifetimeMs": 1800000,
"results": [
{
"code": "string",
"itemId": "id_8h2k4q",
"message": "string",
"ok": true,
"personal": {
"conflicts": [
{}
],
"continueDismissed": true,
"favorite": true,
"lastPlayedAt": "2026-10-18T19:30:00Z",
"notInterested": true,
"progressMs": 1800000,
"rating": 0,
"revision": 0,
"status": "string",
"watched": true,
"watchlisted": true
}
}
],
"serverId": "id_8h2k4q",
"updated": 0,
"viewerFence": "string"
}Schema
- failedintegerrequired
- operationIdstringrequired
- receiptLifetimeMsintegerrequired
resultsarray of objectrequired
- codestring
- itemIdstringrequired
- messagestring
- okbooleanrequired
personalobject
conflictsarray of objectrequired
- baseRevisionintegerrequired
- baseValueanyrequired
choicesarray of objectrequired
- authoredAtstringrequired
- deviceIdstringrequired
- operationIdstringrequired
- valueanyrequired
- fieldstringrequired
- idstringrequired
- continueDismissedboolean
- favoritebooleanrequired
- lastPlayedAtstringrequired
- notInterestedboolean
- progressMsintegerrequired≥ 0
- ratinginteger | any | nullrequired
- revisionintegerrequired
- statusstringrequired
- watchedbooleanrequired
- watchlistedbooleanrequired
- serverIdstringrequired
- updatedintegerrequired
- 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 PUT "http://127.0.0.1:32500/v1/items/personal-state:batch" \
-H "Authorization: Bearer $PORTICO_API_KEY" \
-H "Content-Type: application/json" \
-d '{"items":[{"expectedRevision":0,"favorite":true,"itemId":"id_8h2k4q","notInterested":true,"watched":true,"watchlisted":true}],"operationId":"id_8h2k4q"}'No operations match that filter.