API Reference

Episodes

Skylark enables your team to create a hierarchy for episodic content using brands, seasons, episodes and assets.

The episode object is where the asset object is referenced.

In the Skylark UI, the contents tab for an episode will either allow a user to upload a video through the browser or if an asset has already been selected or assigned, a listing for that asset will be shown instead.

Below is listed every metadata field available for the episode object.

Overview

NameEpisode
Set type slugepisode
UI Nav LocationMedia content

List View

Can have imagesYes
TitleYes
LicensingYes
TranslationsYes

Information

Language Version Metadata:

UI Field NameAPI Field NameData TypeSearchable
Titletitle!Stringtrue
Slugslug!Stringfalse
Sort Titletitle_sortStringfalse
Short Synopsissynopsis_shortStringfalse
Medium Synopsissynopsis_mediumStringfalse
Long Synopsissynopsis_longStringfalse
Short Titletitle_shortStringfalse
Medium Titletitle_mediumStringfalse
Long Titletitle_longStringfalse

Global Metadata

Field nameData type
Episode NumberInt
TranslationsYes
LicensingYes
TagsYes
CreditsYes

Imagery

Image Type:

NameSlug
Mainmain
Headerheader
Footerfooter
Backgroundbackground
Posterposter
Landscapelandscape
Profileprofile
Previewpreview
Featurefeature
Thumbnailthumbnail

Content Type

Content Type
Asset

Relationships

Relationship
Genres
Themes
Ratings

Episodes and Parent URLs

In order for the API to return a parent_url for an asset or episode, that asset or episode MUST belong to a brand or season.

An asset or episode can be present in any number of sets (aka collections, rails, sliders, homepages and generic views), but can only appear in one brand or season.

If an asset appears in two collections for example then Skylark would not be able to return two parent_urls. parent_url is therefore returned as null unless the episode is part of a brand or season.