800.885.8886 sales@telvue.com
  • Facebook
  • Twitter
  • Facebook
  • Twitter
TelVue
  • Home
  • Products
    • Playback & Automation
      • HyperCaster®
      • ProVue®
        • ProVue® HD
        • ProVue® GFX
        • ProVue® CC
      • TelVue TeleCastTM 2
    • Streaming/Cloud
      • TelVue CloudCast™
      • TelVue Connect™
      • Media Exchange
      • Mobile & OTT Apps
      • TelVue SmartCaption™
    • Digital Signage
      • TelVue InfoVue™
    • Automatic Captioning
      • SmartCaption™
    • Ad Insertion
      • TelVue AdCaster™
  • Solutions
    • Cable/Telco
    • Community Media
    • Media Companies
  • Support
    • Knowledge Base
    • Webinars
    • Training Videos
    • Documentation
    • Contact Support
  • News
    • Blog
    • Press
    • Awards
  • Client Logins
    • Connect/CloudCast
    • InfoVue
  • Contact Us
    • General & Sales
    • Technical Support
Select Page

HyperCaster

HyperCaster User Manual
    HyperCaster Configuration
    • Config Tab
    • Channel Setup
    • Continuity
    • Live Streams
    • Feed Setup
    • NDI Access Manager
    • ProVue Decoder Configuration
    • Configure In/Out Ports
    • Encode Profiles
    • Manage TeleCasts
    • Streaming Destinations
    • Streaming Rules
    • User Management
    • Content Settings
    • Pro Transcoding
    • Schedule Configuration
    • InfoVue XML
    • Switch Configuration
    • Remote Server Configuration
    • TelVue Connect Configuration
    • Captioning Configuration
    • Server Management
    • NTP, NTP Configuration, and NTP Health
    • Security Configuration
    • Network and Security
    • Setting up SSL/HTTPS on the HyperCaster
    • Backup Settings
    • IPMI
    • Config – Utilities
    • Version and Configuration
    • SNMP Support
    • External Devices
    • Brightcove EPG Integration
    • Add an RTMP Stream
    • Set Up an RTMP Stream in a HyperCaster
    • Set Up an SRT Stream in a HyperCaster
    • Set Up an HLS Stream in a HyperCaster
    • Get Channel Schedule as XML (Detailed)
    HyperCaster Content Management
    • Organize and Add Content
    • Content Management
    • Thumbnail and Table Views
    • Show Content Page
    • Content File Actions
    • Add TBD Program
    • DVD Import
    • Replacement Files Hot Folder
    • How to Trim a Video File (Virtual Trimming)
    • Trim Content (Built-in, Multiple Trim Editing)
    • Tasks
    • Previews
    • Turn On Transcoding
    • Create a HyperCaster Playlist
    • Series & Series Scheduling
    • Record or Capture
    • Upload to Connect/CloudCast
    • Archiving
    • Archive.org integration
    • Content Workflow Rules
    • Preparing Content for the HyperCaster
    • Content RSS Feed
    • Export to CSV
    • Searching
    • Using Third-Party Editing Software
    HyperCaster Programming
    • The Dashboard
    • Programming
    • Calendar View
    • Classic View
    • Search Filters and Event Functions
    • Field Descriptions and Display Options
    • Program Playout Event
    • Program Stream Event
    • Program Record Event
    • Program Input Event (AIO Only)
    • Input Locking
    • Program Switch Event
    • Scheduling a Live Switch Event whose Actual Duration Varies
    • Program Playlist Event
    • Program Overlay Event
    • Program Slide Event
    • Program Ad Trigger Event
    • Unschedule an Event
    • Event Actions
    • Copy Program Blocks
    • Import and Export events
    • Native CSV Formatting
    • Scheduling Conflicts and Ripple
    • Recurring Events
    • Controlling What Appears in the Program Guide
    • Publishing Your Schedule
    • Schedule Ads
    HyperCaster Graphics
    • Graphic Overlays
    • Overlay Rules
    • Bugs
    • Tickers
    • How to Build RSS Tickers
    • Snipes
    • Clocks
    • Program Guides
    • Emergency Notification Console
    • Join in Progress Overlay
    HyperCaster Reports
    • Reports Tab
    • As Run Reports
    • Program Guide Report
    • Missing File Report
    • TelVue Connect Report
    HyperCaster Captioning
    • SmartCaption™ Automatic Captioning Integration
    HyperCaster Streaming
    • Configure In/Out Ports
    • Streaming Destinations
    • Encode Profiles
    • Manage TeleCasts
    • Streaming Rules
    HyperCaster Miscellaneous
    • System Health
    • Backups
    • Safety Requirements
    • Glossary
    HyperCaster Guide to CCMS Plus
    • Guide to CCMS Plus
    • CCMS Plus Setup
    • CCMS Schedule Remote Directory Folder Structures
    • Schedule and Media Imports
    • Verification File Export
    • Tasks Tab
    • E-Mail Notifications of Missing Content
HyperCaster FAQs
  • How do I access the UI for my HyperCaster?
  • What is the difference between, “enable continuity” and “continuity resume”?
  • Port Forwarding Rules to Allow External Access to the HyperCaster
  • How to Stream a Zoom Meeting to the HyperCaster
  • Extending an IP Capture without Re-Entering Metadata
  • YouTube Live
  • How do I set InfoVue as Continuity on the HyperCaster?
  • How do I embed a HyperCaster Program Guide in my website?
  • Facebook Live
  • What does “ripple” mean?
  • Does the preview player under edit show timecode or full length of video?
  • What is the RSS feed button in the HyperCaster?
  • How to Add a TriCaster Feed to the HyperCaster
  • Mapping the HyperCaster to Your Desktop
  • How to display NOAA weather RSS as HyperCaster Ticker
  • How to Stream a WebEx Meeting to the HyperCaster
  • Is it possible to run a PowerPoint through my HyperCaster?
  • Why is my NTP server showing a critical status?
  • How to Add a LiveU Solo Feed to the HyperCaster
  • TelVue Server LED Status Indicators
  • On the Channel Setup page, what are the “Website Guide Details” checkbox and the “TV Guide Station ID”?
  • Go LIVE from anywhere with a JVC GY-HM200 and a HyperCaster
  • How do I display Program guide?
  • What is MPEG?
  • Prepare Content for HyperCaster with Sorensen Squeeze
  • Use OBS to Live Stream Skype, GoToMeeting, or any Application Window to Your HyperCaster
  • On the “Health” page, was does NTP define?
  • Preparing Content for your HyperCaster Using Telestream Episode Pro
  • Is it possible to run two channels to the same IP address with different ports?
  • Is it possible to run two Ethernet connections out of the HyperCaster? (Additional Card Required)
  • Are 16:9 files automatically letterboxed?
  • Server rooms: some practical advice
  • Is it possible to run background audio from a stream that is different than the video scheduled (ex. Radio Feed)?
  • I am having issues with the overlays. They schedule but won’t play.
  • Loss-of-Video Failover Protection with This Easy Trick
  • On the “Edit Content” page, what does the “Private” checkbox, Location and Contributor fields define?
  • When using FTP are we able to change the password for psguser?
HyperCaster APIs
    HyperCaster API Content Workflow
    • Access All Content Metadata as CSV
    • Import Content (Hot Folder)
    • Uploading Files on Schedule
    HyperCaster API Content Methods
    • Get All Content Metadata
    • Get Content Metadata by Filename (REST)
    • Get Content Metadata by ID (REST)
    • Get Content Thumbnail (REST)
    • Add Content (REST)
    • Edit Content (REST)
    • Delete Content (REST)
    • Add Content (SOAP)
    • Edit Content (SOAP)
    • Delete Content (SOAP)
    HyperCaster API Schedule Workflow
    • Access Playback (As-Run) Log
    • Import Events (Hot Folder)
    HyperCaster API Schedule Methods
    • Get Channel Next Playing (REST)
    • Get Channel Now Playing (REST)
    • Get Channel Schedule as RSS (REST)
    HyperCaster API Channel Management
    • Get Channel Settings (REST)
    HyperCaster API System Management
    • Get System Health as RSS (REST)
    • Get Software Version (REST)
    • Get Network Settings (REST)
  • Home
  • Knowledge Base
  • HyperCaster Knowledge Base
  • HyperCaster
  • HyperCaster APIs
  • HyperCaster API Content Methods
  • Add Content (REST)

Add Content (REST)

Overview

Content metadata can be added using the REST API located at /content_api

Request URL

/content_api/new?program_code=[program_code]&program=[program]&episode_code=[episode_code]&episode=[episode]&description=[description]&expected_duration=[expected_duration]&expected_filename=[expected_filename]&location=[location]&contributor=[contributor]&import_datetime=[XXXX-MM-DD]&delete_datetime=[XXXX-MM-DD]&categories[]=[category]&custom_metadata[key]=[value]&api_key=[api key]

 

Ex. http://myserver/content_api/new?program_code=01&program=a1test&episode_code=009&episode=e1&description=mydescription&expected_duration=30&expected_filename=AAx&location=here&contributor=mycontrib&import_datetime=2011-04-20&delete_datetime=2012-04-20&categories[]=Community&categories[]=Dance&custom_metadata[foo]=bar&api_key=f1815f1f2011e32b6309

 

Parameters

Parameter Type Required Max Length Description
program_code String 64 The content file’s program code. If this is an unattached content file (no physical file yet) that is part of a sequence then either program or program_code is required depending on the “Use program and episode codes” configuration setting. The same applies to episode or episode code
program String 254 The content file’s program code. If this is an unattached content file (no physical file yet) that is part of a sequence then either program or program_code is required depending on the “Use program and episode codes” configuration setting
episode_code String 64 The content file’s episode code. If this is an unattached content file (no physical file yet) that is part of a sequence then either episode or episode_code is required depending on the “Use program and episode codes” configuration setting
episode String 254 The content file’s episode. If this is an unattached content file (no physical file yet) that is part of a sequence then either episode or episode_code is required depending on the “Use program and episode codes” configuration setting
description String The content file’s description. Can be any valid block of text
expected_duration Integer If this is an unattached content file, must be greater than 0
expected_filename String 255 If this is an unattached content file, must be specified
location String 32 If this is an unattached content file, must be specified if the system is configured to require location for unattached content
contributor String 64
import_datetime Date/Time Must be a valid ISO date/time
delete_datetime Date/Time Must be a valid ISO date/time
api_key String Must be a valid api key
categories Array A list of categories to add this content to. They must already exist on the system.
custom metadata Hash A hash of custom metadata keys and values to update for this content file. They must already exist on the system.

Code Examples

See URL example above.

Return

The success status of the operation will be output onto the screen. ‘true’ for success and ‘false’ for an error or invalid data.

Share This Article :
  • Facebook
  • Twitter
  • LinkedIn
  • Pinterest
Still stuck? How can we help?

How can we help?

Updated on December 1, 2022
Get Content Thumbnail (REST)Edit Content (REST)

PRODUCTS

  • Playback & Automation
    • HyperCaster®
    • ProVue®
      • ProVue® HD
      • ProVue® GFX
      • ProVue® CC
    • TelVue® TeleCastTM 2
  • Streaming/Cloud
    • TelVue CloudCast™
    • TelVue Connect™
    • Media Exchange
    • Mobile & OTT Apps
    • TelVue SmartCaption™
  • Digital Signage
    • TelVue InfoVue™
  • Automatic Captioning
    • SmartCaption™
  • Ad Insertion
    • AdCaster™

SUPPORT

  • Contact Support
  • Knowledge Base
  • Training Videos
  • Product Documentation

ABOUT

  • Contact Us
  • TelVue News for Hyperlocal Broadcast, PEG news, and TV Technology
  • Press Releases
  • Executive Profiles
  • Sales Team
  • Company
  • Partners

BLOG POSTS

  • FreightWaves Taps HyperCaster AIO for Flexible Ad Integration with Brightcove
  • HyperCaster Integrated Streaming & Social Streaming Automation
  • Live Dual-language Captioning, Multiple Trim Editing, and Multistreaming Automation with HyperCaster™ 8.3
  • AIO Integrated Streaming, Program Guide & Clock Overlays with HyperCaster™ 8.2
  • Channel Streaming Rights Management with HyperCaster™ 8.1
  • Facebook
  • Twitter
16000 Horizon Way, Suite 100, Mt. Laurel, NJ 08054 - TelVue Corporation ® All Rights Reserved 2020