Story Playlists

Preview a story playlist filter

POST
https://api.tunio.ai/v1/story-playlists/preview

The stories a filter playlist would air, before it is saved, a page at a time. Only filter is read from the body.

Query parameters

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

Request body

The filter (title, kind, intro_uuid and outro_uuid are not needed)

NameTypeDescription
filterobject
Picks the stories of a filter playlist; absent or empty fields do not narrow. Ignored for a manual playlist.
age_maxinteger
Highest age rating of the stories: 0, 6, 12, 16 or 18, not below age_min; absent for no upper bound.
age_mininteger
Lowest age rating of the stories: 0, 6, 12, 16 or 18; absent for no lower bound.
categorystring
Category slug (lowercase letters, digits and dashes, up to 40), as in the story library; absent or empty for any.
duration_maxinteger
Longest story to take, in seconds, 60-36000; absent or 0 for any length.
languagestring
Language code such as en or pt-BR; absent or empty for any.
intro_uuidstring
UUID of a file of the caller's library aired before a slot's stories; null or empty for none.
kindstring
manual (stories added one by one, in order) or filter (every story matching filter). Set on create only; the kind of a playlist does not change.
outro_uuidstring
UUID of a file of the caller's library aired after a slot's stories; null or empty for none.
titlestring
Title of the playlist, 1-200 characters.
Request example
01{
02 "filter": {
03 "age_max": 12,
04 "age_min": 0,
05 "category": "fantasy",
06 "duration_max": 1800,
07 "language": "en"
08 },
09 "intro_uuid": "",
10 "kind": "filter",
11 "outro_uuid": "",
12 "title": "Bedtime stories"
13}

Responses

NameTypeDescription
next_cursorstring
Cursor of the next page, null on the last page.
storiesarray
One page of stories.
[item]Requiredobject
-
successboolean
Always true on success.
totalinteger
How many stories match in all.
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.