Story Playlists

Get a story playlist

GET
https://api.tunio.ai/v1/story-playlists/{uuid}

The playlist with its stories: all of a manual playlist's, in order (cursor and limit are ignored), or a filter playlist's a page at a time.

Path parameters

NameTypeDescription
uuidRequiredstringPlaylist UUID

Query parameters

NameTypeDescription
cursorstringnext_cursor from the previous page (filter playlists)
limitintegerPage size, 1-100; other values fall back to 30 (filter playlists)

Responses

NameTypeDescription
missingarray
Manual playlist only: UUIDs of stories that are no longer available, shown so they can be removed.
[item]Requiredstring
-
next_cursorstring
Filter playlist: cursor of the next page, null on the last page. Always null for a manual playlist.
playlistobject
The playlist.
created_atstring
When the playlist was created.
filterobject
The filter of a filter playlist; empty for a manual one.
intro_asset_titlestring
Title of the intro file; absent when there is none.
intro_uuidstring
UUID of the file aired before a slot's stories, or null.
kindstring
manual or filter.
outro_asset_titlestring
Title of the outro file; absent when there is none.
outro_uuidstring
UUID of the file aired after a slot's stories, or null.
storiesinteger
Number of stories in a manual playlist; 0 for a filter playlist, and in create and update responses.
titlestring
Title of the playlist.
updated_atstring
When the playlist was last changed.
uuidstring
UUID of the playlist; use it as content_id of a story_playlist schedule slot.
storiesarray
A manual playlist's stories in order, or a page of a filter playlist's stories.
[item]Requiredobject
-
successboolean
Always true on success.
totalinteger
Manual playlist: the number of available stories returned. Filter playlist: how many stories match.
NameTypeDescription
messagestring
Error code or human-readable error details.
successboolean
Always false for error payloads.
NameTypeDescription
messagestring
Error code or human-readable error details.
successboolean
Always false for error payloads.
NameTypeDescription
messagestring
Error code or human-readable error details.
successboolean
Always false for error payloads.
NameTypeDescription
messagestring
Error code or human-readable error details.
successboolean
Always false for error payloads.
NameTypeDescription
messagestring
Error code or human-readable error details.
successboolean
Always false for error payloads.
NameTypeDescription
messagestring
Error code or human-readable error details.
successboolean
Always false for error payloads.