Queues
Generated queues operations.
POST/v1/queuesPlay: replace this device's queue from selectors, optionally starting the first sessionplayback
- Audience
- Clients · Native API
- Authorization
- API key or personal access token with the playback scope, or a signed-in session
- OpenAPI operation ID
create_queue- Max body
- 64 KiB
Request body application/json · required
Example
{
"owner": "string",
"repeat": "2026-10-18T19:30:00Z",
"retainQueueIds": [
"string"
],
"segments": [
{
"anchor": null,
"order": {
"mode": "string",
"seed": "string"
},
"source": {
"container": {
"id": "id_8h2k4q",
"kind": "string"
}
}
}
],
"selector": {
"container": {
"id": "id_8h2k4q",
"kind": "string"
}
},
"shuffle": {
"seed": "string"
},
"startPlayback": {
"quality": {
"id": "id_8h2k4q",
"maxAudioBitrateKbps": 0,
"maxHeight": 0,
"maxVideoBitrateKbps": 0,
"mode": "string",
"step": "string"
},
"state": "string"
}
}Schema
- ownerstring
- repeatstring
- retainQueueIdsarray of string
segmentsarray of object
- anchorany
orderobject
- modestringrequired
- seedstring
sourceobjectrequired
containerobjectrequired
- idstringrequired
- kindstringrequired
selectorobject
containerobjectrequired
- idstringrequired
- kindstringrequired
shuffleobject
- seedstring
startPlaybackobject
qualityobject
- idstring
- maxAudioBitrateKbpsinteger
- maxHeightinteger
- maxVideoBitrateKbpsinteger
- modestringrequired
- stepstring
- statestring
Responses
201Successapplication/json
Example
{
"queue": {
"current": {
"entryId": "id_8h2k4q",
"position": 0
},
"durationKnown": true,
"id": "id_8h2k4q",
"next": {
"available": true,
"entryId": "id_8h2k4q",
"reason": "string"
},
"postPlay": {
"automaticAdvances": 0,
"autoplay": true,
"countdownMs": 1800000,
"passoutCheckDue": true,
"startDuringCredits": true
},
"remainingCount": 0,
"repeat": "2026-10-18T19:30:00Z",
"revision": "r12",
"segmentCount": 0,
"segments": [
{
"count": 0,
"id": "id_8h2k4q",
"kind": "string",
"label": "string",
"sourceRevision": "r12",
"state": "string"
}
],
"shuffle": {
"lap": 0,
"seed": "string"
},
"total": 0,
"totalDurationMs": 1800000
},
"session": {
"channelId": "id_8h2k4q",
"control": {
"revision": "r12",
"state": "string"
},
"discTitle": {
"id": "id_8h2k4q",
"revision": "r12"
},
"end": {
"message": "string",
"reason": "string"
},
"id": "id_8h2k4q",
"itemId": "id_8h2k4q",
"kind": "string",
"lease": {
"expiresAt": "2026-10-18T19:30:00Z",
"reportEveryMs": 1800000
},
"observedPlayback": {
"audio": {
"bitDepth": 0,
"channels": 0,
"codec": "string",
"handling": "string",
"layout": "string",
"objectAudio": "string",
"sampleRate": 0
},
"deliveredBitrateKbps": 0,
"screen": {
"dynamicRange": "string",
"refreshRateHz": 0
},
"subtitles": {
"rendering": "string"
},
"video": {
"bitDepth": 0,
"dynamicRange": "string",
"frameRateHz": 0,
"height": 0,
"width": 0
}
},
"playbackInfo": {
"basis": "committed_delivery_plan",
"delivered": {
"audio": {
"bitDepth": 0,
"channels": 0,
"codec": "string",
"delivery": "string",
"layout": "string",
"lossless": true,
"objectAudio": "string",
"profile": "string",
"sampleRate": 0,
"variant": "string"
},
"subtitles": {
"format": "2026-10-18T19:30:00Z",
"language": "en",
"origin": "string",
"rendering": "string",
"title": "Fargo"
},
"video": {
"bitDepth": 0,
"chromaSubsampling": "string",
"codec": "string",
"container": "string",
"conversion": {},
"dolbyVisionBaseLayer": true,
"dolbyVisionCmVersion": "string",
"dolbyVisionCompatibility": 0,
"dolbyVisionEnhancementType": "string",
"dolbyVisionProfile": 0,
"dolbyVisionRpu": true,
"dynamicRange": "string",
"frameRate": 0,
"frameRateDenominator": 0,
"frameRateMode": "string",
"frameRateNumerator": 0,
"hdr10Plus": true,
"height": 0,
"interlaced": true,
"masterDisplay": "string",
"maxCll": "string",
"profile": "string",
"width": 0
}
},
"estimatedBitrateKbps": 0,
"losses": [
{
"feature": "string",
"replacement": {}
}
],
"network": "string",
"reason": {
"audioCodec": "string",
"container": "string",
"kind": "string",
"maxBitrateKbps": 0,
"maxHeight": 0,
"videoCodec": "string"
},
"route": "string",
"routes": {
"picture": "string",
"sound": "string",
"subtitles": "Fargo"
},
"source": {
"audio": {
"bitDepth": 0,
"channels": 0,
"codec": "string",
"delivery": "string",
"layout": "string",
"lossless": true,
"objectAudio": "string",
"profile": "string",
"sampleRate": 0,
"variant": "string"
},
"subtitles": {
"format": "2026-10-18T19:30:00Z",
"language": "en",
"origin": "string",
"rendering": "string",
"title": "Fargo"
},
"video": {
"bitDepth": 0,
"chromaSubsampling": "string",
"codec": "string",
"container": "string",
"conversion": {},
"dolbyVisionBaseLayer": true,
"dolbyVisionCmVersion": "string",
"dolbyVisionCompatibility": 0,
"dolbyVisionEnhancementType": "string",
"dolbyVisionProfile": 0,
"dolbyVisionRpu": true,
"dynamicRange": "string",
"frameRate": 0,
"frameRateDenominator": 0,
"frameRateMode": "string",
"frameRateNumerator": 0,
"hdr10Plus": true,
"height": 0,
"interlaced": true,
"masterDisplay": "string",
"maxCll": "string",
"profile": "string",
"width": 0
}
}
},
"presentation": {
"audioRender": {
"bitDepth": 0,
"bytes": 0,
"channels": 0,
"codec": "string",
"container": "string",
"conversionGainDb": 0,
"decoderConfig": "string",
"downmixed": true,
"durationFrames": 0,
"gain": {
"albumDb": 0,
"albumPeak": 0,
"source": "string",
"trackDb": 0,
"trackPeak": 0
},
"id": "id_8h2k4q",
"loudnessAppliedDb": 0,
"loudnessEnvelope": {
"endLufs": [],
"intervalMs": 1800000,
"startLufs": []
},
"mode": "string",
"prefetchBytes": 0,
"reason": "string",
"sampleRate": 0,
"seekIndex": {
"url": "https://example.com/…"
},
"sourceBitrateBps": 0,
"trim": {
"endFrames": 0,
"source": "string",
"startFrames": 0
},
"url": "https://example.com/…",
"version": 0
},
"audioTrackId": "id_8h2k4q",
"bitrateKbps": 0,
"choiceRevision": 0,
"container": "string",
"decision": {
"audio": {
"action": "string",
"channels": 0,
"reasons": [],
"to": "string"
},
"subtitles": {
"action": "string",
"channels": 0,
"reasons": [],
"to": "string"
},
"video": {
"action": "string",
"channels": 0,
"reasons": [],
"to": "string"
}
},
"engine": "string",
"generation": 0,
"linear": {
"clocks": [
{}
],
"confirmedPositionMs": 1800000,
"errorCode": "string",
"liveEdgeMs": 1800000,
"name": "Fargo",
"next": {
"endMs": 1800000,
"id": "id_8h2k4q",
"itemId": "id_8h2k4q",
"startMs": 1800000,
"title": "Fargo"
},
"nowMs": 1800000,
"originMs": 1800000,
"programme": {
"endMs": 1800000,
"id": "id_8h2k4q",
"itemId": "id_8h2k4q",
"startMs": 1800000,
"title": "Fargo"
},
"reservationRequiredAtMs": 1800000,
"seek": {
"acknowledged": true,
"error": "string",
"id": "id_8h2k4q",
"live": true,
"positionMs": 1800000
},
"state": "string",
"windowEndMs": 1800000,
"windowStartMs": 1800000
},
"mode": "string",
"quality": {
"id": "id_8h2k4q",
"maxAudioBitrateKbps": 0,
"maxHeight": 0,
"maxVideoBitrateKbps": 0,
"mode": "string",
"step": "string"
},
"seekId": "id_8h2k4q",
"startPositionMs": 1800000,
"subtitle": {
"delivery": "string",
"kind": "string",
"trackId": "id_8h2k4q"
},
"subtitles": [
{
"companionUrl": "https://example.com/…",
"fontsUrl": "https://example.com/…",
"format": "2026-10-18T19:30:00Z",
"linesUrl": "https://example.com/…",
"offsetMs": 1800000,
"timeDomain": "2026-10-18T19:30:00Z",
"trackId": "id_8h2k4q",
"url": "https://example.com/…"
}
],
"url": "https://example.com/…",
"videoHeight": 0
},
"queue": {
"entryId": "id_8h2k4q",
"queueId": "id_8h2k4q"
},
"retryAfterMs": 1800000,
"revision": "r12",
"role": "string",
"state": "string",
"versionId": "id_8h2k4q"
},
"window": [
{
"album": "string",
"albumId": "id_8h2k4q",
"artist": "string",
"artistId": "id_8h2k4q",
"available": true,
"backdropUrl": "https://example.com/…",
"disc": 0,
"durationMs": 1800000,
"entryId": "id_8h2k4q",
"episode": {
"number": 0,
"seasonNumber": 0
},
"itemId": "id_8h2k4q",
"kind": "string",
"libraryId": "id_8h2k4q",
"position": 0,
"posterUrl": "https://example.com/…",
"seasonId": "id_8h2k4q",
"segmentId": "id_8h2k4q",
"showId": "id_8h2k4q",
"stillUrl": "https://example.com/…",
"title": "Fargo",
"track": 0
}
]
}Schema
queueobjectrequired
currentobject
- entryIdstringrequired
- positionintegerrequired
- durationKnownbooleanrequired
- idstringrequired
nextobject
- availablebooleanrequired
- entryIdstring
- reasonstringrequired
postPlayobject
- automaticAdvancesintegerrequired
- autoplaybooleanrequired
- countdownMsintegerrequired
- passoutCheckDuebooleanrequired
- startDuringCreditsbooleanrequired
- remainingCountintegerrequired
- repeatstringrequired
- revisionstringrequired
- segmentCountintegerrequired
segmentsarray of objectrequired
- countintegerrequired
- idstringrequired
- kindstringrequired
- labelstringrequired
- sourceRevisionstring
- statestringrequired
shuffleobject
- lapintegerrequired
- seedstringrequired
- totalintegerrequired
- totalDurationMsinteger
sessionobject
- channelIdstring
controlobject
- revisionstringrequired
- statestringrequired
discTitleobject
- idstringrequired
- revisionstringrequired
endobject
- messagestring
- reasonstringrequired
- idstringrequired
- itemIdstring
- kindstringrequired
leaseobjectrequired
- expiresAtstringrequired
- reportEveryMsintegerrequired
observedPlaybackobject
audioobject
- bitDepthinteger
- channelsinteger
- codecstring
- handlingstring
- layoutstring
- objectAudiostring
- sampleRateinteger
- deliveredBitrateKbpsinteger
screenobject
- dynamicRangestring
- refreshRateHznumber
subtitlesobject
- renderingstringrequired
videoobject
- bitDepthinteger
- dynamicRangestring
- frameRateHznumber
- heightinteger
- widthinteger
playbackInfoobject
- basisstringrequiredone of "committed_delivery_plan"
deliveredobjectrequired
audioobject
- bitDepthinteger
- channelsinteger
- codecstringrequired
- deliverystring
- layoutstring
- losslessboolean
- objectAudiostring
- profilestring
- sampleRateinteger
- variantstring
subtitlesobject
- formatstring
- languagestring
- originstring
- renderingstring
- titlestring
videoobject
- bitDepthinteger
- chromaSubsamplingstring
- codecstringrequired
- containerstring
conversionobject
- enhancementDiscardedbooleanrequired
- felResidualDiscardedbooleanrequired
- kindstringrequired
- sourceDolbyVisionProfileintegerrequired
- sourceEnhancementTypestring
- dolbyVisionBaseLayerboolean
- dolbyVisionCmVersionstring
- dolbyVisionCompatibilityinteger
- dolbyVisionEnhancementTypestring
- dolbyVisionProfileinteger
- dolbyVisionRpuboolean
- dynamicRangestring
- frameRatenumber
- frameRateDenominatorinteger
- frameRateModestring
- frameRateNumeratorinteger
- hdr10Plusboolean
- heightinteger
- interlacedboolean
- masterDisplaystring
- maxCllstring
- profilestring
- widthinteger
- estimatedBitrateKbpsinteger
lossesarray of objectrequired
- featurestringrequired
replacementobjectrequired
- audioCodecstring
- channelsinteger
- dynamicRangestring
- layoutstring
- networkstringrequired
reasonobjectrequired
- audioCodecstring
- containerstring
- kindstringrequired
- maxBitrateKbpsinteger
- maxHeightinteger
- videoCodecstring
- routestringrequired
routesobjectrequired
- picturestring
- soundstring
- subtitlesstring
sourceobjectrequired
audioobject
- bitDepthinteger
- channelsinteger
- codecstringrequired
- deliverystring
- layoutstring
- losslessboolean
- objectAudiostring
- profilestring
- sampleRateinteger
- variantstring
subtitlesobject
- formatstring
- languagestring
- originstring
- renderingstring
- titlestring
videoobject
- bitDepthinteger
- chromaSubsamplingstring
- codecstringrequired
- containerstring
conversionobject
- enhancementDiscardedbooleanrequired
- felResidualDiscardedbooleanrequired
- kindstringrequired
- sourceDolbyVisionProfileintegerrequired
- sourceEnhancementTypestring
- dolbyVisionBaseLayerboolean
- dolbyVisionCmVersionstring
- dolbyVisionCompatibilityinteger
- dolbyVisionEnhancementTypestring
- dolbyVisionProfileinteger
- dolbyVisionRpuboolean
- dynamicRangestring
- frameRatenumber
- frameRateDenominatorinteger
- frameRateModestring
- frameRateNumeratorinteger
- hdr10Plusboolean
- heightinteger
- interlacedboolean
- masterDisplaystring
- maxCllstring
- profilestring
- widthinteger
presentationobjectrequired
audioRenderobject
- bitDepthinteger
- bytesinteger
- channelsinteger
- codecstring
- containerstring
- conversionGainDbnumber
- decoderConfigstring
- downmixedboolean
- durationFramesinteger
gainobject
- albumDbnumber
- albumPeaknumber
- sourcestringrequired
- trackDbnumber
- trackPeaknumber
- idstringrequired
- loudnessAppliedDbnumber
loudnessEnvelopeobject
- endLufsarray of numberrequired
- intervalMsintegerrequired
- startLufsarray of numberrequired
- modestringrequired
- prefetchBytesinteger
- reasonstring
- sampleRateinteger
seekIndexobject
- urlstringrequired
- sourceBitrateBpsinteger
trimobject
- endFramesintegerrequired
- sourcestringrequired
- startFramesintegerrequired
- urlstring
- versionintegerrequired
- audioTrackIdstring
- bitrateKbpsinteger
- choiceRevisioninteger
- containerstring
decisionobjectrequired
audioobject
- actionstringrequired
- channelsinteger
- reasonsarray of stringrequired
- tostring
subtitlesobject
- actionstringrequired
- channelsinteger
- reasonsarray of stringrequired
- tostring
videoobject
- actionstringrequired
- channelsinteger
- reasonsarray of stringrequired
- tostring
- enginestringrequired
- generationintegerrequired
linearobject
clocksarray of object
- endMsintegerrequired
- offsetMsintegerrequired
- startMsintegerrequired
- confirmedPositionMsinteger
- errorCodestring
- liveEdgeMsintegerrequired
- namestringrequired
nextobject
- endMsintegerrequired
- idstringrequired
- itemIdstring
- startMsintegerrequired
- titlestringrequired
- nowMsinteger
- originMsintegerrequired
programmeobject
- endMsintegerrequired
- idstringrequired
- itemIdstring
- startMsintegerrequired
- titlestringrequired
- reservationRequiredAtMsinteger
seekobject
- acknowledgedbooleanrequired
- errorstring
- idstringrequired
- liveboolean
- positionMsinteger
- statestringrequired
- windowEndMsintegerrequired
- windowStartMsintegerrequired
- modestringrequired
qualityobject
- idstring
- maxAudioBitrateKbpsinteger
- maxHeightinteger
- maxVideoBitrateKbpsinteger
- modestringrequired
- stepstring
- seekIdstring
- startPositionMsintegerrequired
subtitleobject
- deliverystringrequired
- kindstringrequired
- trackIdstringrequired
subtitlesarray of objectrequired
- companionUrlstring
- fontsUrlstring
- formatstringrequired
- linesUrlstring
- offsetMsintegerrequired
- timeDomainstringrequired
- trackIdstringrequired
- urlstringrequired
- urlstringrequired
- videoHeightinteger
queueobject
- entryIdstringrequired
- queueIdstringrequired
- retryAfterMsinteger
- revisionstringrequired
- rolestringrequired
- statestringrequired
- versionIdstring
windowarray of object
- albumstring
- albumIdstring
- artiststring
- artistIdstring
- availablebooleanrequired
- backdropUrlstring
- discinteger
- durationMsinteger
- entryIdstringrequired
episodeobject
- numberintegerrequired
- seasonNumberintegerrequired
- itemIdstringrequired
- kindstringrequired
- libraryIdstring
- positionintegerrequired
- posterUrlstring
- seasonIdstring
- segmentIdstringrequired
- showIdstring
- stillUrlstring
- titlestringrequired
- trackinteger
defaultRequest refused or unavailableapplication/json
Example
{
"error": {
"code": "string",
"message": "string"
}
}Schema
errorobjectrequired
- codestringrequired
- messagestringrequired
Error codesinvalid_requestunauthorizednot_foundrevision_requiredrevision_mismatchunsupported_selectorqueue_too_largequeue_buildingidempotency_key_requiredidempotency_key_reusedstream_limit_reachedconversion_capacitytranscode_not_allowedunsupported_mediasource_unavailablestorage_offlinetimeoutdatabase_busywriter_capacity
Example request
curl -X POST "http://127.0.0.1:32500/v1/queues" \
-H "Authorization: Bearer $PORTICO_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"owner": "string",
"repeat": "2026-10-18T19:30:00Z",
"retainQueueIds": [
"string"
],
"segments": [
{
"anchor": null,
"order": {
"mode": "string",
"seed": "string"
},
"source": {
"container": {
"id": "id_8h2k4q",
"kind": "string"
}
}
}
],
"selector": {
"container": {
"id": "id_8h2k4q",
"kind": "string"
}
},
"shuffle": {
"seed": "string"
},
"startPlayback": {
"quality": {
"id": "id_8h2k4q",
"maxAudioBitrateKbps": 0,
"maxHeight": 0,
"maxVideoBitrateKbps": 0,
"mode": "string",
"step": "string"
},
"state": "string"
}
}'DELETE/v1/queues/{id}Clear the queue; idempotentplayback
- Audience
- Clients · Native API
- Authorization
- API key or personal access token with the playback scope, or a signed-in session
- OpenAPI operation ID
delete_queue
Parameters
| Name | In | Type | Description |
|---|---|---|---|
idrequired | path | string |
Responses
204Success
defaultRequest refused or unavailableapplication/json
Example
{
"error": {
"code": "string",
"message": "string"
}
}Schema
errorobjectrequired
- codestringrequired
- messagestringrequired
Error codesunauthorizednot_foundtimeoutdatabase_busywriter_capacity
Example request
curl -X DELETE "http://127.0.0.1:32500/v1/queues/{id}" \
-H "Authorization: Bearer $PORTICO_API_KEY"GET/v1/queues/{id}Read a queue's headerread
- Audience
- Clients · Native API
- Authorization
- API key or personal access token with the read scope, or a signed-in session
- OpenAPI operation ID
get_queue
Parameters
| Name | In | Type | Description |
|---|---|---|---|
idrequired | path | string |
Responses
200Successapplication/json
Example
{
"current": {
"entryId": "id_8h2k4q",
"position": 0
},
"durationKnown": true,
"id": "id_8h2k4q",
"next": {
"available": true,
"entryId": "id_8h2k4q",
"reason": "string"
},
"postPlay": {
"automaticAdvances": 0,
"autoplay": true,
"countdownMs": 1800000,
"passoutCheckDue": true,
"startDuringCredits": true
},
"remainingCount": 0,
"repeat": "2026-10-18T19:30:00Z",
"revision": "r12",
"segmentCount": 0,
"segments": [
{
"count": 0,
"id": "id_8h2k4q",
"kind": "string",
"label": "string",
"sourceRevision": "r12",
"state": "string"
}
],
"shuffle": {
"lap": 0,
"seed": "string"
},
"total": 0,
"totalDurationMs": 1800000
}Schema
currentobject
- entryIdstringrequired
- positionintegerrequired
- durationKnownbooleanrequired
- idstringrequired
nextobject
- availablebooleanrequired
- entryIdstring
- reasonstringrequired
postPlayobject
- automaticAdvancesintegerrequired
- autoplaybooleanrequired
- countdownMsintegerrequired
- passoutCheckDuebooleanrequired
- startDuringCreditsbooleanrequired
- remainingCountintegerrequired
- repeatstringrequired
- revisionstringrequired
- segmentCountintegerrequired
segmentsarray of objectrequired
- countintegerrequired
- idstringrequired
- kindstringrequired
- labelstringrequired
- sourceRevisionstring
- statestringrequired
shuffleobject
- lapintegerrequired
- seedstringrequired
- totalintegerrequired
- totalDurationMsinteger
defaultRequest refused or unavailableapplication/json
Example
{
"error": {
"code": "string",
"message": "string"
}
}Schema
errorobjectrequired
- codestringrequired
- messagestringrequired
Error codesunauthorizednot_foundrevision_mismatchtimeoutdatabase_busy
Example request
curl -X GET "http://127.0.0.1:32500/v1/queues/{id}" \
-H "Authorization: Bearer $PORTICO_API_KEY"PATCH/v1/queues/{id}Set repeat, or shuffle on or offplayback
- Audience
- Clients · Native API
- Authorization
- API key or personal access token with the playback scope, or a signed-in session
- OpenAPI operation ID
update_queue- Max body
- 1 KiB
Parameters
| Name | In | Type | Description |
|---|---|---|---|
idrequired | path | string |
Request body application/json · required
Example
{
"repeat": "2026-10-18T19:30:00Z",
"shuffle": {
"on": true,
"seed": "string"
}
}Schema
- repeatstring
shuffleobject
- onbooleanrequired
- seedstring
Responses
200Successapplication/json
Example
{
"queue": {
"current": {
"entryId": "id_8h2k4q",
"position": 0
},
"durationKnown": true,
"id": "id_8h2k4q",
"next": {
"available": true,
"entryId": "id_8h2k4q",
"reason": "string"
},
"postPlay": {
"automaticAdvances": 0,
"autoplay": true,
"countdownMs": 1800000,
"passoutCheckDue": true,
"startDuringCredits": true
},
"remainingCount": 0,
"repeat": "2026-10-18T19:30:00Z",
"revision": "r12",
"segmentCount": 0,
"segments": [
{
"count": 0,
"id": "id_8h2k4q",
"kind": "string",
"label": "string",
"sourceRevision": "r12",
"state": "string"
}
],
"shuffle": {
"lap": 0,
"seed": "string"
},
"total": 0,
"totalDurationMs": 1800000
},
"session": {
"channelId": "id_8h2k4q",
"control": {
"revision": "r12",
"state": "string"
},
"discTitle": {
"id": "id_8h2k4q",
"revision": "r12"
},
"end": {
"message": "string",
"reason": "string"
},
"id": "id_8h2k4q",
"itemId": "id_8h2k4q",
"kind": "string",
"lease": {
"expiresAt": "2026-10-18T19:30:00Z",
"reportEveryMs": 1800000
},
"observedPlayback": {
"audio": {
"bitDepth": 0,
"channels": 0,
"codec": "string",
"handling": "string",
"layout": "string",
"objectAudio": "string",
"sampleRate": 0
},
"deliveredBitrateKbps": 0,
"screen": {
"dynamicRange": "string",
"refreshRateHz": 0
},
"subtitles": {
"rendering": "string"
},
"video": {
"bitDepth": 0,
"dynamicRange": "string",
"frameRateHz": 0,
"height": 0,
"width": 0
}
},
"playbackInfo": {
"basis": "committed_delivery_plan",
"delivered": {
"audio": {
"bitDepth": 0,
"channels": 0,
"codec": "string",
"delivery": "string",
"layout": "string",
"lossless": true,
"objectAudio": "string",
"profile": "string",
"sampleRate": 0,
"variant": "string"
},
"subtitles": {
"format": "2026-10-18T19:30:00Z",
"language": "en",
"origin": "string",
"rendering": "string",
"title": "Fargo"
},
"video": {
"bitDepth": 0,
"chromaSubsampling": "string",
"codec": "string",
"container": "string",
"conversion": {},
"dolbyVisionBaseLayer": true,
"dolbyVisionCmVersion": "string",
"dolbyVisionCompatibility": 0,
"dolbyVisionEnhancementType": "string",
"dolbyVisionProfile": 0,
"dolbyVisionRpu": true,
"dynamicRange": "string",
"frameRate": 0,
"frameRateDenominator": 0,
"frameRateMode": "string",
"frameRateNumerator": 0,
"hdr10Plus": true,
"height": 0,
"interlaced": true,
"masterDisplay": "string",
"maxCll": "string",
"profile": "string",
"width": 0
}
},
"estimatedBitrateKbps": 0,
"losses": [
{
"feature": "string",
"replacement": {}
}
],
"network": "string",
"reason": {
"audioCodec": "string",
"container": "string",
"kind": "string",
"maxBitrateKbps": 0,
"maxHeight": 0,
"videoCodec": "string"
},
"route": "string",
"routes": {
"picture": "string",
"sound": "string",
"subtitles": "Fargo"
},
"source": {
"audio": {
"bitDepth": 0,
"channels": 0,
"codec": "string",
"delivery": "string",
"layout": "string",
"lossless": true,
"objectAudio": "string",
"profile": "string",
"sampleRate": 0,
"variant": "string"
},
"subtitles": {
"format": "2026-10-18T19:30:00Z",
"language": "en",
"origin": "string",
"rendering": "string",
"title": "Fargo"
},
"video": {
"bitDepth": 0,
"chromaSubsampling": "string",
"codec": "string",
"container": "string",
"conversion": {},
"dolbyVisionBaseLayer": true,
"dolbyVisionCmVersion": "string",
"dolbyVisionCompatibility": 0,
"dolbyVisionEnhancementType": "string",
"dolbyVisionProfile": 0,
"dolbyVisionRpu": true,
"dynamicRange": "string",
"frameRate": 0,
"frameRateDenominator": 0,
"frameRateMode": "string",
"frameRateNumerator": 0,
"hdr10Plus": true,
"height": 0,
"interlaced": true,
"masterDisplay": "string",
"maxCll": "string",
"profile": "string",
"width": 0
}
}
},
"presentation": {
"audioRender": {
"bitDepth": 0,
"bytes": 0,
"channels": 0,
"codec": "string",
"container": "string",
"conversionGainDb": 0,
"decoderConfig": "string",
"downmixed": true,
"durationFrames": 0,
"gain": {
"albumDb": 0,
"albumPeak": 0,
"source": "string",
"trackDb": 0,
"trackPeak": 0
},
"id": "id_8h2k4q",
"loudnessAppliedDb": 0,
"loudnessEnvelope": {
"endLufs": [],
"intervalMs": 1800000,
"startLufs": []
},
"mode": "string",
"prefetchBytes": 0,
"reason": "string",
"sampleRate": 0,
"seekIndex": {
"url": "https://example.com/…"
},
"sourceBitrateBps": 0,
"trim": {
"endFrames": 0,
"source": "string",
"startFrames": 0
},
"url": "https://example.com/…",
"version": 0
},
"audioTrackId": "id_8h2k4q",
"bitrateKbps": 0,
"choiceRevision": 0,
"container": "string",
"decision": {
"audio": {
"action": "string",
"channels": 0,
"reasons": [],
"to": "string"
},
"subtitles": {
"action": "string",
"channels": 0,
"reasons": [],
"to": "string"
},
"video": {
"action": "string",
"channels": 0,
"reasons": [],
"to": "string"
}
},
"engine": "string",
"generation": 0,
"linear": {
"clocks": [
{}
],
"confirmedPositionMs": 1800000,
"errorCode": "string",
"liveEdgeMs": 1800000,
"name": "Fargo",
"next": {
"endMs": 1800000,
"id": "id_8h2k4q",
"itemId": "id_8h2k4q",
"startMs": 1800000,
"title": "Fargo"
},
"nowMs": 1800000,
"originMs": 1800000,
"programme": {
"endMs": 1800000,
"id": "id_8h2k4q",
"itemId": "id_8h2k4q",
"startMs": 1800000,
"title": "Fargo"
},
"reservationRequiredAtMs": 1800000,
"seek": {
"acknowledged": true,
"error": "string",
"id": "id_8h2k4q",
"live": true,
"positionMs": 1800000
},
"state": "string",
"windowEndMs": 1800000,
"windowStartMs": 1800000
},
"mode": "string",
"quality": {
"id": "id_8h2k4q",
"maxAudioBitrateKbps": 0,
"maxHeight": 0,
"maxVideoBitrateKbps": 0,
"mode": "string",
"step": "string"
},
"seekId": "id_8h2k4q",
"startPositionMs": 1800000,
"subtitle": {
"delivery": "string",
"kind": "string",
"trackId": "id_8h2k4q"
},
"subtitles": [
{
"companionUrl": "https://example.com/…",
"fontsUrl": "https://example.com/…",
"format": "2026-10-18T19:30:00Z",
"linesUrl": "https://example.com/…",
"offsetMs": 1800000,
"timeDomain": "2026-10-18T19:30:00Z",
"trackId": "id_8h2k4q",
"url": "https://example.com/…"
}
],
"url": "https://example.com/…",
"videoHeight": 0
},
"queue": {
"entryId": "id_8h2k4q",
"queueId": "id_8h2k4q"
},
"retryAfterMs": 1800000,
"revision": "r12",
"role": "string",
"state": "string",
"versionId": "id_8h2k4q"
},
"window": [
{
"album": "string",
"albumId": "id_8h2k4q",
"artist": "string",
"artistId": "id_8h2k4q",
"available": true,
"backdropUrl": "https://example.com/…",
"disc": 0,
"durationMs": 1800000,
"entryId": "id_8h2k4q",
"episode": {
"number": 0,
"seasonNumber": 0
},
"itemId": "id_8h2k4q",
"kind": "string",
"libraryId": "id_8h2k4q",
"position": 0,
"posterUrl": "https://example.com/…",
"seasonId": "id_8h2k4q",
"segmentId": "id_8h2k4q",
"showId": "id_8h2k4q",
"stillUrl": "https://example.com/…",
"title": "Fargo",
"track": 0
}
]
}Schema
queueobjectrequired
currentobject
- entryIdstringrequired
- positionintegerrequired
- durationKnownbooleanrequired
- idstringrequired
nextobject
- availablebooleanrequired
- entryIdstring
- reasonstringrequired
postPlayobject
- automaticAdvancesintegerrequired
- autoplaybooleanrequired
- countdownMsintegerrequired
- passoutCheckDuebooleanrequired
- startDuringCreditsbooleanrequired
- remainingCountintegerrequired
- repeatstringrequired
- revisionstringrequired
- segmentCountintegerrequired
segmentsarray of objectrequired
- countintegerrequired
- idstringrequired
- kindstringrequired
- labelstringrequired
- sourceRevisionstring
- statestringrequired
shuffleobject
- lapintegerrequired
- seedstringrequired
- totalintegerrequired
- totalDurationMsinteger
sessionobject
- channelIdstring
controlobject
- revisionstringrequired
- statestringrequired
discTitleobject
- idstringrequired
- revisionstringrequired
endobject
- messagestring
- reasonstringrequired
- idstringrequired
- itemIdstring
- kindstringrequired
leaseobjectrequired
- expiresAtstringrequired
- reportEveryMsintegerrequired
observedPlaybackobject
audioobject
- bitDepthinteger
- channelsinteger
- codecstring
- handlingstring
- layoutstring
- objectAudiostring
- sampleRateinteger
- deliveredBitrateKbpsinteger
screenobject
- dynamicRangestring
- refreshRateHznumber
subtitlesobject
- renderingstringrequired
videoobject
- bitDepthinteger
- dynamicRangestring
- frameRateHznumber
- heightinteger
- widthinteger
playbackInfoobject
- basisstringrequiredone of "committed_delivery_plan"
deliveredobjectrequired
audioobject
- bitDepthinteger
- channelsinteger
- codecstringrequired
- deliverystring
- layoutstring
- losslessboolean
- objectAudiostring
- profilestring
- sampleRateinteger
- variantstring
subtitlesobject
- formatstring
- languagestring
- originstring
- renderingstring
- titlestring
videoobject
- bitDepthinteger
- chromaSubsamplingstring
- codecstringrequired
- containerstring
conversionobject
- enhancementDiscardedbooleanrequired
- felResidualDiscardedbooleanrequired
- kindstringrequired
- sourceDolbyVisionProfileintegerrequired
- sourceEnhancementTypestring
- dolbyVisionBaseLayerboolean
- dolbyVisionCmVersionstring
- dolbyVisionCompatibilityinteger
- dolbyVisionEnhancementTypestring
- dolbyVisionProfileinteger
- dolbyVisionRpuboolean
- dynamicRangestring
- frameRatenumber
- frameRateDenominatorinteger
- frameRateModestring
- frameRateNumeratorinteger
- hdr10Plusboolean
- heightinteger
- interlacedboolean
- masterDisplaystring
- maxCllstring
- profilestring
- widthinteger
- estimatedBitrateKbpsinteger
lossesarray of objectrequired
- featurestringrequired
replacementobjectrequired
- audioCodecstring
- channelsinteger
- dynamicRangestring
- layoutstring
- networkstringrequired
reasonobjectrequired
- audioCodecstring
- containerstring
- kindstringrequired
- maxBitrateKbpsinteger
- maxHeightinteger
- videoCodecstring
- routestringrequired
routesobjectrequired
- picturestring
- soundstring
- subtitlesstring
sourceobjectrequired
audioobject
- bitDepthinteger
- channelsinteger
- codecstringrequired
- deliverystring
- layoutstring
- losslessboolean
- objectAudiostring
- profilestring
- sampleRateinteger
- variantstring
subtitlesobject
- formatstring
- languagestring
- originstring
- renderingstring
- titlestring
videoobject
- bitDepthinteger
- chromaSubsamplingstring
- codecstringrequired
- containerstring
conversionobject
- enhancementDiscardedbooleanrequired
- felResidualDiscardedbooleanrequired
- kindstringrequired
- sourceDolbyVisionProfileintegerrequired
- sourceEnhancementTypestring
- dolbyVisionBaseLayerboolean
- dolbyVisionCmVersionstring
- dolbyVisionCompatibilityinteger
- dolbyVisionEnhancementTypestring
- dolbyVisionProfileinteger
- dolbyVisionRpuboolean
- dynamicRangestring
- frameRatenumber
- frameRateDenominatorinteger
- frameRateModestring
- frameRateNumeratorinteger
- hdr10Plusboolean
- heightinteger
- interlacedboolean
- masterDisplaystring
- maxCllstring
- profilestring
- widthinteger
presentationobjectrequired
audioRenderobject
- bitDepthinteger
- bytesinteger
- channelsinteger
- codecstring
- containerstring
- conversionGainDbnumber
- decoderConfigstring
- downmixedboolean
- durationFramesinteger
gainobject
- albumDbnumber
- albumPeaknumber
- sourcestringrequired
- trackDbnumber
- trackPeaknumber
- idstringrequired
- loudnessAppliedDbnumber
loudnessEnvelopeobject
- endLufsarray of numberrequired
- intervalMsintegerrequired
- startLufsarray of numberrequired
- modestringrequired
- prefetchBytesinteger
- reasonstring
- sampleRateinteger
seekIndexobject
- urlstringrequired
- sourceBitrateBpsinteger
trimobject
- endFramesintegerrequired
- sourcestringrequired
- startFramesintegerrequired
- urlstring
- versionintegerrequired
- audioTrackIdstring
- bitrateKbpsinteger
- choiceRevisioninteger
- containerstring
decisionobjectrequired
audioobject
- actionstringrequired
- channelsinteger
- reasonsarray of stringrequired
- tostring
subtitlesobject
- actionstringrequired
- channelsinteger
- reasonsarray of stringrequired
- tostring
videoobject
- actionstringrequired
- channelsinteger
- reasonsarray of stringrequired
- tostring
- enginestringrequired
- generationintegerrequired
linearobject
clocksarray of object
- endMsintegerrequired
- offsetMsintegerrequired
- startMsintegerrequired
- confirmedPositionMsinteger
- errorCodestring
- liveEdgeMsintegerrequired
- namestringrequired
nextobject
- endMsintegerrequired
- idstringrequired
- itemIdstring
- startMsintegerrequired
- titlestringrequired
- nowMsinteger
- originMsintegerrequired
programmeobject
- endMsintegerrequired
- idstringrequired
- itemIdstring
- startMsintegerrequired
- titlestringrequired
- reservationRequiredAtMsinteger
seekobject
- acknowledgedbooleanrequired
- errorstring
- idstringrequired
- liveboolean
- positionMsinteger
- statestringrequired
- windowEndMsintegerrequired
- windowStartMsintegerrequired
- modestringrequired
qualityobject
- idstring
- maxAudioBitrateKbpsinteger
- maxHeightinteger
- maxVideoBitrateKbpsinteger
- modestringrequired
- stepstring
- seekIdstring
- startPositionMsintegerrequired
subtitleobject
- deliverystringrequired
- kindstringrequired
- trackIdstringrequired
subtitlesarray of objectrequired
- companionUrlstring
- fontsUrlstring
- formatstringrequired
- linesUrlstring
- offsetMsintegerrequired
- timeDomainstringrequired
- trackIdstringrequired
- urlstringrequired
- urlstringrequired
- videoHeightinteger
queueobject
- entryIdstringrequired
- queueIdstringrequired
- retryAfterMsinteger
- revisionstringrequired
- rolestringrequired
- statestringrequired
- versionIdstring
windowarray of object
- albumstring
- albumIdstring
- artiststring
- artistIdstring
- availablebooleanrequired
- backdropUrlstring
- discinteger
- durationMsinteger
- entryIdstringrequired
episodeobject
- numberintegerrequired
- seasonNumberintegerrequired
- itemIdstringrequired
- kindstringrequired
- libraryIdstring
- positionintegerrequired
- posterUrlstring
- seasonIdstring
- segmentIdstringrequired
- showIdstring
- stillUrlstring
- titlestringrequired
- trackinteger
defaultRequest refused or unavailableapplication/json
Example
{
"error": {
"code": "string",
"message": "string"
}
}Schema
errorobjectrequired
- codestringrequired
- messagestringrequired
Error codesinvalid_requestunauthorizednot_foundrevision_requiredrevision_mismatchunsupported_selectorqueue_too_largequeue_buildingtimeoutdatabase_busywriter_capacity
Example request
curl -X PATCH "http://127.0.0.1:32500/v1/queues/{id}" \
-H "Authorization: Bearer $PORTICO_API_KEY" \
-H "Content-Type: application/json" \
-d '{"repeat":"2026-10-18T19:30:00Z","shuffle":{"on":true,"seed":"string"}}'POST/v1/queues/{id}:advanceMove to the next, previous or a chosen entry; starts its session when one is playingplayback
- Audience
- Clients · Native API
- Authorization
- API key or personal access token with the playback scope, or a signed-in session
- OpenAPI operation ID
advance_queue- Max body
- 1 KiB
Parameters
| Name | In | Type | Description |
|---|---|---|---|
idrequired | path | string |
Request body application/json · required
Example
{
"completionGeneration": 0,
"completionSessionId": "id_8h2k4q",
"entryId": "id_8h2k4q",
"reason": "string"
}Schema
- completionGenerationinteger
- completionSessionIdstring
- entryIdstring
- reasonstringrequired
Responses
200Successapplication/json
Example
{
"queue": {
"current": {
"entryId": "id_8h2k4q",
"position": 0
},
"durationKnown": true,
"id": "id_8h2k4q",
"next": {
"available": true,
"entryId": "id_8h2k4q",
"reason": "string"
},
"postPlay": {
"automaticAdvances": 0,
"autoplay": true,
"countdownMs": 1800000,
"passoutCheckDue": true,
"startDuringCredits": true
},
"remainingCount": 0,
"repeat": "2026-10-18T19:30:00Z",
"revision": "r12",
"segmentCount": 0,
"segments": [
{
"count": 0,
"id": "id_8h2k4q",
"kind": "string",
"label": "string",
"sourceRevision": "r12",
"state": "string"
}
],
"shuffle": {
"lap": 0,
"seed": "string"
},
"total": 0,
"totalDurationMs": 1800000
},
"session": {
"channelId": "id_8h2k4q",
"control": {
"revision": "r12",
"state": "string"
},
"discTitle": {
"id": "id_8h2k4q",
"revision": "r12"
},
"end": {
"message": "string",
"reason": "string"
},
"id": "id_8h2k4q",
"itemId": "id_8h2k4q",
"kind": "string",
"lease": {
"expiresAt": "2026-10-18T19:30:00Z",
"reportEveryMs": 1800000
},
"observedPlayback": {
"audio": {
"bitDepth": 0,
"channels": 0,
"codec": "string",
"handling": "string",
"layout": "string",
"objectAudio": "string",
"sampleRate": 0
},
"deliveredBitrateKbps": 0,
"screen": {
"dynamicRange": "string",
"refreshRateHz": 0
},
"subtitles": {
"rendering": "string"
},
"video": {
"bitDepth": 0,
"dynamicRange": "string",
"frameRateHz": 0,
"height": 0,
"width": 0
}
},
"playbackInfo": {
"basis": "committed_delivery_plan",
"delivered": {
"audio": {
"bitDepth": 0,
"channels": 0,
"codec": "string",
"delivery": "string",
"layout": "string",
"lossless": true,
"objectAudio": "string",
"profile": "string",
"sampleRate": 0,
"variant": "string"
},
"subtitles": {
"format": "2026-10-18T19:30:00Z",
"language": "en",
"origin": "string",
"rendering": "string",
"title": "Fargo"
},
"video": {
"bitDepth": 0,
"chromaSubsampling": "string",
"codec": "string",
"container": "string",
"conversion": {},
"dolbyVisionBaseLayer": true,
"dolbyVisionCmVersion": "string",
"dolbyVisionCompatibility": 0,
"dolbyVisionEnhancementType": "string",
"dolbyVisionProfile": 0,
"dolbyVisionRpu": true,
"dynamicRange": "string",
"frameRate": 0,
"frameRateDenominator": 0,
"frameRateMode": "string",
"frameRateNumerator": 0,
"hdr10Plus": true,
"height": 0,
"interlaced": true,
"masterDisplay": "string",
"maxCll": "string",
"profile": "string",
"width": 0
}
},
"estimatedBitrateKbps": 0,
"losses": [
{
"feature": "string",
"replacement": {}
}
],
"network": "string",
"reason": {
"audioCodec": "string",
"container": "string",
"kind": "string",
"maxBitrateKbps": 0,
"maxHeight": 0,
"videoCodec": "string"
},
"route": "string",
"routes": {
"picture": "string",
"sound": "string",
"subtitles": "Fargo"
},
"source": {
"audio": {
"bitDepth": 0,
"channels": 0,
"codec": "string",
"delivery": "string",
"layout": "string",
"lossless": true,
"objectAudio": "string",
"profile": "string",
"sampleRate": 0,
"variant": "string"
},
"subtitles": {
"format": "2026-10-18T19:30:00Z",
"language": "en",
"origin": "string",
"rendering": "string",
"title": "Fargo"
},
"video": {
"bitDepth": 0,
"chromaSubsampling": "string",
"codec": "string",
"container": "string",
"conversion": {},
"dolbyVisionBaseLayer": true,
"dolbyVisionCmVersion": "string",
"dolbyVisionCompatibility": 0,
"dolbyVisionEnhancementType": "string",
"dolbyVisionProfile": 0,
"dolbyVisionRpu": true,
"dynamicRange": "string",
"frameRate": 0,
"frameRateDenominator": 0,
"frameRateMode": "string",
"frameRateNumerator": 0,
"hdr10Plus": true,
"height": 0,
"interlaced": true,
"masterDisplay": "string",
"maxCll": "string",
"profile": "string",
"width": 0
}
}
},
"presentation": {
"audioRender": {
"bitDepth": 0,
"bytes": 0,
"channels": 0,
"codec": "string",
"container": "string",
"conversionGainDb": 0,
"decoderConfig": "string",
"downmixed": true,
"durationFrames": 0,
"gain": {
"albumDb": 0,
"albumPeak": 0,
"source": "string",
"trackDb": 0,
"trackPeak": 0
},
"id": "id_8h2k4q",
"loudnessAppliedDb": 0,
"loudnessEnvelope": {
"endLufs": [],
"intervalMs": 1800000,
"startLufs": []
},
"mode": "string",
"prefetchBytes": 0,
"reason": "string",
"sampleRate": 0,
"seekIndex": {
"url": "https://example.com/…"
},
"sourceBitrateBps": 0,
"trim": {
"endFrames": 0,
"source": "string",
"startFrames": 0
},
"url": "https://example.com/…",
"version": 0
},
"audioTrackId": "id_8h2k4q",
"bitrateKbps": 0,
"choiceRevision": 0,
"container": "string",
"decision": {
"audio": {
"action": "string",
"channels": 0,
"reasons": [],
"to": "string"
},
"subtitles": {
"action": "string",
"channels": 0,
"reasons": [],
"to": "string"
},
"video": {
"action": "string",
"channels": 0,
"reasons": [],
"to": "string"
}
},
"engine": "string",
"generation": 0,
"linear": {
"clocks": [
{}
],
"confirmedPositionMs": 1800000,
"errorCode": "string",
"liveEdgeMs": 1800000,
"name": "Fargo",
"next": {
"endMs": 1800000,
"id": "id_8h2k4q",
"itemId": "id_8h2k4q",
"startMs": 1800000,
"title": "Fargo"
},
"nowMs": 1800000,
"originMs": 1800000,
"programme": {
"endMs": 1800000,
"id": "id_8h2k4q",
"itemId": "id_8h2k4q",
"startMs": 1800000,
"title": "Fargo"
},
"reservationRequiredAtMs": 1800000,
"seek": {
"acknowledged": true,
"error": "string",
"id": "id_8h2k4q",
"live": true,
"positionMs": 1800000
},
"state": "string",
"windowEndMs": 1800000,
"windowStartMs": 1800000
},
"mode": "string",
"quality": {
"id": "id_8h2k4q",
"maxAudioBitrateKbps": 0,
"maxHeight": 0,
"maxVideoBitrateKbps": 0,
"mode": "string",
"step": "string"
},
"seekId": "id_8h2k4q",
"startPositionMs": 1800000,
"subtitle": {
"delivery": "string",
"kind": "string",
"trackId": "id_8h2k4q"
},
"subtitles": [
{
"companionUrl": "https://example.com/…",
"fontsUrl": "https://example.com/…",
"format": "2026-10-18T19:30:00Z",
"linesUrl": "https://example.com/…",
"offsetMs": 1800000,
"timeDomain": "2026-10-18T19:30:00Z",
"trackId": "id_8h2k4q",
"url": "https://example.com/…"
}
],
"url": "https://example.com/…",
"videoHeight": 0
},
"queue": {
"entryId": "id_8h2k4q",
"queueId": "id_8h2k4q"
},
"retryAfterMs": 1800000,
"revision": "r12",
"role": "string",
"state": "string",
"versionId": "id_8h2k4q"
},
"window": [
{
"album": "string",
"albumId": "id_8h2k4q",
"artist": "string",
"artistId": "id_8h2k4q",
"available": true,
"backdropUrl": "https://example.com/…",
"disc": 0,
"durationMs": 1800000,
"entryId": "id_8h2k4q",
"episode": {
"number": 0,
"seasonNumber": 0
},
"itemId": "id_8h2k4q",
"kind": "string",
"libraryId": "id_8h2k4q",
"position": 0,
"posterUrl": "https://example.com/…",
"seasonId": "id_8h2k4q",
"segmentId": "id_8h2k4q",
"showId": "id_8h2k4q",
"stillUrl": "https://example.com/…",
"title": "Fargo",
"track": 0
}
]
}Schema
queueobjectrequired
currentobject
- entryIdstringrequired
- positionintegerrequired
- durationKnownbooleanrequired
- idstringrequired
nextobject
- availablebooleanrequired
- entryIdstring
- reasonstringrequired
postPlayobject
- automaticAdvancesintegerrequired
- autoplaybooleanrequired
- countdownMsintegerrequired
- passoutCheckDuebooleanrequired
- startDuringCreditsbooleanrequired
- remainingCountintegerrequired
- repeatstringrequired
- revisionstringrequired
- segmentCountintegerrequired
segmentsarray of objectrequired
- countintegerrequired
- idstringrequired
- kindstringrequired
- labelstringrequired
- sourceRevisionstring
- statestringrequired
shuffleobject
- lapintegerrequired
- seedstringrequired
- totalintegerrequired
- totalDurationMsinteger
sessionobject
- channelIdstring
controlobject
- revisionstringrequired
- statestringrequired
discTitleobject
- idstringrequired
- revisionstringrequired
endobject
- messagestring
- reasonstringrequired
- idstringrequired
- itemIdstring
- kindstringrequired
leaseobjectrequired
- expiresAtstringrequired
- reportEveryMsintegerrequired
observedPlaybackobject
audioobject
- bitDepthinteger
- channelsinteger
- codecstring
- handlingstring
- layoutstring
- objectAudiostring
- sampleRateinteger
- deliveredBitrateKbpsinteger
screenobject
- dynamicRangestring
- refreshRateHznumber
subtitlesobject
- renderingstringrequired
videoobject
- bitDepthinteger
- dynamicRangestring
- frameRateHznumber
- heightinteger
- widthinteger
playbackInfoobject
- basisstringrequiredone of "committed_delivery_plan"
deliveredobjectrequired
audioobject
- bitDepthinteger
- channelsinteger
- codecstringrequired
- deliverystring
- layoutstring
- losslessboolean
- objectAudiostring
- profilestring
- sampleRateinteger
- variantstring
subtitlesobject
- formatstring
- languagestring
- originstring
- renderingstring
- titlestring
videoobject
- bitDepthinteger
- chromaSubsamplingstring
- codecstringrequired
- containerstring
conversionobject
- enhancementDiscardedbooleanrequired
- felResidualDiscardedbooleanrequired
- kindstringrequired
- sourceDolbyVisionProfileintegerrequired
- sourceEnhancementTypestring
- dolbyVisionBaseLayerboolean
- dolbyVisionCmVersionstring
- dolbyVisionCompatibilityinteger
- dolbyVisionEnhancementTypestring
- dolbyVisionProfileinteger
- dolbyVisionRpuboolean
- dynamicRangestring
- frameRatenumber
- frameRateDenominatorinteger
- frameRateModestring
- frameRateNumeratorinteger
- hdr10Plusboolean
- heightinteger
- interlacedboolean
- masterDisplaystring
- maxCllstring
- profilestring
- widthinteger
- estimatedBitrateKbpsinteger
lossesarray of objectrequired
- featurestringrequired
replacementobjectrequired
- audioCodecstring
- channelsinteger
- dynamicRangestring
- layoutstring
- networkstringrequired
reasonobjectrequired
- audioCodecstring
- containerstring
- kindstringrequired
- maxBitrateKbpsinteger
- maxHeightinteger
- videoCodecstring
- routestringrequired
routesobjectrequired
- picturestring
- soundstring
- subtitlesstring
sourceobjectrequired
audioobject
- bitDepthinteger
- channelsinteger
- codecstringrequired
- deliverystring
- layoutstring
- losslessboolean
- objectAudiostring
- profilestring
- sampleRateinteger
- variantstring
subtitlesobject
- formatstring
- languagestring
- originstring
- renderingstring
- titlestring
videoobject
- bitDepthinteger
- chromaSubsamplingstring
- codecstringrequired
- containerstring
conversionobject
- enhancementDiscardedbooleanrequired
- felResidualDiscardedbooleanrequired
- kindstringrequired
- sourceDolbyVisionProfileintegerrequired
- sourceEnhancementTypestring
- dolbyVisionBaseLayerboolean
- dolbyVisionCmVersionstring
- dolbyVisionCompatibilityinteger
- dolbyVisionEnhancementTypestring
- dolbyVisionProfileinteger
- dolbyVisionRpuboolean
- dynamicRangestring
- frameRatenumber
- frameRateDenominatorinteger
- frameRateModestring
- frameRateNumeratorinteger
- hdr10Plusboolean
- heightinteger
- interlacedboolean
- masterDisplaystring
- maxCllstring
- profilestring
- widthinteger
presentationobjectrequired
audioRenderobject
- bitDepthinteger
- bytesinteger
- channelsinteger
- codecstring
- containerstring
- conversionGainDbnumber
- decoderConfigstring
- downmixedboolean
- durationFramesinteger
gainobject
- albumDbnumber
- albumPeaknumber
- sourcestringrequired
- trackDbnumber
- trackPeaknumber
- idstringrequired
- loudnessAppliedDbnumber
loudnessEnvelopeobject
- endLufsarray of numberrequired
- intervalMsintegerrequired
- startLufsarray of numberrequired
- modestringrequired
- prefetchBytesinteger
- reasonstring
- sampleRateinteger
seekIndexobject
- urlstringrequired
- sourceBitrateBpsinteger
trimobject
- endFramesintegerrequired
- sourcestringrequired
- startFramesintegerrequired
- urlstring
- versionintegerrequired
- audioTrackIdstring
- bitrateKbpsinteger
- choiceRevisioninteger
- containerstring
decisionobjectrequired
audioobject
- actionstringrequired
- channelsinteger
- reasonsarray of stringrequired
- tostring
subtitlesobject
- actionstringrequired
- channelsinteger
- reasonsarray of stringrequired
- tostring
videoobject
- actionstringrequired
- channelsinteger
- reasonsarray of stringrequired
- tostring
- enginestringrequired
- generationintegerrequired
linearobject
clocksarray of object
- endMsintegerrequired
- offsetMsintegerrequired
- startMsintegerrequired
- confirmedPositionMsinteger
- errorCodestring
- liveEdgeMsintegerrequired
- namestringrequired
nextobject
- endMsintegerrequired
- idstringrequired
- itemIdstring
- startMsintegerrequired
- titlestringrequired
- nowMsinteger
- originMsintegerrequired
programmeobject
- endMsintegerrequired
- idstringrequired
- itemIdstring
- startMsintegerrequired
- titlestringrequired
- reservationRequiredAtMsinteger
seekobject
- acknowledgedbooleanrequired
- errorstring
- idstringrequired
- liveboolean
- positionMsinteger
- statestringrequired
- windowEndMsintegerrequired
- windowStartMsintegerrequired
- modestringrequired
qualityobject
- idstring
- maxAudioBitrateKbpsinteger
- maxHeightinteger
- maxVideoBitrateKbpsinteger
- modestringrequired
- stepstring
- seekIdstring
- startPositionMsintegerrequired
subtitleobject
- deliverystringrequired
- kindstringrequired
- trackIdstringrequired
subtitlesarray of objectrequired
- companionUrlstring
- fontsUrlstring
- formatstringrequired
- linesUrlstring
- offsetMsintegerrequired
- timeDomainstringrequired
- trackIdstringrequired
- urlstringrequired
- urlstringrequired
- videoHeightinteger
queueobject
- entryIdstringrequired
- queueIdstringrequired
- retryAfterMsinteger
- revisionstringrequired
- rolestringrequired
- statestringrequired
- versionIdstring
windowarray of object
- albumstring
- albumIdstring
- artiststring
- artistIdstring
- availablebooleanrequired
- backdropUrlstring
- discinteger
- durationMsinteger
- entryIdstringrequired
episodeobject
- numberintegerrequired
- seasonNumberintegerrequired
- itemIdstringrequired
- kindstringrequired
- libraryIdstring
- positionintegerrequired
- posterUrlstring
- seasonIdstring
- segmentIdstringrequired
- showIdstring
- stillUrlstring
- titlestringrequired
- trackinteger
defaultRequest refused or unavailableapplication/json
Example
{
"error": {
"code": "string",
"message": "string"
}
}Schema
errorobjectrequired
- codestringrequired
- messagestringrequired
Error codesinvalid_requestunauthorizednot_foundrevision_requiredrevision_mismatchunsupported_selectorqueue_too_largequeue_buildingqueue_endedstream_limit_reachedconversion_capacitytranscode_not_allowedunsupported_mediatimeoutdatabase_busywriter_capacity
Example request
curl -X POST "http://127.0.0.1:32500/v1/queues/{id}:advance" \
-H "Authorization: Bearer $PORTICO_API_KEY" \
-H "Content-Type: application/json" \
-d '{"completionGeneration":0,"completionSessionId":"id_8h2k4q","entryId":"id_8h2k4q","reason":"string"}'POST/v1/queues/{id}:commit-nextCommit the prepared next entry at the audio boundary: a new session inheriting state, rate, quality and track (spec §18.3)playback
- Audience
- Clients · Native API
- Authorization
- API key or personal access token with the playback scope, or a signed-in session
- OpenAPI operation ID
commit_queue_next- Max body
- 1 KiB
Parameters
| Name | In | Type | Description |
|---|---|---|---|
idrequired | path | string |
Request body application/json · required
Example
{
"token": "string"
}Schema
- tokenstringrequired
Responses
200Successapplication/json
Example
{
"queue": {
"current": {
"entryId": "id_8h2k4q",
"position": 0
},
"durationKnown": true,
"id": "id_8h2k4q",
"next": {
"available": true,
"entryId": "id_8h2k4q",
"reason": "string"
},
"postPlay": {
"automaticAdvances": 0,
"autoplay": true,
"countdownMs": 1800000,
"passoutCheckDue": true,
"startDuringCredits": true
},
"remainingCount": 0,
"repeat": "2026-10-18T19:30:00Z",
"revision": "r12",
"segmentCount": 0,
"segments": [
{
"count": 0,
"id": "id_8h2k4q",
"kind": "string",
"label": "string",
"sourceRevision": "r12",
"state": "string"
}
],
"shuffle": {
"lap": 0,
"seed": "string"
},
"total": 0,
"totalDurationMs": 1800000
},
"session": {
"channelId": "id_8h2k4q",
"control": {
"revision": "r12",
"state": "string"
},
"discTitle": {
"id": "id_8h2k4q",
"revision": "r12"
},
"end": {
"message": "string",
"reason": "string"
},
"id": "id_8h2k4q",
"itemId": "id_8h2k4q",
"kind": "string",
"lease": {
"expiresAt": "2026-10-18T19:30:00Z",
"reportEveryMs": 1800000
},
"observedPlayback": {
"audio": {
"bitDepth": 0,
"channels": 0,
"codec": "string",
"handling": "string",
"layout": "string",
"objectAudio": "string",
"sampleRate": 0
},
"deliveredBitrateKbps": 0,
"screen": {
"dynamicRange": "string",
"refreshRateHz": 0
},
"subtitles": {
"rendering": "string"
},
"video": {
"bitDepth": 0,
"dynamicRange": "string",
"frameRateHz": 0,
"height": 0,
"width": 0
}
},
"playbackInfo": {
"basis": "committed_delivery_plan",
"delivered": {
"audio": {
"bitDepth": 0,
"channels": 0,
"codec": "string",
"delivery": "string",
"layout": "string",
"lossless": true,
"objectAudio": "string",
"profile": "string",
"sampleRate": 0,
"variant": "string"
},
"subtitles": {
"format": "2026-10-18T19:30:00Z",
"language": "en",
"origin": "string",
"rendering": "string",
"title": "Fargo"
},
"video": {
"bitDepth": 0,
"chromaSubsampling": "string",
"codec": "string",
"container": "string",
"conversion": {},
"dolbyVisionBaseLayer": true,
"dolbyVisionCmVersion": "string",
"dolbyVisionCompatibility": 0,
"dolbyVisionEnhancementType": "string",
"dolbyVisionProfile": 0,
"dolbyVisionRpu": true,
"dynamicRange": "string",
"frameRate": 0,
"frameRateDenominator": 0,
"frameRateMode": "string",
"frameRateNumerator": 0,
"hdr10Plus": true,
"height": 0,
"interlaced": true,
"masterDisplay": "string",
"maxCll": "string",
"profile": "string",
"width": 0
}
},
"estimatedBitrateKbps": 0,
"losses": [
{
"feature": "string",
"replacement": {}
}
],
"network": "string",
"reason": {
"audioCodec": "string",
"container": "string",
"kind": "string",
"maxBitrateKbps": 0,
"maxHeight": 0,
"videoCodec": "string"
},
"route": "string",
"routes": {
"picture": "string",
"sound": "string",
"subtitles": "Fargo"
},
"source": {
"audio": {
"bitDepth": 0,
"channels": 0,
"codec": "string",
"delivery": "string",
"layout": "string",
"lossless": true,
"objectAudio": "string",
"profile": "string",
"sampleRate": 0,
"variant": "string"
},
"subtitles": {
"format": "2026-10-18T19:30:00Z",
"language": "en",
"origin": "string",
"rendering": "string",
"title": "Fargo"
},
"video": {
"bitDepth": 0,
"chromaSubsampling": "string",
"codec": "string",
"container": "string",
"conversion": {},
"dolbyVisionBaseLayer": true,
"dolbyVisionCmVersion": "string",
"dolbyVisionCompatibility": 0,
"dolbyVisionEnhancementType": "string",
"dolbyVisionProfile": 0,
"dolbyVisionRpu": true,
"dynamicRange": "string",
"frameRate": 0,
"frameRateDenominator": 0,
"frameRateMode": "string",
"frameRateNumerator": 0,
"hdr10Plus": true,
"height": 0,
"interlaced": true,
"masterDisplay": "string",
"maxCll": "string",
"profile": "string",
"width": 0
}
}
},
"presentation": {
"audioRender": {
"bitDepth": 0,
"bytes": 0,
"channels": 0,
"codec": "string",
"container": "string",
"conversionGainDb": 0,
"decoderConfig": "string",
"downmixed": true,
"durationFrames": 0,
"gain": {
"albumDb": 0,
"albumPeak": 0,
"source": "string",
"trackDb": 0,
"trackPeak": 0
},
"id": "id_8h2k4q",
"loudnessAppliedDb": 0,
"loudnessEnvelope": {
"endLufs": [],
"intervalMs": 1800000,
"startLufs": []
},
"mode": "string",
"prefetchBytes": 0,
"reason": "string",
"sampleRate": 0,
"seekIndex": {
"url": "https://example.com/…"
},
"sourceBitrateBps": 0,
"trim": {
"endFrames": 0,
"source": "string",
"startFrames": 0
},
"url": "https://example.com/…",
"version": 0
},
"audioTrackId": "id_8h2k4q",
"bitrateKbps": 0,
"choiceRevision": 0,
"container": "string",
"decision": {
"audio": {
"action": "string",
"channels": 0,
"reasons": [],
"to": "string"
},
"subtitles": {
"action": "string",
"channels": 0,
"reasons": [],
"to": "string"
},
"video": {
"action": "string",
"channels": 0,
"reasons": [],
"to": "string"
}
},
"engine": "string",
"generation": 0,
"linear": {
"clocks": [
{}
],
"confirmedPositionMs": 1800000,
"errorCode": "string",
"liveEdgeMs": 1800000,
"name": "Fargo",
"next": {
"endMs": 1800000,
"id": "id_8h2k4q",
"itemId": "id_8h2k4q",
"startMs": 1800000,
"title": "Fargo"
},
"nowMs": 1800000,
"originMs": 1800000,
"programme": {
"endMs": 1800000,
"id": "id_8h2k4q",
"itemId": "id_8h2k4q",
"startMs": 1800000,
"title": "Fargo"
},
"reservationRequiredAtMs": 1800000,
"seek": {
"acknowledged": true,
"error": "string",
"id": "id_8h2k4q",
"live": true,
"positionMs": 1800000
},
"state": "string",
"windowEndMs": 1800000,
"windowStartMs": 1800000
},
"mode": "string",
"quality": {
"id": "id_8h2k4q",
"maxAudioBitrateKbps": 0,
"maxHeight": 0,
"maxVideoBitrateKbps": 0,
"mode": "string",
"step": "string"
},
"seekId": "id_8h2k4q",
"startPositionMs": 1800000,
"subtitle": {
"delivery": "string",
"kind": "string",
"trackId": "id_8h2k4q"
},
"subtitles": [
{
"companionUrl": "https://example.com/…",
"fontsUrl": "https://example.com/…",
"format": "2026-10-18T19:30:00Z",
"linesUrl": "https://example.com/…",
"offsetMs": 1800000,
"timeDomain": "2026-10-18T19:30:00Z",
"trackId": "id_8h2k4q",
"url": "https://example.com/…"
}
],
"url": "https://example.com/…",
"videoHeight": 0
},
"queue": {
"entryId": "id_8h2k4q",
"queueId": "id_8h2k4q"
},
"retryAfterMs": 1800000,
"revision": "r12",
"role": "string",
"state": "string",
"versionId": "id_8h2k4q"
},
"window": [
{
"album": "string",
"albumId": "id_8h2k4q",
"artist": "string",
"artistId": "id_8h2k4q",
"available": true,
"backdropUrl": "https://example.com/…",
"disc": 0,
"durationMs": 1800000,
"entryId": "id_8h2k4q",
"episode": {
"number": 0,
"seasonNumber": 0
},
"itemId": "id_8h2k4q",
"kind": "string",
"libraryId": "id_8h2k4q",
"position": 0,
"posterUrl": "https://example.com/…",
"seasonId": "id_8h2k4q",
"segmentId": "id_8h2k4q",
"showId": "id_8h2k4q",
"stillUrl": "https://example.com/…",
"title": "Fargo",
"track": 0
}
]
}Schema
queueobjectrequired
currentobject
- entryIdstringrequired
- positionintegerrequired
- durationKnownbooleanrequired
- idstringrequired
nextobject
- availablebooleanrequired
- entryIdstring
- reasonstringrequired
postPlayobject
- automaticAdvancesintegerrequired
- autoplaybooleanrequired
- countdownMsintegerrequired
- passoutCheckDuebooleanrequired
- startDuringCreditsbooleanrequired
- remainingCountintegerrequired
- repeatstringrequired
- revisionstringrequired
- segmentCountintegerrequired
segmentsarray of objectrequired
- countintegerrequired
- idstringrequired
- kindstringrequired
- labelstringrequired
- sourceRevisionstring
- statestringrequired
shuffleobject
- lapintegerrequired
- seedstringrequired
- totalintegerrequired
- totalDurationMsinteger
sessionobject
- channelIdstring
controlobject
- revisionstringrequired
- statestringrequired
discTitleobject
- idstringrequired
- revisionstringrequired
endobject
- messagestring
- reasonstringrequired
- idstringrequired
- itemIdstring
- kindstringrequired
leaseobjectrequired
- expiresAtstringrequired
- reportEveryMsintegerrequired
observedPlaybackobject
audioobject
- bitDepthinteger
- channelsinteger
- codecstring
- handlingstring
- layoutstring
- objectAudiostring
- sampleRateinteger
- deliveredBitrateKbpsinteger
screenobject
- dynamicRangestring
- refreshRateHznumber
subtitlesobject
- renderingstringrequired
videoobject
- bitDepthinteger
- dynamicRangestring
- frameRateHznumber
- heightinteger
- widthinteger
playbackInfoobject
- basisstringrequiredone of "committed_delivery_plan"
deliveredobjectrequired
audioobject
- bitDepthinteger
- channelsinteger
- codecstringrequired
- deliverystring
- layoutstring
- losslessboolean
- objectAudiostring
- profilestring
- sampleRateinteger
- variantstring
subtitlesobject
- formatstring
- languagestring
- originstring
- renderingstring
- titlestring
videoobject
- bitDepthinteger
- chromaSubsamplingstring
- codecstringrequired
- containerstring
conversionobject
- enhancementDiscardedbooleanrequired
- felResidualDiscardedbooleanrequired
- kindstringrequired
- sourceDolbyVisionProfileintegerrequired
- sourceEnhancementTypestring
- dolbyVisionBaseLayerboolean
- dolbyVisionCmVersionstring
- dolbyVisionCompatibilityinteger
- dolbyVisionEnhancementTypestring
- dolbyVisionProfileinteger
- dolbyVisionRpuboolean
- dynamicRangestring
- frameRatenumber
- frameRateDenominatorinteger
- frameRateModestring
- frameRateNumeratorinteger
- hdr10Plusboolean
- heightinteger
- interlacedboolean
- masterDisplaystring
- maxCllstring
- profilestring
- widthinteger
- estimatedBitrateKbpsinteger
lossesarray of objectrequired
- featurestringrequired
replacementobjectrequired
- audioCodecstring
- channelsinteger
- dynamicRangestring
- layoutstring
- networkstringrequired
reasonobjectrequired
- audioCodecstring
- containerstring
- kindstringrequired
- maxBitrateKbpsinteger
- maxHeightinteger
- videoCodecstring
- routestringrequired
routesobjectrequired
- picturestring
- soundstring
- subtitlesstring
sourceobjectrequired
audioobject
- bitDepthinteger
- channelsinteger
- codecstringrequired
- deliverystring
- layoutstring
- losslessboolean
- objectAudiostring
- profilestring
- sampleRateinteger
- variantstring
subtitlesobject
- formatstring
- languagestring
- originstring
- renderingstring
- titlestring
videoobject
- bitDepthinteger
- chromaSubsamplingstring
- codecstringrequired
- containerstring
conversionobject
- enhancementDiscardedbooleanrequired
- felResidualDiscardedbooleanrequired
- kindstringrequired
- sourceDolbyVisionProfileintegerrequired
- sourceEnhancementTypestring
- dolbyVisionBaseLayerboolean
- dolbyVisionCmVersionstring
- dolbyVisionCompatibilityinteger
- dolbyVisionEnhancementTypestring
- dolbyVisionProfileinteger
- dolbyVisionRpuboolean
- dynamicRangestring
- frameRatenumber
- frameRateDenominatorinteger
- frameRateModestring
- frameRateNumeratorinteger
- hdr10Plusboolean
- heightinteger
- interlacedboolean
- masterDisplaystring
- maxCllstring
- profilestring
- widthinteger
presentationobjectrequired
audioRenderobject
- bitDepthinteger
- bytesinteger
- channelsinteger
- codecstring
- containerstring
- conversionGainDbnumber
- decoderConfigstring
- downmixedboolean
- durationFramesinteger
gainobject
- albumDbnumber
- albumPeaknumber
- sourcestringrequired
- trackDbnumber
- trackPeaknumber
- idstringrequired
- loudnessAppliedDbnumber
loudnessEnvelopeobject
- endLufsarray of numberrequired
- intervalMsintegerrequired
- startLufsarray of numberrequired
- modestringrequired
- prefetchBytesinteger
- reasonstring
- sampleRateinteger
seekIndexobject
- urlstringrequired
- sourceBitrateBpsinteger
trimobject
- endFramesintegerrequired
- sourcestringrequired
- startFramesintegerrequired
- urlstring
- versionintegerrequired
- audioTrackIdstring
- bitrateKbpsinteger
- choiceRevisioninteger
- containerstring
decisionobjectrequired
audioobject
- actionstringrequired
- channelsinteger
- reasonsarray of stringrequired
- tostring
subtitlesobject
- actionstringrequired
- channelsinteger
- reasonsarray of stringrequired
- tostring
videoobject
- actionstringrequired
- channelsinteger
- reasonsarray of stringrequired
- tostring
- enginestringrequired
- generationintegerrequired
linearobject
clocksarray of object
- endMsintegerrequired
- offsetMsintegerrequired
- startMsintegerrequired
- confirmedPositionMsinteger
- errorCodestring
- liveEdgeMsintegerrequired
- namestringrequired
nextobject
- endMsintegerrequired
- idstringrequired
- itemIdstring
- startMsintegerrequired
- titlestringrequired
- nowMsinteger
- originMsintegerrequired
programmeobject
- endMsintegerrequired
- idstringrequired
- itemIdstring
- startMsintegerrequired
- titlestringrequired
- reservationRequiredAtMsinteger
seekobject
- acknowledgedbooleanrequired
- errorstring
- idstringrequired
- liveboolean
- positionMsinteger
- statestringrequired
- windowEndMsintegerrequired
- windowStartMsintegerrequired
- modestringrequired
qualityobject
- idstring
- maxAudioBitrateKbpsinteger
- maxHeightinteger
- maxVideoBitrateKbpsinteger
- modestringrequired
- stepstring
- seekIdstring
- startPositionMsintegerrequired
subtitleobject
- deliverystringrequired
- kindstringrequired
- trackIdstringrequired
subtitlesarray of objectrequired
- companionUrlstring
- fontsUrlstring
- formatstringrequired
- linesUrlstring
- offsetMsintegerrequired
- timeDomainstringrequired
- trackIdstringrequired
- urlstringrequired
- urlstringrequired
- videoHeightinteger
queueobject
- entryIdstringrequired
- queueIdstringrequired
- retryAfterMsinteger
- revisionstringrequired
- rolestringrequired
- statestringrequired
- versionIdstring
windowarray of object
- albumstring
- albumIdstring
- artiststring
- artistIdstring
- availablebooleanrequired
- backdropUrlstring
- discinteger
- durationMsinteger
- entryIdstringrequired
episodeobject
- numberintegerrequired
- seasonNumberintegerrequired
- itemIdstringrequired
- kindstringrequired
- libraryIdstring
- positionintegerrequired
- posterUrlstring
- seasonIdstring
- segmentIdstringrequired
- showIdstring
- stillUrlstring
- titlestringrequired
- trackinteger
defaultRequest refused or unavailableapplication/json
Example
{
"error": {
"code": "string",
"message": "string"
}
}Schema
errorobjectrequired
- codestringrequired
- messagestringrequired
Error codesinvalid_requestunauthorizednot_foundrevision_requiredrevision_mismatchunsupported_selectorqueue_too_largequeue_buildingprepared_expiredprepared_cancelednot_implementedtimeoutdatabase_busywriter_capacity
Example request
curl -X POST "http://127.0.0.1:32500/v1/queues/{id}:commit-next" \
-H "Authorization: Bearer $PORTICO_API_KEY" \
-H "Content-Type: application/json" \
-d '{"token":"string"}'POST/v1/queues/{id}:prepare-nextPrepare the next entry's audio before the current one ends (spec §18.2; private until committed)playback
- Audience
- Clients · Native API
- Authorization
- API key or personal access token with the playback scope, or a signed-in session
- OpenAPI operation ID
prepare_queue_next- Max body
- 1 KiB
Parameters
| Name | In | Type | Description |
|---|---|---|---|
idrequired | path | string |
Request body application/json · required
Example
{
"sessionGeneration": 0,
"sessionId": "id_8h2k4q"
}Schema
- sessionGenerationintegerrequired
- sessionIdstringrequired
Responses
200Successapplication/json
Example
{
"entryId": "id_8h2k4q",
"expiresAt": "2026-10-18T19:30:00Z",
"itemId": "id_8h2k4q",
"presentation": {
"audioRender": {
"bitDepth": 0,
"bytes": 0,
"channels": 0,
"codec": "string",
"container": "string",
"conversionGainDb": 0,
"decoderConfig": "string",
"downmixed": true,
"durationFrames": 0,
"gain": {
"albumDb": 0,
"albumPeak": 0,
"source": "string",
"trackDb": 0,
"trackPeak": 0
},
"id": "id_8h2k4q",
"loudnessAppliedDb": 0,
"loudnessEnvelope": {
"endLufs": [
0
],
"intervalMs": 1800000,
"startLufs": [
0
]
},
"mode": "string",
"prefetchBytes": 0,
"reason": "string",
"sampleRate": 0,
"seekIndex": {
"url": "https://example.com/…"
},
"sourceBitrateBps": 0,
"trim": {
"endFrames": 0,
"source": "string",
"startFrames": 0
},
"url": "https://example.com/…",
"version": 0
},
"audioTrackId": "id_8h2k4q",
"bitrateKbps": 0,
"choiceRevision": 0,
"container": "string",
"decision": {
"audio": {
"action": "string",
"channels": 0,
"reasons": [
"string"
],
"to": "string"
},
"subtitles": {
"action": "string",
"channels": 0,
"reasons": [
"string"
],
"to": "string"
},
"video": {
"action": "string",
"channels": 0,
"reasons": [
"string"
],
"to": "string"
}
},
"engine": "string",
"generation": 0,
"linear": {
"clocks": [
{
"endMs": 1800000,
"offsetMs": 1800000,
"startMs": 1800000
}
],
"confirmedPositionMs": 1800000,
"errorCode": "string",
"liveEdgeMs": 1800000,
"name": "Fargo",
"next": {
"endMs": 1800000,
"id": "id_8h2k4q",
"itemId": "id_8h2k4q",
"startMs": 1800000,
"title": "Fargo"
},
"nowMs": 1800000,
"originMs": 1800000,
"programme": {
"endMs": 1800000,
"id": "id_8h2k4q",
"itemId": "id_8h2k4q",
"startMs": 1800000,
"title": "Fargo"
},
"reservationRequiredAtMs": 1800000,
"seek": {
"acknowledged": true,
"error": "string",
"id": "id_8h2k4q",
"live": true,
"positionMs": 1800000
},
"state": "string",
"windowEndMs": 1800000,
"windowStartMs": 1800000
},
"mode": "string",
"quality": {
"id": "id_8h2k4q",
"maxAudioBitrateKbps": 0,
"maxHeight": 0,
"maxVideoBitrateKbps": 0,
"mode": "string",
"step": "string"
},
"seekId": "id_8h2k4q",
"startPositionMs": 1800000,
"subtitle": {
"delivery": "string",
"kind": "string",
"trackId": "id_8h2k4q"
},
"subtitles": [
{
"companionUrl": "https://example.com/…",
"fontsUrl": "https://example.com/…",
"format": "2026-10-18T19:30:00Z",
"linesUrl": "https://example.com/…",
"offsetMs": 1800000,
"timeDomain": "2026-10-18T19:30:00Z",
"trackId": "id_8h2k4q",
"url": "https://example.com/…"
}
],
"url": "https://example.com/…",
"videoHeight": 0
},
"token": "string"
}Schema
- entryIdstringrequired
- expiresAtstringrequired
- itemIdstringrequired
presentationobjectrequired
audioRenderobject
- bitDepthinteger
- bytesinteger
- channelsinteger
- codecstring
- containerstring
- conversionGainDbnumber
- decoderConfigstring
- downmixedboolean
- durationFramesinteger
gainobject
- albumDbnumber
- albumPeaknumber
- sourcestringrequired
- trackDbnumber
- trackPeaknumber
- idstringrequired
- loudnessAppliedDbnumber
loudnessEnvelopeobject
- endLufsarray of numberrequired
- intervalMsintegerrequired
- startLufsarray of numberrequired
- modestringrequired
- prefetchBytesinteger
- reasonstring
- sampleRateinteger
seekIndexobject
- urlstringrequired
- sourceBitrateBpsinteger
trimobject
- endFramesintegerrequired
- sourcestringrequired
- startFramesintegerrequired
- urlstring
- versionintegerrequired
- audioTrackIdstring
- bitrateKbpsinteger
- choiceRevisioninteger
- containerstring
decisionobjectrequired
audioobject
- actionstringrequired
- channelsinteger
- reasonsarray of stringrequired
- tostring
subtitlesobject
- actionstringrequired
- channelsinteger
- reasonsarray of stringrequired
- tostring
videoobject
- actionstringrequired
- channelsinteger
- reasonsarray of stringrequired
- tostring
- enginestringrequired
- generationintegerrequired
linearobject
clocksarray of object
- endMsintegerrequired
- offsetMsintegerrequired
- startMsintegerrequired
- confirmedPositionMsinteger
- errorCodestring
- liveEdgeMsintegerrequired
- namestringrequired
nextobject
- endMsintegerrequired
- idstringrequired
- itemIdstring
- startMsintegerrequired
- titlestringrequired
- nowMsinteger
- originMsintegerrequired
programmeobject
- endMsintegerrequired
- idstringrequired
- itemIdstring
- startMsintegerrequired
- titlestringrequired
- reservationRequiredAtMsinteger
seekobject
- acknowledgedbooleanrequired
- errorstring
- idstringrequired
- liveboolean
- positionMsinteger
- statestringrequired
- windowEndMsintegerrequired
- windowStartMsintegerrequired
- modestringrequired
qualityobject
- idstring
- maxAudioBitrateKbpsinteger
- maxHeightinteger
- maxVideoBitrateKbpsinteger
- modestringrequired
- stepstring
- seekIdstring
- startPositionMsintegerrequired
subtitleobject
- deliverystringrequired
- kindstringrequired
- trackIdstringrequired
subtitlesarray of objectrequired
- companionUrlstring
- fontsUrlstring
- formatstringrequired
- linesUrlstring
- offsetMsintegerrequired
- timeDomainstringrequired
- trackIdstringrequired
- urlstringrequired
- urlstringrequired
- videoHeightinteger
- tokenstringrequired
defaultRequest refused or unavailableapplication/json
Example
{
"error": {
"code": "string",
"message": "string"
}
}Schema
errorobjectrequired
- codestringrequired
- messagestringrequired
Error codesinvalid_requestunauthorizednot_foundrevision_requiredrevision_mismatchunsupported_selectorqueue_too_largequeue_buildingidempotency_key_requiredidempotency_key_reusedqueue_endedprepare_not_allowedconversion_capacitynot_implementedtimeoutdatabase_busywriter_capacity
Example request
curl -X POST "http://127.0.0.1:32500/v1/queues/{id}:prepare-next" \
-H "Authorization: Bearer $PORTICO_API_KEY" \
-H "Content-Type: application/json" \
-d '{"sessionGeneration":0,"sessionId":"id_8h2k4q"}'POST/v1/queues/{id}:save-as-playlistSave the queue, in play order, as a new playlist; a long queue is copied in the background and a replay of the key reports progressplayback
- Audience
- Clients · Native API
- Authorization
- API key or personal access token with the playback scope, or a signed-in session
- OpenAPI operation ID
save_queue_as_playlist- Max body
- 8 KiB
Parameters
| Name | In | Type | Description |
|---|---|---|---|
idrequired | path | string |
Request body application/json · required
Example
{
"name": "Fargo",
"summary": "string"
}Schema
- namestringrequired
- summarystring
Responses
201Successapplication/json
Example
{
"entries": 0,
"errorCode": "string",
"playlistId": "id_8h2k4q",
"revision": "r12",
"state": "string",
"total": 0
}Schema
- entriesintegerrequired
- errorCodestring
- playlistIdstringrequired
- revisionstringrequired
- statestringrequired
- totalinteger
defaultRequest refused or unavailableapplication/json
Example
{
"error": {
"code": "string",
"message": "string"
}
}Schema
errorobjectrequired
- codestringrequired
- messagestringrequired
Error codesinvalid_requestunauthorizednot_foundrevision_requiredrevision_mismatchunsupported_selectorqueue_too_largequeue_buildingidempotency_key_requiredidempotency_key_reusedtimeoutdatabase_busywriter_capacity
Example request
curl -X POST "http://127.0.0.1:32500/v1/queues/{id}:save-as-playlist" \
-H "Authorization: Bearer $PORTICO_API_KEY" \
-H "Content-Type: application/json" \
-d '{"name":"Fargo","summary":"string"}'POST/v1/queues/{id}/batchPlay a mixed selection next or later in its source orderplayback
- Audience
- Clients · Native API
- Authorization
- API key or personal access token with the playback scope, or a signed-in session
- OpenAPI operation ID
batch_queue- Max body
- 32 KiB
Parameters
| Name | In | Type | Description |
|---|---|---|---|
idrequired | path | string |
Request body application/json · required
Example
{
"placement": "string",
"source": {
"container": {
"id": "id_8h2k4q",
"kind": "string"
}
}
}Schema
- placementstringrequired
sourceobjectrequired
containerobjectrequired
- idstringrequired
- kindstringrequired
Responses
200Successapplication/json
Example
{
"queue": {
"current": {
"entryId": "id_8h2k4q",
"position": 0
},
"durationKnown": true,
"id": "id_8h2k4q",
"next": {
"available": true,
"entryId": "id_8h2k4q",
"reason": "string"
},
"postPlay": {
"automaticAdvances": 0,
"autoplay": true,
"countdownMs": 1800000,
"passoutCheckDue": true,
"startDuringCredits": true
},
"remainingCount": 0,
"repeat": "2026-10-18T19:30:00Z",
"revision": "r12",
"segmentCount": 0,
"segments": [
{
"count": 0,
"id": "id_8h2k4q",
"kind": "string",
"label": "string",
"sourceRevision": "r12",
"state": "string"
}
],
"shuffle": {
"lap": 0,
"seed": "string"
},
"total": 0,
"totalDurationMs": 1800000
},
"session": {
"channelId": "id_8h2k4q",
"control": {
"revision": "r12",
"state": "string"
},
"discTitle": {
"id": "id_8h2k4q",
"revision": "r12"
},
"end": {
"message": "string",
"reason": "string"
},
"id": "id_8h2k4q",
"itemId": "id_8h2k4q",
"kind": "string",
"lease": {
"expiresAt": "2026-10-18T19:30:00Z",
"reportEveryMs": 1800000
},
"observedPlayback": {
"audio": {
"bitDepth": 0,
"channels": 0,
"codec": "string",
"handling": "string",
"layout": "string",
"objectAudio": "string",
"sampleRate": 0
},
"deliveredBitrateKbps": 0,
"screen": {
"dynamicRange": "string",
"refreshRateHz": 0
},
"subtitles": {
"rendering": "string"
},
"video": {
"bitDepth": 0,
"dynamicRange": "string",
"frameRateHz": 0,
"height": 0,
"width": 0
}
},
"playbackInfo": {
"basis": "committed_delivery_plan",
"delivered": {
"audio": {
"bitDepth": 0,
"channels": 0,
"codec": "string",
"delivery": "string",
"layout": "string",
"lossless": true,
"objectAudio": "string",
"profile": "string",
"sampleRate": 0,
"variant": "string"
},
"subtitles": {
"format": "2026-10-18T19:30:00Z",
"language": "en",
"origin": "string",
"rendering": "string",
"title": "Fargo"
},
"video": {
"bitDepth": 0,
"chromaSubsampling": "string",
"codec": "string",
"container": "string",
"conversion": {},
"dolbyVisionBaseLayer": true,
"dolbyVisionCmVersion": "string",
"dolbyVisionCompatibility": 0,
"dolbyVisionEnhancementType": "string",
"dolbyVisionProfile": 0,
"dolbyVisionRpu": true,
"dynamicRange": "string",
"frameRate": 0,
"frameRateDenominator": 0,
"frameRateMode": "string",
"frameRateNumerator": 0,
"hdr10Plus": true,
"height": 0,
"interlaced": true,
"masterDisplay": "string",
"maxCll": "string",
"profile": "string",
"width": 0
}
},
"estimatedBitrateKbps": 0,
"losses": [
{
"feature": "string",
"replacement": {}
}
],
"network": "string",
"reason": {
"audioCodec": "string",
"container": "string",
"kind": "string",
"maxBitrateKbps": 0,
"maxHeight": 0,
"videoCodec": "string"
},
"route": "string",
"routes": {
"picture": "string",
"sound": "string",
"subtitles": "Fargo"
},
"source": {
"audio": {
"bitDepth": 0,
"channels": 0,
"codec": "string",
"delivery": "string",
"layout": "string",
"lossless": true,
"objectAudio": "string",
"profile": "string",
"sampleRate": 0,
"variant": "string"
},
"subtitles": {
"format": "2026-10-18T19:30:00Z",
"language": "en",
"origin": "string",
"rendering": "string",
"title": "Fargo"
},
"video": {
"bitDepth": 0,
"chromaSubsampling": "string",
"codec": "string",
"container": "string",
"conversion": {},
"dolbyVisionBaseLayer": true,
"dolbyVisionCmVersion": "string",
"dolbyVisionCompatibility": 0,
"dolbyVisionEnhancementType": "string",
"dolbyVisionProfile": 0,
"dolbyVisionRpu": true,
"dynamicRange": "string",
"frameRate": 0,
"frameRateDenominator": 0,
"frameRateMode": "string",
"frameRateNumerator": 0,
"hdr10Plus": true,
"height": 0,
"interlaced": true,
"masterDisplay": "string",
"maxCll": "string",
"profile": "string",
"width": 0
}
}
},
"presentation": {
"audioRender": {
"bitDepth": 0,
"bytes": 0,
"channels": 0,
"codec": "string",
"container": "string",
"conversionGainDb": 0,
"decoderConfig": "string",
"downmixed": true,
"durationFrames": 0,
"gain": {
"albumDb": 0,
"albumPeak": 0,
"source": "string",
"trackDb": 0,
"trackPeak": 0
},
"id": "id_8h2k4q",
"loudnessAppliedDb": 0,
"loudnessEnvelope": {
"endLufs": [],
"intervalMs": 1800000,
"startLufs": []
},
"mode": "string",
"prefetchBytes": 0,
"reason": "string",
"sampleRate": 0,
"seekIndex": {
"url": "https://example.com/…"
},
"sourceBitrateBps": 0,
"trim": {
"endFrames": 0,
"source": "string",
"startFrames": 0
},
"url": "https://example.com/…",
"version": 0
},
"audioTrackId": "id_8h2k4q",
"bitrateKbps": 0,
"choiceRevision": 0,
"container": "string",
"decision": {
"audio": {
"action": "string",
"channels": 0,
"reasons": [],
"to": "string"
},
"subtitles": {
"action": "string",
"channels": 0,
"reasons": [],
"to": "string"
},
"video": {
"action": "string",
"channels": 0,
"reasons": [],
"to": "string"
}
},
"engine": "string",
"generation": 0,
"linear": {
"clocks": [
{}
],
"confirmedPositionMs": 1800000,
"errorCode": "string",
"liveEdgeMs": 1800000,
"name": "Fargo",
"next": {
"endMs": 1800000,
"id": "id_8h2k4q",
"itemId": "id_8h2k4q",
"startMs": 1800000,
"title": "Fargo"
},
"nowMs": 1800000,
"originMs": 1800000,
"programme": {
"endMs": 1800000,
"id": "id_8h2k4q",
"itemId": "id_8h2k4q",
"startMs": 1800000,
"title": "Fargo"
},
"reservationRequiredAtMs": 1800000,
"seek": {
"acknowledged": true,
"error": "string",
"id": "id_8h2k4q",
"live": true,
"positionMs": 1800000
},
"state": "string",
"windowEndMs": 1800000,
"windowStartMs": 1800000
},
"mode": "string",
"quality": {
"id": "id_8h2k4q",
"maxAudioBitrateKbps": 0,
"maxHeight": 0,
"maxVideoBitrateKbps": 0,
"mode": "string",
"step": "string"
},
"seekId": "id_8h2k4q",
"startPositionMs": 1800000,
"subtitle": {
"delivery": "string",
"kind": "string",
"trackId": "id_8h2k4q"
},
"subtitles": [
{
"companionUrl": "https://example.com/…",
"fontsUrl": "https://example.com/…",
"format": "2026-10-18T19:30:00Z",
"linesUrl": "https://example.com/…",
"offsetMs": 1800000,
"timeDomain": "2026-10-18T19:30:00Z",
"trackId": "id_8h2k4q",
"url": "https://example.com/…"
}
],
"url": "https://example.com/…",
"videoHeight": 0
},
"queue": {
"entryId": "id_8h2k4q",
"queueId": "id_8h2k4q"
},
"retryAfterMs": 1800000,
"revision": "r12",
"role": "string",
"state": "string",
"versionId": "id_8h2k4q"
},
"window": [
{
"album": "string",
"albumId": "id_8h2k4q",
"artist": "string",
"artistId": "id_8h2k4q",
"available": true,
"backdropUrl": "https://example.com/…",
"disc": 0,
"durationMs": 1800000,
"entryId": "id_8h2k4q",
"episode": {
"number": 0,
"seasonNumber": 0
},
"itemId": "id_8h2k4q",
"kind": "string",
"libraryId": "id_8h2k4q",
"position": 0,
"posterUrl": "https://example.com/…",
"seasonId": "id_8h2k4q",
"segmentId": "id_8h2k4q",
"showId": "id_8h2k4q",
"stillUrl": "https://example.com/…",
"title": "Fargo",
"track": 0
}
]
}Schema
queueobjectrequired
currentobject
- entryIdstringrequired
- positionintegerrequired
- durationKnownbooleanrequired
- idstringrequired
nextobject
- availablebooleanrequired
- entryIdstring
- reasonstringrequired
postPlayobject
- automaticAdvancesintegerrequired
- autoplaybooleanrequired
- countdownMsintegerrequired
- passoutCheckDuebooleanrequired
- startDuringCreditsbooleanrequired
- remainingCountintegerrequired
- repeatstringrequired
- revisionstringrequired
- segmentCountintegerrequired
segmentsarray of objectrequired
- countintegerrequired
- idstringrequired
- kindstringrequired
- labelstringrequired
- sourceRevisionstring
- statestringrequired
shuffleobject
- lapintegerrequired
- seedstringrequired
- totalintegerrequired
- totalDurationMsinteger
sessionobject
- channelIdstring
controlobject
- revisionstringrequired
- statestringrequired
discTitleobject
- idstringrequired
- revisionstringrequired
endobject
- messagestring
- reasonstringrequired
- idstringrequired
- itemIdstring
- kindstringrequired
leaseobjectrequired
- expiresAtstringrequired
- reportEveryMsintegerrequired
observedPlaybackobject
audioobject
- bitDepthinteger
- channelsinteger
- codecstring
- handlingstring
- layoutstring
- objectAudiostring
- sampleRateinteger
- deliveredBitrateKbpsinteger
screenobject
- dynamicRangestring
- refreshRateHznumber
subtitlesobject
- renderingstringrequired
videoobject
- bitDepthinteger
- dynamicRangestring
- frameRateHznumber
- heightinteger
- widthinteger
playbackInfoobject
- basisstringrequiredone of "committed_delivery_plan"
deliveredobjectrequired
audioobject
- bitDepthinteger
- channelsinteger
- codecstringrequired
- deliverystring
- layoutstring
- losslessboolean
- objectAudiostring
- profilestring
- sampleRateinteger
- variantstring
subtitlesobject
- formatstring
- languagestring
- originstring
- renderingstring
- titlestring
videoobject
- bitDepthinteger
- chromaSubsamplingstring
- codecstringrequired
- containerstring
conversionobject
- enhancementDiscardedbooleanrequired
- felResidualDiscardedbooleanrequired
- kindstringrequired
- sourceDolbyVisionProfileintegerrequired
- sourceEnhancementTypestring
- dolbyVisionBaseLayerboolean
- dolbyVisionCmVersionstring
- dolbyVisionCompatibilityinteger
- dolbyVisionEnhancementTypestring
- dolbyVisionProfileinteger
- dolbyVisionRpuboolean
- dynamicRangestring
- frameRatenumber
- frameRateDenominatorinteger
- frameRateModestring
- frameRateNumeratorinteger
- hdr10Plusboolean
- heightinteger
- interlacedboolean
- masterDisplaystring
- maxCllstring
- profilestring
- widthinteger
- estimatedBitrateKbpsinteger
lossesarray of objectrequired
- featurestringrequired
replacementobjectrequired
- audioCodecstring
- channelsinteger
- dynamicRangestring
- layoutstring
- networkstringrequired
reasonobjectrequired
- audioCodecstring
- containerstring
- kindstringrequired
- maxBitrateKbpsinteger
- maxHeightinteger
- videoCodecstring
- routestringrequired
routesobjectrequired
- picturestring
- soundstring
- subtitlesstring
sourceobjectrequired
audioobject
- bitDepthinteger
- channelsinteger
- codecstringrequired
- deliverystring
- layoutstring
- losslessboolean
- objectAudiostring
- profilestring
- sampleRateinteger
- variantstring
subtitlesobject
- formatstring
- languagestring
- originstring
- renderingstring
- titlestring
videoobject
- bitDepthinteger
- chromaSubsamplingstring
- codecstringrequired
- containerstring
conversionobject
- enhancementDiscardedbooleanrequired
- felResidualDiscardedbooleanrequired
- kindstringrequired
- sourceDolbyVisionProfileintegerrequired
- sourceEnhancementTypestring
- dolbyVisionBaseLayerboolean
- dolbyVisionCmVersionstring
- dolbyVisionCompatibilityinteger
- dolbyVisionEnhancementTypestring
- dolbyVisionProfileinteger
- dolbyVisionRpuboolean
- dynamicRangestring
- frameRatenumber
- frameRateDenominatorinteger
- frameRateModestring
- frameRateNumeratorinteger
- hdr10Plusboolean
- heightinteger
- interlacedboolean
- masterDisplaystring
- maxCllstring
- profilestring
- widthinteger
presentationobjectrequired
audioRenderobject
- bitDepthinteger
- bytesinteger
- channelsinteger
- codecstring
- containerstring
- conversionGainDbnumber
- decoderConfigstring
- downmixedboolean
- durationFramesinteger
gainobject
- albumDbnumber
- albumPeaknumber
- sourcestringrequired
- trackDbnumber
- trackPeaknumber
- idstringrequired
- loudnessAppliedDbnumber
loudnessEnvelopeobject
- endLufsarray of numberrequired
- intervalMsintegerrequired
- startLufsarray of numberrequired
- modestringrequired
- prefetchBytesinteger
- reasonstring
- sampleRateinteger
seekIndexobject
- urlstringrequired
- sourceBitrateBpsinteger
trimobject
- endFramesintegerrequired
- sourcestringrequired
- startFramesintegerrequired
- urlstring
- versionintegerrequired
- audioTrackIdstring
- bitrateKbpsinteger
- choiceRevisioninteger
- containerstring
decisionobjectrequired
audioobject
- actionstringrequired
- channelsinteger
- reasonsarray of stringrequired
- tostring
subtitlesobject
- actionstringrequired
- channelsinteger
- reasonsarray of stringrequired
- tostring
videoobject
- actionstringrequired
- channelsinteger
- reasonsarray of stringrequired
- tostring
- enginestringrequired
- generationintegerrequired
linearobject
clocksarray of object
- endMsintegerrequired
- offsetMsintegerrequired
- startMsintegerrequired
- confirmedPositionMsinteger
- errorCodestring
- liveEdgeMsintegerrequired
- namestringrequired
nextobject
- endMsintegerrequired
- idstringrequired
- itemIdstring
- startMsintegerrequired
- titlestringrequired
- nowMsinteger
- originMsintegerrequired
programmeobject
- endMsintegerrequired
- idstringrequired
- itemIdstring
- startMsintegerrequired
- titlestringrequired
- reservationRequiredAtMsinteger
seekobject
- acknowledgedbooleanrequired
- errorstring
- idstringrequired
- liveboolean
- positionMsinteger
- statestringrequired
- windowEndMsintegerrequired
- windowStartMsintegerrequired
- modestringrequired
qualityobject
- idstring
- maxAudioBitrateKbpsinteger
- maxHeightinteger
- maxVideoBitrateKbpsinteger
- modestringrequired
- stepstring
- seekIdstring
- startPositionMsintegerrequired
subtitleobject
- deliverystringrequired
- kindstringrequired
- trackIdstringrequired
subtitlesarray of objectrequired
- companionUrlstring
- fontsUrlstring
- formatstringrequired
- linesUrlstring
- offsetMsintegerrequired
- timeDomainstringrequired
- trackIdstringrequired
- urlstringrequired
- urlstringrequired
- videoHeightinteger
queueobject
- entryIdstringrequired
- queueIdstringrequired
- retryAfterMsinteger
- revisionstringrequired
- rolestringrequired
- statestringrequired
- versionIdstring
windowarray of object
- albumstring
- albumIdstring
- artiststring
- artistIdstring
- availablebooleanrequired
- backdropUrlstring
- discinteger
- durationMsinteger
- entryIdstringrequired
episodeobject
- numberintegerrequired
- seasonNumberintegerrequired
- itemIdstringrequired
- kindstringrequired
- libraryIdstring
- positionintegerrequired
- posterUrlstring
- seasonIdstring
- segmentIdstringrequired
- showIdstring
- stillUrlstring
- titlestringrequired
- trackinteger
defaultRequest refused or unavailableapplication/json
Example
{
"error": {
"code": "string",
"message": "string"
}
}Schema
errorobjectrequired
- codestringrequired
- messagestringrequired
Error codesinvalid_requestunauthorizednot_foundrevision_requiredrevision_mismatchunsupported_selectorqueue_too_largequeue_buildingtimeoutdatabase_busywriter_capacity
Example request
curl -X POST "http://127.0.0.1:32500/v1/queues/{id}/batch" \
-H "Authorization: Bearer $PORTICO_API_KEY" \
-H "Content-Type: application/json" \
-d '{"placement":"string","source":{"container":{"id":"id_8h2k4q","kind":"string"}}}'GET/v1/queues/{id}/entriesRead a page of entries from a position (at most 200)read
- Audience
- Clients · Native API
- Authorization
- API key or personal access token with the read scope, or a signed-in session
- OpenAPI operation ID
list_queue_entries
Parameters
| Name | In | Type | Description |
|---|---|---|---|
idrequired | path | string | |
from | query | string | |
limit | query | integer | ""1–200 | |
cursor | query | string |
Responses
200Successapplication/json
Example
{
"items": [
{
"album": "string",
"albumId": "id_8h2k4q",
"artist": "string",
"artistId": "id_8h2k4q",
"available": true,
"backdropUrl": "https://example.com/…",
"disc": 0,
"durationMs": 1800000,
"entryId": "id_8h2k4q",
"episode": {
"number": 0,
"seasonNumber": 0
},
"itemId": "id_8h2k4q",
"kind": "string",
"libraryId": "id_8h2k4q",
"position": 0,
"posterUrl": "https://example.com/…",
"seasonId": "id_8h2k4q",
"segmentId": "id_8h2k4q",
"showId": "id_8h2k4q",
"stillUrl": "https://example.com/…",
"title": "Fargo",
"track": 0
}
],
"page": {
"limit": 0,
"nextCursor": "eyJvIjoyMH0",
"revision": "r12",
"start": 0,
"total": 0
}
}Schema
itemsarray of objectrequired
- albumstring
- albumIdstring
- artiststring
- artistIdstring
- availablebooleanrequired
- backdropUrlstring
- discinteger
- durationMsinteger
- entryIdstringrequired
episodeobject
- numberintegerrequired
- seasonNumberintegerrequired
- itemIdstringrequired
- kindstringrequired
- libraryIdstring
- positionintegerrequired
- posterUrlstring
- seasonIdstring
- segmentIdstringrequired
- showIdstring
- stillUrlstring
- titlestringrequired
- trackinteger
pageobjectrequired
- limitintegerrequired
- nextCursorstring
- revisionstringrequired
- startintegerrequired
- totalintegerrequired
defaultRequest refused or unavailableapplication/json
Example
{
"error": {
"code": "string",
"message": "string"
}
}Schema
errorobjectrequired
- codestringrequired
- messagestringrequired
Error codesinvalid_requestunauthorizednot_foundrevision_mismatchtimeoutdatabase_busy
Example request
curl -X GET "http://127.0.0.1:32500/v1/queues/{id}/entries" \
-H "Authorization: Bearer $PORTICO_API_KEY"DELETE/v1/queues/{id}/entries/{entryId}Remove one entryplayback
- Audience
- Clients · Native API
- Authorization
- API key or personal access token with the playback scope, or a signed-in session
- OpenAPI operation ID
remove_queue_entry
Parameters
| Name | In | Type | Description |
|---|---|---|---|
idrequired | path | string | |
entryIdrequired | path | string |
Responses
200Successapplication/json
Example
{
"queue": {
"current": {
"entryId": "id_8h2k4q",
"position": 0
},
"durationKnown": true,
"id": "id_8h2k4q",
"next": {
"available": true,
"entryId": "id_8h2k4q",
"reason": "string"
},
"postPlay": {
"automaticAdvances": 0,
"autoplay": true,
"countdownMs": 1800000,
"passoutCheckDue": true,
"startDuringCredits": true
},
"remainingCount": 0,
"repeat": "2026-10-18T19:30:00Z",
"revision": "r12",
"segmentCount": 0,
"segments": [
{
"count": 0,
"id": "id_8h2k4q",
"kind": "string",
"label": "string",
"sourceRevision": "r12",
"state": "string"
}
],
"shuffle": {
"lap": 0,
"seed": "string"
},
"total": 0,
"totalDurationMs": 1800000
},
"session": {
"channelId": "id_8h2k4q",
"control": {
"revision": "r12",
"state": "string"
},
"discTitle": {
"id": "id_8h2k4q",
"revision": "r12"
},
"end": {
"message": "string",
"reason": "string"
},
"id": "id_8h2k4q",
"itemId": "id_8h2k4q",
"kind": "string",
"lease": {
"expiresAt": "2026-10-18T19:30:00Z",
"reportEveryMs": 1800000
},
"observedPlayback": {
"audio": {
"bitDepth": 0,
"channels": 0,
"codec": "string",
"handling": "string",
"layout": "string",
"objectAudio": "string",
"sampleRate": 0
},
"deliveredBitrateKbps": 0,
"screen": {
"dynamicRange": "string",
"refreshRateHz": 0
},
"subtitles": {
"rendering": "string"
},
"video": {
"bitDepth": 0,
"dynamicRange": "string",
"frameRateHz": 0,
"height": 0,
"width": 0
}
},
"playbackInfo": {
"basis": "committed_delivery_plan",
"delivered": {
"audio": {
"bitDepth": 0,
"channels": 0,
"codec": "string",
"delivery": "string",
"layout": "string",
"lossless": true,
"objectAudio": "string",
"profile": "string",
"sampleRate": 0,
"variant": "string"
},
"subtitles": {
"format": "2026-10-18T19:30:00Z",
"language": "en",
"origin": "string",
"rendering": "string",
"title": "Fargo"
},
"video": {
"bitDepth": 0,
"chromaSubsampling": "string",
"codec": "string",
"container": "string",
"conversion": {},
"dolbyVisionBaseLayer": true,
"dolbyVisionCmVersion": "string",
"dolbyVisionCompatibility": 0,
"dolbyVisionEnhancementType": "string",
"dolbyVisionProfile": 0,
"dolbyVisionRpu": true,
"dynamicRange": "string",
"frameRate": 0,
"frameRateDenominator": 0,
"frameRateMode": "string",
"frameRateNumerator": 0,
"hdr10Plus": true,
"height": 0,
"interlaced": true,
"masterDisplay": "string",
"maxCll": "string",
"profile": "string",
"width": 0
}
},
"estimatedBitrateKbps": 0,
"losses": [
{
"feature": "string",
"replacement": {}
}
],
"network": "string",
"reason": {
"audioCodec": "string",
"container": "string",
"kind": "string",
"maxBitrateKbps": 0,
"maxHeight": 0,
"videoCodec": "string"
},
"route": "string",
"routes": {
"picture": "string",
"sound": "string",
"subtitles": "Fargo"
},
"source": {
"audio": {
"bitDepth": 0,
"channels": 0,
"codec": "string",
"delivery": "string",
"layout": "string",
"lossless": true,
"objectAudio": "string",
"profile": "string",
"sampleRate": 0,
"variant": "string"
},
"subtitles": {
"format": "2026-10-18T19:30:00Z",
"language": "en",
"origin": "string",
"rendering": "string",
"title": "Fargo"
},
"video": {
"bitDepth": 0,
"chromaSubsampling": "string",
"codec": "string",
"container": "string",
"conversion": {},
"dolbyVisionBaseLayer": true,
"dolbyVisionCmVersion": "string",
"dolbyVisionCompatibility": 0,
"dolbyVisionEnhancementType": "string",
"dolbyVisionProfile": 0,
"dolbyVisionRpu": true,
"dynamicRange": "string",
"frameRate": 0,
"frameRateDenominator": 0,
"frameRateMode": "string",
"frameRateNumerator": 0,
"hdr10Plus": true,
"height": 0,
"interlaced": true,
"masterDisplay": "string",
"maxCll": "string",
"profile": "string",
"width": 0
}
}
},
"presentation": {
"audioRender": {
"bitDepth": 0,
"bytes": 0,
"channels": 0,
"codec": "string",
"container": "string",
"conversionGainDb": 0,
"decoderConfig": "string",
"downmixed": true,
"durationFrames": 0,
"gain": {
"albumDb": 0,
"albumPeak": 0,
"source": "string",
"trackDb": 0,
"trackPeak": 0
},
"id": "id_8h2k4q",
"loudnessAppliedDb": 0,
"loudnessEnvelope": {
"endLufs": [],
"intervalMs": 1800000,
"startLufs": []
},
"mode": "string",
"prefetchBytes": 0,
"reason": "string",
"sampleRate": 0,
"seekIndex": {
"url": "https://example.com/…"
},
"sourceBitrateBps": 0,
"trim": {
"endFrames": 0,
"source": "string",
"startFrames": 0
},
"url": "https://example.com/…",
"version": 0
},
"audioTrackId": "id_8h2k4q",
"bitrateKbps": 0,
"choiceRevision": 0,
"container": "string",
"decision": {
"audio": {
"action": "string",
"channels": 0,
"reasons": [],
"to": "string"
},
"subtitles": {
"action": "string",
"channels": 0,
"reasons": [],
"to": "string"
},
"video": {
"action": "string",
"channels": 0,
"reasons": [],
"to": "string"
}
},
"engine": "string",
"generation": 0,
"linear": {
"clocks": [
{}
],
"confirmedPositionMs": 1800000,
"errorCode": "string",
"liveEdgeMs": 1800000,
"name": "Fargo",
"next": {
"endMs": 1800000,
"id": "id_8h2k4q",
"itemId": "id_8h2k4q",
"startMs": 1800000,
"title": "Fargo"
},
"nowMs": 1800000,
"originMs": 1800000,
"programme": {
"endMs": 1800000,
"id": "id_8h2k4q",
"itemId": "id_8h2k4q",
"startMs": 1800000,
"title": "Fargo"
},
"reservationRequiredAtMs": 1800000,
"seek": {
"acknowledged": true,
"error": "string",
"id": "id_8h2k4q",
"live": true,
"positionMs": 1800000
},
"state": "string",
"windowEndMs": 1800000,
"windowStartMs": 1800000
},
"mode": "string",
"quality": {
"id": "id_8h2k4q",
"maxAudioBitrateKbps": 0,
"maxHeight": 0,
"maxVideoBitrateKbps": 0,
"mode": "string",
"step": "string"
},
"seekId": "id_8h2k4q",
"startPositionMs": 1800000,
"subtitle": {
"delivery": "string",
"kind": "string",
"trackId": "id_8h2k4q"
},
"subtitles": [
{
"companionUrl": "https://example.com/…",
"fontsUrl": "https://example.com/…",
"format": "2026-10-18T19:30:00Z",
"linesUrl": "https://example.com/…",
"offsetMs": 1800000,
"timeDomain": "2026-10-18T19:30:00Z",
"trackId": "id_8h2k4q",
"url": "https://example.com/…"
}
],
"url": "https://example.com/…",
"videoHeight": 0
},
"queue": {
"entryId": "id_8h2k4q",
"queueId": "id_8h2k4q"
},
"retryAfterMs": 1800000,
"revision": "r12",
"role": "string",
"state": "string",
"versionId": "id_8h2k4q"
},
"window": [
{
"album": "string",
"albumId": "id_8h2k4q",
"artist": "string",
"artistId": "id_8h2k4q",
"available": true,
"backdropUrl": "https://example.com/…",
"disc": 0,
"durationMs": 1800000,
"entryId": "id_8h2k4q",
"episode": {
"number": 0,
"seasonNumber": 0
},
"itemId": "id_8h2k4q",
"kind": "string",
"libraryId": "id_8h2k4q",
"position": 0,
"posterUrl": "https://example.com/…",
"seasonId": "id_8h2k4q",
"segmentId": "id_8h2k4q",
"showId": "id_8h2k4q",
"stillUrl": "https://example.com/…",
"title": "Fargo",
"track": 0
}
]
}Schema
queueobjectrequired
currentobject
- entryIdstringrequired
- positionintegerrequired
- durationKnownbooleanrequired
- idstringrequired
nextobject
- availablebooleanrequired
- entryIdstring
- reasonstringrequired
postPlayobject
- automaticAdvancesintegerrequired
- autoplaybooleanrequired
- countdownMsintegerrequired
- passoutCheckDuebooleanrequired
- startDuringCreditsbooleanrequired
- remainingCountintegerrequired
- repeatstringrequired
- revisionstringrequired
- segmentCountintegerrequired
segmentsarray of objectrequired
- countintegerrequired
- idstringrequired
- kindstringrequired
- labelstringrequired
- sourceRevisionstring
- statestringrequired
shuffleobject
- lapintegerrequired
- seedstringrequired
- totalintegerrequired
- totalDurationMsinteger
sessionobject
- channelIdstring
controlobject
- revisionstringrequired
- statestringrequired
discTitleobject
- idstringrequired
- revisionstringrequired
endobject
- messagestring
- reasonstringrequired
- idstringrequired
- itemIdstring
- kindstringrequired
leaseobjectrequired
- expiresAtstringrequired
- reportEveryMsintegerrequired
observedPlaybackobject
audioobject
- bitDepthinteger
- channelsinteger
- codecstring
- handlingstring
- layoutstring
- objectAudiostring
- sampleRateinteger
- deliveredBitrateKbpsinteger
screenobject
- dynamicRangestring
- refreshRateHznumber
subtitlesobject
- renderingstringrequired
videoobject
- bitDepthinteger
- dynamicRangestring
- frameRateHznumber
- heightinteger
- widthinteger
playbackInfoobject
- basisstringrequiredone of "committed_delivery_plan"
deliveredobjectrequired
audioobject
- bitDepthinteger
- channelsinteger
- codecstringrequired
- deliverystring
- layoutstring
- losslessboolean
- objectAudiostring
- profilestring
- sampleRateinteger
- variantstring
subtitlesobject
- formatstring
- languagestring
- originstring
- renderingstring
- titlestring
videoobject
- bitDepthinteger
- chromaSubsamplingstring
- codecstringrequired
- containerstring
conversionobject
- enhancementDiscardedbooleanrequired
- felResidualDiscardedbooleanrequired
- kindstringrequired
- sourceDolbyVisionProfileintegerrequired
- sourceEnhancementTypestring
- dolbyVisionBaseLayerboolean
- dolbyVisionCmVersionstring
- dolbyVisionCompatibilityinteger
- dolbyVisionEnhancementTypestring
- dolbyVisionProfileinteger
- dolbyVisionRpuboolean
- dynamicRangestring
- frameRatenumber
- frameRateDenominatorinteger
- frameRateModestring
- frameRateNumeratorinteger
- hdr10Plusboolean
- heightinteger
- interlacedboolean
- masterDisplaystring
- maxCllstring
- profilestring
- widthinteger
- estimatedBitrateKbpsinteger
lossesarray of objectrequired
- featurestringrequired
replacementobjectrequired
- audioCodecstring
- channelsinteger
- dynamicRangestring
- layoutstring
- networkstringrequired
reasonobjectrequired
- audioCodecstring
- containerstring
- kindstringrequired
- maxBitrateKbpsinteger
- maxHeightinteger
- videoCodecstring
- routestringrequired
routesobjectrequired
- picturestring
- soundstring
- subtitlesstring
sourceobjectrequired
audioobject
- bitDepthinteger
- channelsinteger
- codecstringrequired
- deliverystring
- layoutstring
- losslessboolean
- objectAudiostring
- profilestring
- sampleRateinteger
- variantstring
subtitlesobject
- formatstring
- languagestring
- originstring
- renderingstring
- titlestring
videoobject
- bitDepthinteger
- chromaSubsamplingstring
- codecstringrequired
- containerstring
conversionobject
- enhancementDiscardedbooleanrequired
- felResidualDiscardedbooleanrequired
- kindstringrequired
- sourceDolbyVisionProfileintegerrequired
- sourceEnhancementTypestring
- dolbyVisionBaseLayerboolean
- dolbyVisionCmVersionstring
- dolbyVisionCompatibilityinteger
- dolbyVisionEnhancementTypestring
- dolbyVisionProfileinteger
- dolbyVisionRpuboolean
- dynamicRangestring
- frameRatenumber
- frameRateDenominatorinteger
- frameRateModestring
- frameRateNumeratorinteger
- hdr10Plusboolean
- heightinteger
- interlacedboolean
- masterDisplaystring
- maxCllstring
- profilestring
- widthinteger
presentationobjectrequired
audioRenderobject
- bitDepthinteger
- bytesinteger
- channelsinteger
- codecstring
- containerstring
- conversionGainDbnumber
- decoderConfigstring
- downmixedboolean
- durationFramesinteger
gainobject
- albumDbnumber
- albumPeaknumber
- sourcestringrequired
- trackDbnumber
- trackPeaknumber
- idstringrequired
- loudnessAppliedDbnumber
loudnessEnvelopeobject
- endLufsarray of numberrequired
- intervalMsintegerrequired
- startLufsarray of numberrequired
- modestringrequired
- prefetchBytesinteger
- reasonstring
- sampleRateinteger
seekIndexobject
- urlstringrequired
- sourceBitrateBpsinteger
trimobject
- endFramesintegerrequired
- sourcestringrequired
- startFramesintegerrequired
- urlstring
- versionintegerrequired
- audioTrackIdstring
- bitrateKbpsinteger
- choiceRevisioninteger
- containerstring
decisionobjectrequired
audioobject
- actionstringrequired
- channelsinteger
- reasonsarray of stringrequired
- tostring
subtitlesobject
- actionstringrequired
- channelsinteger
- reasonsarray of stringrequired
- tostring
videoobject
- actionstringrequired
- channelsinteger
- reasonsarray of stringrequired
- tostring
- enginestringrequired
- generationintegerrequired
linearobject
clocksarray of object
- endMsintegerrequired
- offsetMsintegerrequired
- startMsintegerrequired
- confirmedPositionMsinteger
- errorCodestring
- liveEdgeMsintegerrequired
- namestringrequired
nextobject
- endMsintegerrequired
- idstringrequired
- itemIdstring
- startMsintegerrequired
- titlestringrequired
- nowMsinteger
- originMsintegerrequired
programmeobject
- endMsintegerrequired
- idstringrequired
- itemIdstring
- startMsintegerrequired
- titlestringrequired
- reservationRequiredAtMsinteger
seekobject
- acknowledgedbooleanrequired
- errorstring
- idstringrequired
- liveboolean
- positionMsinteger
- statestringrequired
- windowEndMsintegerrequired
- windowStartMsintegerrequired
- modestringrequired
qualityobject
- idstring
- maxAudioBitrateKbpsinteger
- maxHeightinteger
- maxVideoBitrateKbpsinteger
- modestringrequired
- stepstring
- seekIdstring
- startPositionMsintegerrequired
subtitleobject
- deliverystringrequired
- kindstringrequired
- trackIdstringrequired
subtitlesarray of objectrequired
- companionUrlstring
- fontsUrlstring
- formatstringrequired
- linesUrlstring
- offsetMsintegerrequired
- timeDomainstringrequired
- trackIdstringrequired
- urlstringrequired
- urlstringrequired
- videoHeightinteger
queueobject
- entryIdstringrequired
- queueIdstringrequired
- retryAfterMsinteger
- revisionstringrequired
- rolestringrequired
- statestringrequired
- versionIdstring
windowarray of object
- albumstring
- albumIdstring
- artiststring
- artistIdstring
- availablebooleanrequired
- backdropUrlstring
- discinteger
- durationMsinteger
- entryIdstringrequired
episodeobject
- numberintegerrequired
- seasonNumberintegerrequired
- itemIdstringrequired
- kindstringrequired
- libraryIdstring
- positionintegerrequired
- posterUrlstring
- seasonIdstring
- segmentIdstringrequired
- showIdstring
- stillUrlstring
- titlestringrequired
- trackinteger
defaultRequest refused or unavailableapplication/json
Example
{
"error": {
"code": "string",
"message": "string"
}
}Schema
errorobjectrequired
- codestringrequired
- messagestringrequired
Error codesinvalid_requestunauthorizednot_foundrevision_requiredrevision_mismatchunsupported_selectorqueue_too_largequeue_buildingtimeoutdatabase_busywriter_capacity
Example request
curl -X DELETE "http://127.0.0.1:32500/v1/queues/{id}/entries/{entryId}" \
-H "Authorization: Bearer $PORTICO_API_KEY"POST/v1/queues/{id}/entries/{entryId}:moveMove one entry before or after anotherplayback
- Audience
- Clients · Native API
- Authorization
- API key or personal access token with the playback scope, or a signed-in session
- OpenAPI operation ID
move_queue_entry- Max body
- 1 KiB
Parameters
| Name | In | Type | Description |
|---|---|---|---|
idrequired | path | string | |
entryIdrequired | path | string |
Request body application/json · required
Example
{
"after": "string",
"before": "string"
}Schema
- afterstring
- beforestring
Responses
200Successapplication/json
Example
{
"queue": {
"current": {
"entryId": "id_8h2k4q",
"position": 0
},
"durationKnown": true,
"id": "id_8h2k4q",
"next": {
"available": true,
"entryId": "id_8h2k4q",
"reason": "string"
},
"postPlay": {
"automaticAdvances": 0,
"autoplay": true,
"countdownMs": 1800000,
"passoutCheckDue": true,
"startDuringCredits": true
},
"remainingCount": 0,
"repeat": "2026-10-18T19:30:00Z",
"revision": "r12",
"segmentCount": 0,
"segments": [
{
"count": 0,
"id": "id_8h2k4q",
"kind": "string",
"label": "string",
"sourceRevision": "r12",
"state": "string"
}
],
"shuffle": {
"lap": 0,
"seed": "string"
},
"total": 0,
"totalDurationMs": 1800000
},
"session": {
"channelId": "id_8h2k4q",
"control": {
"revision": "r12",
"state": "string"
},
"discTitle": {
"id": "id_8h2k4q",
"revision": "r12"
},
"end": {
"message": "string",
"reason": "string"
},
"id": "id_8h2k4q",
"itemId": "id_8h2k4q",
"kind": "string",
"lease": {
"expiresAt": "2026-10-18T19:30:00Z",
"reportEveryMs": 1800000
},
"observedPlayback": {
"audio": {
"bitDepth": 0,
"channels": 0,
"codec": "string",
"handling": "string",
"layout": "string",
"objectAudio": "string",
"sampleRate": 0
},
"deliveredBitrateKbps": 0,
"screen": {
"dynamicRange": "string",
"refreshRateHz": 0
},
"subtitles": {
"rendering": "string"
},
"video": {
"bitDepth": 0,
"dynamicRange": "string",
"frameRateHz": 0,
"height": 0,
"width": 0
}
},
"playbackInfo": {
"basis": "committed_delivery_plan",
"delivered": {
"audio": {
"bitDepth": 0,
"channels": 0,
"codec": "string",
"delivery": "string",
"layout": "string",
"lossless": true,
"objectAudio": "string",
"profile": "string",
"sampleRate": 0,
"variant": "string"
},
"subtitles": {
"format": "2026-10-18T19:30:00Z",
"language": "en",
"origin": "string",
"rendering": "string",
"title": "Fargo"
},
"video": {
"bitDepth": 0,
"chromaSubsampling": "string",
"codec": "string",
"container": "string",
"conversion": {},
"dolbyVisionBaseLayer": true,
"dolbyVisionCmVersion": "string",
"dolbyVisionCompatibility": 0,
"dolbyVisionEnhancementType": "string",
"dolbyVisionProfile": 0,
"dolbyVisionRpu": true,
"dynamicRange": "string",
"frameRate": 0,
"frameRateDenominator": 0,
"frameRateMode": "string",
"frameRateNumerator": 0,
"hdr10Plus": true,
"height": 0,
"interlaced": true,
"masterDisplay": "string",
"maxCll": "string",
"profile": "string",
"width": 0
}
},
"estimatedBitrateKbps": 0,
"losses": [
{
"feature": "string",
"replacement": {}
}
],
"network": "string",
"reason": {
"audioCodec": "string",
"container": "string",
"kind": "string",
"maxBitrateKbps": 0,
"maxHeight": 0,
"videoCodec": "string"
},
"route": "string",
"routes": {
"picture": "string",
"sound": "string",
"subtitles": "Fargo"
},
"source": {
"audio": {
"bitDepth": 0,
"channels": 0,
"codec": "string",
"delivery": "string",
"layout": "string",
"lossless": true,
"objectAudio": "string",
"profile": "string",
"sampleRate": 0,
"variant": "string"
},
"subtitles": {
"format": "2026-10-18T19:30:00Z",
"language": "en",
"origin": "string",
"rendering": "string",
"title": "Fargo"
},
"video": {
"bitDepth": 0,
"chromaSubsampling": "string",
"codec": "string",
"container": "string",
"conversion": {},
"dolbyVisionBaseLayer": true,
"dolbyVisionCmVersion": "string",
"dolbyVisionCompatibility": 0,
"dolbyVisionEnhancementType": "string",
"dolbyVisionProfile": 0,
"dolbyVisionRpu": true,
"dynamicRange": "string",
"frameRate": 0,
"frameRateDenominator": 0,
"frameRateMode": "string",
"frameRateNumerator": 0,
"hdr10Plus": true,
"height": 0,
"interlaced": true,
"masterDisplay": "string",
"maxCll": "string",
"profile": "string",
"width": 0
}
}
},
"presentation": {
"audioRender": {
"bitDepth": 0,
"bytes": 0,
"channels": 0,
"codec": "string",
"container": "string",
"conversionGainDb": 0,
"decoderConfig": "string",
"downmixed": true,
"durationFrames": 0,
"gain": {
"albumDb": 0,
"albumPeak": 0,
"source": "string",
"trackDb": 0,
"trackPeak": 0
},
"id": "id_8h2k4q",
"loudnessAppliedDb": 0,
"loudnessEnvelope": {
"endLufs": [],
"intervalMs": 1800000,
"startLufs": []
},
"mode": "string",
"prefetchBytes": 0,
"reason": "string",
"sampleRate": 0,
"seekIndex": {
"url": "https://example.com/…"
},
"sourceBitrateBps": 0,
"trim": {
"endFrames": 0,
"source": "string",
"startFrames": 0
},
"url": "https://example.com/…",
"version": 0
},
"audioTrackId": "id_8h2k4q",
"bitrateKbps": 0,
"choiceRevision": 0,
"container": "string",
"decision": {
"audio": {
"action": "string",
"channels": 0,
"reasons": [],
"to": "string"
},
"subtitles": {
"action": "string",
"channels": 0,
"reasons": [],
"to": "string"
},
"video": {
"action": "string",
"channels": 0,
"reasons": [],
"to": "string"
}
},
"engine": "string",
"generation": 0,
"linear": {
"clocks": [
{}
],
"confirmedPositionMs": 1800000,
"errorCode": "string",
"liveEdgeMs": 1800000,
"name": "Fargo",
"next": {
"endMs": 1800000,
"id": "id_8h2k4q",
"itemId": "id_8h2k4q",
"startMs": 1800000,
"title": "Fargo"
},
"nowMs": 1800000,
"originMs": 1800000,
"programme": {
"endMs": 1800000,
"id": "id_8h2k4q",
"itemId": "id_8h2k4q",
"startMs": 1800000,
"title": "Fargo"
},
"reservationRequiredAtMs": 1800000,
"seek": {
"acknowledged": true,
"error": "string",
"id": "id_8h2k4q",
"live": true,
"positionMs": 1800000
},
"state": "string",
"windowEndMs": 1800000,
"windowStartMs": 1800000
},
"mode": "string",
"quality": {
"id": "id_8h2k4q",
"maxAudioBitrateKbps": 0,
"maxHeight": 0,
"maxVideoBitrateKbps": 0,
"mode": "string",
"step": "string"
},
"seekId": "id_8h2k4q",
"startPositionMs": 1800000,
"subtitle": {
"delivery": "string",
"kind": "string",
"trackId": "id_8h2k4q"
},
"subtitles": [
{
"companionUrl": "https://example.com/…",
"fontsUrl": "https://example.com/…",
"format": "2026-10-18T19:30:00Z",
"linesUrl": "https://example.com/…",
"offsetMs": 1800000,
"timeDomain": "2026-10-18T19:30:00Z",
"trackId": "id_8h2k4q",
"url": "https://example.com/…"
}
],
"url": "https://example.com/…",
"videoHeight": 0
},
"queue": {
"entryId": "id_8h2k4q",
"queueId": "id_8h2k4q"
},
"retryAfterMs": 1800000,
"revision": "r12",
"role": "string",
"state": "string",
"versionId": "id_8h2k4q"
},
"window": [
{
"album": "string",
"albumId": "id_8h2k4q",
"artist": "string",
"artistId": "id_8h2k4q",
"available": true,
"backdropUrl": "https://example.com/…",
"disc": 0,
"durationMs": 1800000,
"entryId": "id_8h2k4q",
"episode": {
"number": 0,
"seasonNumber": 0
},
"itemId": "id_8h2k4q",
"kind": "string",
"libraryId": "id_8h2k4q",
"position": 0,
"posterUrl": "https://example.com/…",
"seasonId": "id_8h2k4q",
"segmentId": "id_8h2k4q",
"showId": "id_8h2k4q",
"stillUrl": "https://example.com/…",
"title": "Fargo",
"track": 0
}
]
}Schema
queueobjectrequired
currentobject
- entryIdstringrequired
- positionintegerrequired
- durationKnownbooleanrequired
- idstringrequired
nextobject
- availablebooleanrequired
- entryIdstring
- reasonstringrequired
postPlayobject
- automaticAdvancesintegerrequired
- autoplaybooleanrequired
- countdownMsintegerrequired
- passoutCheckDuebooleanrequired
- startDuringCreditsbooleanrequired
- remainingCountintegerrequired
- repeatstringrequired
- revisionstringrequired
- segmentCountintegerrequired
segmentsarray of objectrequired
- countintegerrequired
- idstringrequired
- kindstringrequired
- labelstringrequired
- sourceRevisionstring
- statestringrequired
shuffleobject
- lapintegerrequired
- seedstringrequired
- totalintegerrequired
- totalDurationMsinteger
sessionobject
- channelIdstring
controlobject
- revisionstringrequired
- statestringrequired
discTitleobject
- idstringrequired
- revisionstringrequired
endobject
- messagestring
- reasonstringrequired
- idstringrequired
- itemIdstring
- kindstringrequired
leaseobjectrequired
- expiresAtstringrequired
- reportEveryMsintegerrequired
observedPlaybackobject
audioobject
- bitDepthinteger
- channelsinteger
- codecstring
- handlingstring
- layoutstring
- objectAudiostring
- sampleRateinteger
- deliveredBitrateKbpsinteger
screenobject
- dynamicRangestring
- refreshRateHznumber
subtitlesobject
- renderingstringrequired
videoobject
- bitDepthinteger
- dynamicRangestring
- frameRateHznumber
- heightinteger
- widthinteger
playbackInfoobject
- basisstringrequiredone of "committed_delivery_plan"
deliveredobjectrequired
audioobject
- bitDepthinteger
- channelsinteger
- codecstringrequired
- deliverystring
- layoutstring
- losslessboolean
- objectAudiostring
- profilestring
- sampleRateinteger
- variantstring
subtitlesobject
- formatstring
- languagestring
- originstring
- renderingstring
- titlestring
videoobject
- bitDepthinteger
- chromaSubsamplingstring
- codecstringrequired
- containerstring
conversionobject
- enhancementDiscardedbooleanrequired
- felResidualDiscardedbooleanrequired
- kindstringrequired
- sourceDolbyVisionProfileintegerrequired
- sourceEnhancementTypestring
- dolbyVisionBaseLayerboolean
- dolbyVisionCmVersionstring
- dolbyVisionCompatibilityinteger
- dolbyVisionEnhancementTypestring
- dolbyVisionProfileinteger
- dolbyVisionRpuboolean
- dynamicRangestring
- frameRatenumber
- frameRateDenominatorinteger
- frameRateModestring
- frameRateNumeratorinteger
- hdr10Plusboolean
- heightinteger
- interlacedboolean
- masterDisplaystring
- maxCllstring
- profilestring
- widthinteger
- estimatedBitrateKbpsinteger
lossesarray of objectrequired
- featurestringrequired
replacementobjectrequired
- audioCodecstring
- channelsinteger
- dynamicRangestring
- layoutstring
- networkstringrequired
reasonobjectrequired
- audioCodecstring
- containerstring
- kindstringrequired
- maxBitrateKbpsinteger
- maxHeightinteger
- videoCodecstring
- routestringrequired
routesobjectrequired
- picturestring
- soundstring
- subtitlesstring
sourceobjectrequired
audioobject
- bitDepthinteger
- channelsinteger
- codecstringrequired
- deliverystring
- layoutstring
- losslessboolean
- objectAudiostring
- profilestring
- sampleRateinteger
- variantstring
subtitlesobject
- formatstring
- languagestring
- originstring
- renderingstring
- titlestring
videoobject
- bitDepthinteger
- chromaSubsamplingstring
- codecstringrequired
- containerstring
conversionobject
- enhancementDiscardedbooleanrequired
- felResidualDiscardedbooleanrequired
- kindstringrequired
- sourceDolbyVisionProfileintegerrequired
- sourceEnhancementTypestring
- dolbyVisionBaseLayerboolean
- dolbyVisionCmVersionstring
- dolbyVisionCompatibilityinteger
- dolbyVisionEnhancementTypestring
- dolbyVisionProfileinteger
- dolbyVisionRpuboolean
- dynamicRangestring
- frameRatenumber
- frameRateDenominatorinteger
- frameRateModestring
- frameRateNumeratorinteger
- hdr10Plusboolean
- heightinteger
- interlacedboolean
- masterDisplaystring
- maxCllstring
- profilestring
- widthinteger
presentationobjectrequired
audioRenderobject
- bitDepthinteger
- bytesinteger
- channelsinteger
- codecstring
- containerstring
- conversionGainDbnumber
- decoderConfigstring
- downmixedboolean
- durationFramesinteger
gainobject
- albumDbnumber
- albumPeaknumber
- sourcestringrequired
- trackDbnumber
- trackPeaknumber
- idstringrequired
- loudnessAppliedDbnumber
loudnessEnvelopeobject
- endLufsarray of numberrequired
- intervalMsintegerrequired
- startLufsarray of numberrequired
- modestringrequired
- prefetchBytesinteger
- reasonstring
- sampleRateinteger
seekIndexobject
- urlstringrequired
- sourceBitrateBpsinteger
trimobject
- endFramesintegerrequired
- sourcestringrequired
- startFramesintegerrequired
- urlstring
- versionintegerrequired
- audioTrackIdstring
- bitrateKbpsinteger
- choiceRevisioninteger
- containerstring
decisionobjectrequired
audioobject
- actionstringrequired
- channelsinteger
- reasonsarray of stringrequired
- tostring
subtitlesobject
- actionstringrequired
- channelsinteger
- reasonsarray of stringrequired
- tostring
videoobject
- actionstringrequired
- channelsinteger
- reasonsarray of stringrequired
- tostring
- enginestringrequired
- generationintegerrequired
linearobject
clocksarray of object
- endMsintegerrequired
- offsetMsintegerrequired
- startMsintegerrequired
- confirmedPositionMsinteger
- errorCodestring
- liveEdgeMsintegerrequired
- namestringrequired
nextobject
- endMsintegerrequired
- idstringrequired
- itemIdstring
- startMsintegerrequired
- titlestringrequired
- nowMsinteger
- originMsintegerrequired
programmeobject
- endMsintegerrequired
- idstringrequired
- itemIdstring
- startMsintegerrequired
- titlestringrequired
- reservationRequiredAtMsinteger
seekobject
- acknowledgedbooleanrequired
- errorstring
- idstringrequired
- liveboolean
- positionMsinteger
- statestringrequired
- windowEndMsintegerrequired
- windowStartMsintegerrequired
- modestringrequired
qualityobject
- idstring
- maxAudioBitrateKbpsinteger
- maxHeightinteger
- maxVideoBitrateKbpsinteger
- modestringrequired
- stepstring
- seekIdstring
- startPositionMsintegerrequired
subtitleobject
- deliverystringrequired
- kindstringrequired
- trackIdstringrequired
subtitlesarray of objectrequired
- companionUrlstring
- fontsUrlstring
- formatstringrequired
- linesUrlstring
- offsetMsintegerrequired
- timeDomainstringrequired
- trackIdstringrequired
- urlstringrequired
- urlstringrequired
- videoHeightinteger
queueobject
- entryIdstringrequired
- queueIdstringrequired
- retryAfterMsinteger
- revisionstringrequired
- rolestringrequired
- statestringrequired
- versionIdstring
windowarray of object
- albumstring
- albumIdstring
- artiststring
- artistIdstring
- availablebooleanrequired
- backdropUrlstring
- discinteger
- durationMsinteger
- entryIdstringrequired
episodeobject
- numberintegerrequired
- seasonNumberintegerrequired
- itemIdstringrequired
- kindstringrequired
- libraryIdstring
- positionintegerrequired
- posterUrlstring
- seasonIdstring
- segmentIdstringrequired
- showIdstring
- stillUrlstring
- titlestringrequired
- trackinteger
defaultRequest refused or unavailableapplication/json
Example
{
"error": {
"code": "string",
"message": "string"
}
}Schema
errorobjectrequired
- codestringrequired
- messagestringrequired
Error codesinvalid_requestunauthorizednot_foundrevision_requiredrevision_mismatchunsupported_selectorqueue_too_largequeue_buildingtimeoutdatabase_busywriter_capacity
Example request
curl -X POST "http://127.0.0.1:32500/v1/queues/{id}/entries/{entryId}:move" \
-H "Authorization: Bearer $PORTICO_API_KEY" \
-H "Content-Type: application/json" \
-d '{"after":"string","before":"string"}'GET/v1/queues/{id}/entryResolve a visible episode outside the loaded queue window for an in-player jumpread
- Audience
- Clients · Native API
- Authorization
- API key or personal access token with the read scope, or a signed-in session
- OpenAPI operation ID
get_queue_entry_for_item
Parameters
| Name | In | Type | Description |
|---|---|---|---|
idrequired | path | string | |
itemId | query | string |
Responses
200Successapplication/json
Example
{
"entry": {
"album": "string",
"albumId": "id_8h2k4q",
"artist": "string",
"artistId": "id_8h2k4q",
"available": true,
"backdropUrl": "https://example.com/…",
"disc": 0,
"durationMs": 1800000,
"entryId": "id_8h2k4q",
"episode": {
"number": 0,
"seasonNumber": 0
},
"itemId": "id_8h2k4q",
"kind": "string",
"libraryId": "id_8h2k4q",
"position": 0,
"posterUrl": "https://example.com/…",
"seasonId": "id_8h2k4q",
"segmentId": "id_8h2k4q",
"showId": "id_8h2k4q",
"stillUrl": "https://example.com/…",
"title": "Fargo",
"track": 0
},
"revision": "r12"
}Schema
entryobjectrequired
- albumstring
- albumIdstring
- artiststring
- artistIdstring
- availablebooleanrequired
- backdropUrlstring
- discinteger
- durationMsinteger
- entryIdstringrequired
episodeobject
- numberintegerrequired
- seasonNumberintegerrequired
- itemIdstringrequired
- kindstringrequired
- libraryIdstring
- positionintegerrequired
- posterUrlstring
- seasonIdstring
- segmentIdstringrequired
- showIdstring
- stillUrlstring
- titlestringrequired
- trackinteger
- revisionstringrequired
defaultRequest refused or unavailableapplication/json
Example
{
"error": {
"code": "string",
"message": "string"
}
}Schema
errorobjectrequired
- codestringrequired
- messagestringrequired
Error codesinvalid_requestunauthorizednot_foundqueue_buildingrevision_mismatchtimeoutdatabase_busy
Example request
curl -X GET "http://127.0.0.1:32500/v1/queues/{id}/entry" \
-H "Authorization: Bearer $PORTICO_API_KEY"POST/v1/queues/{id}/segmentsPlay next, add to the queue, or insert after an entryplayback
- Audience
- Clients · Native API
- Authorization
- API key or personal access token with the playback scope, or a signed-in session
- OpenAPI operation ID
add_queue_segment- Max body
- 32 KiB
Parameters
| Name | In | Type | Description |
|---|---|---|---|
idrequired | path | string |
Request body application/json · required
Example
{
"anchor": null,
"order": {
"mode": "string",
"seed": "string"
},
"placement": null,
"source": {
"container": {
"id": "id_8h2k4q",
"kind": "string"
}
}
}Schema
- anchorany
orderobject
- modestringrequired
- seedstring
- placementanyrequired
sourceobjectrequired
containerobjectrequired
- idstringrequired
- kindstringrequired
Responses
200Successapplication/json
Example
{
"queue": {
"current": {
"entryId": "id_8h2k4q",
"position": 0
},
"durationKnown": true,
"id": "id_8h2k4q",
"next": {
"available": true,
"entryId": "id_8h2k4q",
"reason": "string"
},
"postPlay": {
"automaticAdvances": 0,
"autoplay": true,
"countdownMs": 1800000,
"passoutCheckDue": true,
"startDuringCredits": true
},
"remainingCount": 0,
"repeat": "2026-10-18T19:30:00Z",
"revision": "r12",
"segmentCount": 0,
"segments": [
{
"count": 0,
"id": "id_8h2k4q",
"kind": "string",
"label": "string",
"sourceRevision": "r12",
"state": "string"
}
],
"shuffle": {
"lap": 0,
"seed": "string"
},
"total": 0,
"totalDurationMs": 1800000
},
"session": {
"channelId": "id_8h2k4q",
"control": {
"revision": "r12",
"state": "string"
},
"discTitle": {
"id": "id_8h2k4q",
"revision": "r12"
},
"end": {
"message": "string",
"reason": "string"
},
"id": "id_8h2k4q",
"itemId": "id_8h2k4q",
"kind": "string",
"lease": {
"expiresAt": "2026-10-18T19:30:00Z",
"reportEveryMs": 1800000
},
"observedPlayback": {
"audio": {
"bitDepth": 0,
"channels": 0,
"codec": "string",
"handling": "string",
"layout": "string",
"objectAudio": "string",
"sampleRate": 0
},
"deliveredBitrateKbps": 0,
"screen": {
"dynamicRange": "string",
"refreshRateHz": 0
},
"subtitles": {
"rendering": "string"
},
"video": {
"bitDepth": 0,
"dynamicRange": "string",
"frameRateHz": 0,
"height": 0,
"width": 0
}
},
"playbackInfo": {
"basis": "committed_delivery_plan",
"delivered": {
"audio": {
"bitDepth": 0,
"channels": 0,
"codec": "string",
"delivery": "string",
"layout": "string",
"lossless": true,
"objectAudio": "string",
"profile": "string",
"sampleRate": 0,
"variant": "string"
},
"subtitles": {
"format": "2026-10-18T19:30:00Z",
"language": "en",
"origin": "string",
"rendering": "string",
"title": "Fargo"
},
"video": {
"bitDepth": 0,
"chromaSubsampling": "string",
"codec": "string",
"container": "string",
"conversion": {},
"dolbyVisionBaseLayer": true,
"dolbyVisionCmVersion": "string",
"dolbyVisionCompatibility": 0,
"dolbyVisionEnhancementType": "string",
"dolbyVisionProfile": 0,
"dolbyVisionRpu": true,
"dynamicRange": "string",
"frameRate": 0,
"frameRateDenominator": 0,
"frameRateMode": "string",
"frameRateNumerator": 0,
"hdr10Plus": true,
"height": 0,
"interlaced": true,
"masterDisplay": "string",
"maxCll": "string",
"profile": "string",
"width": 0
}
},
"estimatedBitrateKbps": 0,
"losses": [
{
"feature": "string",
"replacement": {}
}
],
"network": "string",
"reason": {
"audioCodec": "string",
"container": "string",
"kind": "string",
"maxBitrateKbps": 0,
"maxHeight": 0,
"videoCodec": "string"
},
"route": "string",
"routes": {
"picture": "string",
"sound": "string",
"subtitles": "Fargo"
},
"source": {
"audio": {
"bitDepth": 0,
"channels": 0,
"codec": "string",
"delivery": "string",
"layout": "string",
"lossless": true,
"objectAudio": "string",
"profile": "string",
"sampleRate": 0,
"variant": "string"
},
"subtitles": {
"format": "2026-10-18T19:30:00Z",
"language": "en",
"origin": "string",
"rendering": "string",
"title": "Fargo"
},
"video": {
"bitDepth": 0,
"chromaSubsampling": "string",
"codec": "string",
"container": "string",
"conversion": {},
"dolbyVisionBaseLayer": true,
"dolbyVisionCmVersion": "string",
"dolbyVisionCompatibility": 0,
"dolbyVisionEnhancementType": "string",
"dolbyVisionProfile": 0,
"dolbyVisionRpu": true,
"dynamicRange": "string",
"frameRate": 0,
"frameRateDenominator": 0,
"frameRateMode": "string",
"frameRateNumerator": 0,
"hdr10Plus": true,
"height": 0,
"interlaced": true,
"masterDisplay": "string",
"maxCll": "string",
"profile": "string",
"width": 0
}
}
},
"presentation": {
"audioRender": {
"bitDepth": 0,
"bytes": 0,
"channels": 0,
"codec": "string",
"container": "string",
"conversionGainDb": 0,
"decoderConfig": "string",
"downmixed": true,
"durationFrames": 0,
"gain": {
"albumDb": 0,
"albumPeak": 0,
"source": "string",
"trackDb": 0,
"trackPeak": 0
},
"id": "id_8h2k4q",
"loudnessAppliedDb": 0,
"loudnessEnvelope": {
"endLufs": [],
"intervalMs": 1800000,
"startLufs": []
},
"mode": "string",
"prefetchBytes": 0,
"reason": "string",
"sampleRate": 0,
"seekIndex": {
"url": "https://example.com/…"
},
"sourceBitrateBps": 0,
"trim": {
"endFrames": 0,
"source": "string",
"startFrames": 0
},
"url": "https://example.com/…",
"version": 0
},
"audioTrackId": "id_8h2k4q",
"bitrateKbps": 0,
"choiceRevision": 0,
"container": "string",
"decision": {
"audio": {
"action": "string",
"channels": 0,
"reasons": [],
"to": "string"
},
"subtitles": {
"action": "string",
"channels": 0,
"reasons": [],
"to": "string"
},
"video": {
"action": "string",
"channels": 0,
"reasons": [],
"to": "string"
}
},
"engine": "string",
"generation": 0,
"linear": {
"clocks": [
{}
],
"confirmedPositionMs": 1800000,
"errorCode": "string",
"liveEdgeMs": 1800000,
"name": "Fargo",
"next": {
"endMs": 1800000,
"id": "id_8h2k4q",
"itemId": "id_8h2k4q",
"startMs": 1800000,
"title": "Fargo"
},
"nowMs": 1800000,
"originMs": 1800000,
"programme": {
"endMs": 1800000,
"id": "id_8h2k4q",
"itemId": "id_8h2k4q",
"startMs": 1800000,
"title": "Fargo"
},
"reservationRequiredAtMs": 1800000,
"seek": {
"acknowledged": true,
"error": "string",
"id": "id_8h2k4q",
"live": true,
"positionMs": 1800000
},
"state": "string",
"windowEndMs": 1800000,
"windowStartMs": 1800000
},
"mode": "string",
"quality": {
"id": "id_8h2k4q",
"maxAudioBitrateKbps": 0,
"maxHeight": 0,
"maxVideoBitrateKbps": 0,
"mode": "string",
"step": "string"
},
"seekId": "id_8h2k4q",
"startPositionMs": 1800000,
"subtitle": {
"delivery": "string",
"kind": "string",
"trackId": "id_8h2k4q"
},
"subtitles": [
{
"companionUrl": "https://example.com/…",
"fontsUrl": "https://example.com/…",
"format": "2026-10-18T19:30:00Z",
"linesUrl": "https://example.com/…",
"offsetMs": 1800000,
"timeDomain": "2026-10-18T19:30:00Z",
"trackId": "id_8h2k4q",
"url": "https://example.com/…"
}
],
"url": "https://example.com/…",
"videoHeight": 0
},
"queue": {
"entryId": "id_8h2k4q",
"queueId": "id_8h2k4q"
},
"retryAfterMs": 1800000,
"revision": "r12",
"role": "string",
"state": "string",
"versionId": "id_8h2k4q"
},
"window": [
{
"album": "string",
"albumId": "id_8h2k4q",
"artist": "string",
"artistId": "id_8h2k4q",
"available": true,
"backdropUrl": "https://example.com/…",
"disc": 0,
"durationMs": 1800000,
"entryId": "id_8h2k4q",
"episode": {
"number": 0,
"seasonNumber": 0
},
"itemId": "id_8h2k4q",
"kind": "string",
"libraryId": "id_8h2k4q",
"position": 0,
"posterUrl": "https://example.com/…",
"seasonId": "id_8h2k4q",
"segmentId": "id_8h2k4q",
"showId": "id_8h2k4q",
"stillUrl": "https://example.com/…",
"title": "Fargo",
"track": 0
}
]
}Schema
queueobjectrequired
currentobject
- entryIdstringrequired
- positionintegerrequired
- durationKnownbooleanrequired
- idstringrequired
nextobject
- availablebooleanrequired
- entryIdstring
- reasonstringrequired
postPlayobject
- automaticAdvancesintegerrequired
- autoplaybooleanrequired
- countdownMsintegerrequired
- passoutCheckDuebooleanrequired
- startDuringCreditsbooleanrequired
- remainingCountintegerrequired
- repeatstringrequired
- revisionstringrequired
- segmentCountintegerrequired
segmentsarray of objectrequired
- countintegerrequired
- idstringrequired
- kindstringrequired
- labelstringrequired
- sourceRevisionstring
- statestringrequired
shuffleobject
- lapintegerrequired
- seedstringrequired
- totalintegerrequired
- totalDurationMsinteger
sessionobject
- channelIdstring
controlobject
- revisionstringrequired
- statestringrequired
discTitleobject
- idstringrequired
- revisionstringrequired
endobject
- messagestring
- reasonstringrequired
- idstringrequired
- itemIdstring
- kindstringrequired
leaseobjectrequired
- expiresAtstringrequired
- reportEveryMsintegerrequired
observedPlaybackobject
audioobject
- bitDepthinteger
- channelsinteger
- codecstring
- handlingstring
- layoutstring
- objectAudiostring
- sampleRateinteger
- deliveredBitrateKbpsinteger
screenobject
- dynamicRangestring
- refreshRateHznumber
subtitlesobject
- renderingstringrequired
videoobject
- bitDepthinteger
- dynamicRangestring
- frameRateHznumber
- heightinteger
- widthinteger
playbackInfoobject
- basisstringrequiredone of "committed_delivery_plan"
deliveredobjectrequired
audioobject
- bitDepthinteger
- channelsinteger
- codecstringrequired
- deliverystring
- layoutstring
- losslessboolean
- objectAudiostring
- profilestring
- sampleRateinteger
- variantstring
subtitlesobject
- formatstring
- languagestring
- originstring
- renderingstring
- titlestring
videoobject
- bitDepthinteger
- chromaSubsamplingstring
- codecstringrequired
- containerstring
conversionobject
- enhancementDiscardedbooleanrequired
- felResidualDiscardedbooleanrequired
- kindstringrequired
- sourceDolbyVisionProfileintegerrequired
- sourceEnhancementTypestring
- dolbyVisionBaseLayerboolean
- dolbyVisionCmVersionstring
- dolbyVisionCompatibilityinteger
- dolbyVisionEnhancementTypestring
- dolbyVisionProfileinteger
- dolbyVisionRpuboolean
- dynamicRangestring
- frameRatenumber
- frameRateDenominatorinteger
- frameRateModestring
- frameRateNumeratorinteger
- hdr10Plusboolean
- heightinteger
- interlacedboolean
- masterDisplaystring
- maxCllstring
- profilestring
- widthinteger
- estimatedBitrateKbpsinteger
lossesarray of objectrequired
- featurestringrequired
replacementobjectrequired
- audioCodecstring
- channelsinteger
- dynamicRangestring
- layoutstring
- networkstringrequired
reasonobjectrequired
- audioCodecstring
- containerstring
- kindstringrequired
- maxBitrateKbpsinteger
- maxHeightinteger
- videoCodecstring
- routestringrequired
routesobjectrequired
- picturestring
- soundstring
- subtitlesstring
sourceobjectrequired
audioobject
- bitDepthinteger
- channelsinteger
- codecstringrequired
- deliverystring
- layoutstring
- losslessboolean
- objectAudiostring
- profilestring
- sampleRateinteger
- variantstring
subtitlesobject
- formatstring
- languagestring
- originstring
- renderingstring
- titlestring
videoobject
- bitDepthinteger
- chromaSubsamplingstring
- codecstringrequired
- containerstring
conversionobject
- enhancementDiscardedbooleanrequired
- felResidualDiscardedbooleanrequired
- kindstringrequired
- sourceDolbyVisionProfileintegerrequired
- sourceEnhancementTypestring
- dolbyVisionBaseLayerboolean
- dolbyVisionCmVersionstring
- dolbyVisionCompatibilityinteger
- dolbyVisionEnhancementTypestring
- dolbyVisionProfileinteger
- dolbyVisionRpuboolean
- dynamicRangestring
- frameRatenumber
- frameRateDenominatorinteger
- frameRateModestring
- frameRateNumeratorinteger
- hdr10Plusboolean
- heightinteger
- interlacedboolean
- masterDisplaystring
- maxCllstring
- profilestring
- widthinteger
presentationobjectrequired
audioRenderobject
- bitDepthinteger
- bytesinteger
- channelsinteger
- codecstring
- containerstring
- conversionGainDbnumber
- decoderConfigstring
- downmixedboolean
- durationFramesinteger
gainobject
- albumDbnumber
- albumPeaknumber
- sourcestringrequired
- trackDbnumber
- trackPeaknumber
- idstringrequired
- loudnessAppliedDbnumber
loudnessEnvelopeobject
- endLufsarray of numberrequired
- intervalMsintegerrequired
- startLufsarray of numberrequired
- modestringrequired
- prefetchBytesinteger
- reasonstring
- sampleRateinteger
seekIndexobject
- urlstringrequired
- sourceBitrateBpsinteger
trimobject
- endFramesintegerrequired
- sourcestringrequired
- startFramesintegerrequired
- urlstring
- versionintegerrequired
- audioTrackIdstring
- bitrateKbpsinteger
- choiceRevisioninteger
- containerstring
decisionobjectrequired
audioobject
- actionstringrequired
- channelsinteger
- reasonsarray of stringrequired
- tostring
subtitlesobject
- actionstringrequired
- channelsinteger
- reasonsarray of stringrequired
- tostring
videoobject
- actionstringrequired
- channelsinteger
- reasonsarray of stringrequired
- tostring
- enginestringrequired
- generationintegerrequired
linearobject
clocksarray of object
- endMsintegerrequired
- offsetMsintegerrequired
- startMsintegerrequired
- confirmedPositionMsinteger
- errorCodestring
- liveEdgeMsintegerrequired
- namestringrequired
nextobject
- endMsintegerrequired
- idstringrequired
- itemIdstring
- startMsintegerrequired
- titlestringrequired
- nowMsinteger
- originMsintegerrequired
programmeobject
- endMsintegerrequired
- idstringrequired
- itemIdstring
- startMsintegerrequired
- titlestringrequired
- reservationRequiredAtMsinteger
seekobject
- acknowledgedbooleanrequired
- errorstring
- idstringrequired
- liveboolean
- positionMsinteger
- statestringrequired
- windowEndMsintegerrequired
- windowStartMsintegerrequired
- modestringrequired
qualityobject
- idstring
- maxAudioBitrateKbpsinteger
- maxHeightinteger
- maxVideoBitrateKbpsinteger
- modestringrequired
- stepstring
- seekIdstring
- startPositionMsintegerrequired
subtitleobject
- deliverystringrequired
- kindstringrequired
- trackIdstringrequired
subtitlesarray of objectrequired
- companionUrlstring
- fontsUrlstring
- formatstringrequired
- linesUrlstring
- offsetMsintegerrequired
- timeDomainstringrequired
- trackIdstringrequired
- urlstringrequired
- urlstringrequired
- videoHeightinteger
queueobject
- entryIdstringrequired
- queueIdstringrequired
- retryAfterMsinteger
- revisionstringrequired
- rolestringrequired
- statestringrequired
- versionIdstring
windowarray of object
- albumstring
- albumIdstring
- artiststring
- artistIdstring
- availablebooleanrequired
- backdropUrlstring
- discinteger
- durationMsinteger
- entryIdstringrequired
episodeobject
- numberintegerrequired
- seasonNumberintegerrequired
- itemIdstringrequired
- kindstringrequired
- libraryIdstring
- positionintegerrequired
- posterUrlstring
- seasonIdstring
- segmentIdstringrequired
- showIdstring
- stillUrlstring
- titlestringrequired
- trackinteger
defaultRequest refused or unavailableapplication/json
Example
{
"error": {
"code": "string",
"message": "string"
}
}Schema
errorobjectrequired
- codestringrequired
- messagestringrequired
Error codesinvalid_requestunauthorizednot_foundrevision_requiredrevision_mismatchunsupported_selectorqueue_too_largequeue_buildingtimeoutdatabase_busywriter_capacity
Example request
curl -X POST "http://127.0.0.1:32500/v1/queues/{id}/segments" \
-H "Authorization: Bearer $PORTICO_API_KEY" \
-H "Content-Type: application/json" \
-d '{"anchor":null,"order":{"mode":"string","seed":"string"},"placement":null,"source":{"container":{"id":"id_8h2k4q","kind":"string"}}}'GET/v1/queues/{id}/windowRead the entries around the current one (at most 200)read
- Audience
- Clients · Native API
- Authorization
- API key or personal access token with the read scope, or a signed-in session
- OpenAPI operation ID
get_queue_window
Parameters
| Name | In | Type | Description |
|---|---|---|---|
idrequired | path | string | |
around | query | string | |
before | query | string | |
after | query | string |
Responses
200Successapplication/json
Example
{
"items": [
{
"album": "string",
"albumId": "id_8h2k4q",
"artist": "string",
"artistId": "id_8h2k4q",
"available": true,
"backdropUrl": "https://example.com/…",
"disc": 0,
"durationMs": 1800000,
"entryId": "id_8h2k4q",
"episode": {
"number": 0,
"seasonNumber": 0
},
"itemId": "id_8h2k4q",
"kind": "string",
"libraryId": "id_8h2k4q",
"position": 0,
"posterUrl": "https://example.com/…",
"seasonId": "id_8h2k4q",
"segmentId": "id_8h2k4q",
"showId": "id_8h2k4q",
"stillUrl": "https://example.com/…",
"title": "Fargo",
"track": 0
}
],
"page": {
"limit": 0,
"nextCursor": "eyJvIjoyMH0",
"revision": "r12",
"start": 0,
"total": 0
}
}Schema
itemsarray of objectrequired
- albumstring
- albumIdstring
- artiststring
- artistIdstring
- availablebooleanrequired
- backdropUrlstring
- discinteger
- durationMsinteger
- entryIdstringrequired
episodeobject
- numberintegerrequired
- seasonNumberintegerrequired
- itemIdstringrequired
- kindstringrequired
- libraryIdstring
- positionintegerrequired
- posterUrlstring
- seasonIdstring
- segmentIdstringrequired
- showIdstring
- stillUrlstring
- titlestringrequired
- trackinteger
pageobjectrequired
- limitintegerrequired
- nextCursorstring
- revisionstringrequired
- startintegerrequired
- totalintegerrequired
defaultRequest refused or unavailableapplication/json
Example
{
"error": {
"code": "string",
"message": "string"
}
}Schema
errorobjectrequired
- codestringrequired
- messagestringrequired
Error codesinvalid_requestunauthorizednot_foundrevision_mismatchtimeoutdatabase_busy
Example request
curl -X GET "http://127.0.0.1:32500/v1/queues/{id}/window" \
-H "Authorization: Bearer $PORTICO_API_KEY"No operations match that filter.