Getting Started

The Uplynk API suite provides a comprehensive set of tools to streamline your video workflow, from content acquisition to delivery and analytics. These APIs enable you to automate processes, integrate with existing systems, and optimize media distribution while ensuring seamless monetization and security. Whether you're managing assets, handling ad integrations, or retrieving playback statistics, Uplynk APIs offer scalable solutions tailored to your needs.

The APIs are categorized into six core functions:

  • General – Essential APIs for authentication and user management.
  • Acquire – Tools for ingesting and processing content.
  • Manage – APIs for handling assets, schedules, and configurations.
  • Monetize – Ad-related APIs to enhance revenue generation.
  • Deliver – APIs for seamless content distribution and playback.
  • Analyze – APIs for monitoring performance and gathering insights.

API Reference

General

APIDescription
AuthenticationHandles API authentication and security.
OwnersManages API keys.
SubownersManages sub-owners associated with your account.

Acquire

APIDescription
SlicerMarks ads, replacement content, or content boundaries, sets metadata, and retrieves Live Slicer status information.
Cloud Slicer VODSlices and encodes content in the cloud.
Studio DRMManages Studio DRM policy configurations.
Live Slicer FailoverManages failover groups, adds/removes channels, and toggles a failover group's source feed.
Hosted SlicersManage Cloud Slicer Live (CSL) slicers, ingest points, slicer configuration templates, and CSL tasks.

Manage

APIDescription
AssetRetrieves and modifies CMS asset properties.
Asset ReprocessingManages ad breaks in existing assets.
Virtual Linear Playlist (including Smartstart)Administers virtual linear playlists consisting of one or more assets.
LibrariesManages shared CMS libraries.
ChannelsManipulates and queries live channels.
Channel SchedulerManages live channel schedule entries.
Live EventsRetrieves and modifies upcoming live events.
BlackoutsManages content restrictions
Clipping ProfilesManages clipping profiles, integrations, metadata, and YouTube authentication.

Monetize

APIDescription
AdsRetrieves information about ads and ad settings.
Ad Server DebugRetrieves information about ad jobs.
SyndicationAdministers publishing configurations and schedules, validates stream URLs, and starts/stops publishing to social media platforms.
Clip & Draft ClipManage clips and draft clips.

Deliver

APIDescription
AssetInfoRetrieves metadata about the currently playing asset.
PingProvides player time tracking, triggered events, and playhead updates, also used for VAST and VPAID ad integration.
PreplayRetrieves live channel playback URLs and pre-playback ad break information.
TokenVerifies tokens against a playback URL.

Analyze

APIDescription
Stream Information ID3
Live Streaming StatisticsRetrieves the latest statistics for live channels and events.
VOD Streaming StatisticsRetrieves the latest statistics for video-on-demand (VOD) content.
DRM Statistics
Ads Statistics

This structured categorization helps streamline the API selection process based on specific use cases. Let us know how we can assist with integration and optimization!