API Reference

Assets

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

The asset object is where the ovp object is referenced. The ovp object contains the streaming url path for a given asset.

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

The user can also upload text track files to add subtitles to the asset.

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

Overview

NameAssets
Can be scheduledYes
UI Nav LocationMedia content
API Endpoint/assets

List View

TitleYes
DurationYes
LicensingYes
TranslationsYes

Information

Language Version Metadata:

UI Field NameAPI Field NameData typeSearchable
Titletitle!Stringtrue

Global Metadata:

Field nameData type
Duration in secondsBoolean
Release DateDate
TranslationsYes
LicensingYes

Imagery

Image Type:

NameSlug
Mainmain
Headerheader
Footerfooter
Backgroundbackground
Posterposter
Landscapelandscape
Profileprofile
Previewpreview
Featurefeature
Thumbnailthumbnail

Content Type

Content Type
Asset

Relationships

Relationship
Parental Guidance

Assets and Parent URL's

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.