Jump to Content
TelestreamAPI ReferenceGuides
HomeGuidesAPI ReferenceChangelogDiscussions
API ReferenceGuidesLog InTelestream
Log In

Platform

  • Introduction
  • Architecture
  • Customer Private Cloud
    • Amazon Web Services
    • Google Cloud Platform
    • Microsoft Azure

Vantage Cloud Port Hosted Workflows Guide

  • Getting Started
    • Prerequisites
  • What is Vantage Cloud Port Hosted Workflows?
    • Discouraged Use Cases
    • Target/Ideal Use Cases
  • Workflow Usage in Vantage Cloud Port Hosted Workflows
    • Nickname / Version Lifespan
    • Parameter Binding/Variable Manipulation
  • Creating the Compiled Workflow Document
    • Workflow Validation
  • Uploading a Compiled Workflow Document
  • Cloud Storage
  • Workflow Revisions
    • Switching Between Revisions
  • Submitting a Job
    • Examining A Job
  • Hosted Workflows: API Introduction
  • Hosted Workflows: Simple Job Submission
    • Identifying the Desired Telestream Cloud Store
    • Retrieve Workflow Details
    • Submitting a New Job to a Hosted Workflow
    • Querying Hosted Workflow Job Status
    • Querying the Outputs of a Completed Hosted Workflow Job
  • Hosted Workflows: CML Processing
    • CML Structure
    • CML File Locality
    • Store Based URL Paths
  • Troubleshooting
    • Helpful Tip
    • Error Messages and Corrective Actions

Transform

  • Getting Started
    • Factories
    • Templates
    • Jobs
    • Compositions
  • Using the API
    • Authenticating a Request
    • Creating a Factory
    • Creating a Template
    • Submitting a Job
    • Submitting a Composition
    • Canceling a Job
    • Probing a Container
    • Versioning
  • Compositions
    • Inputs and Outputs
    • Stream Selection and Routing
    • Combining Multiple Inputs
    • Media Properties
    • Audio Channel Mapping
    • Transcoding
    • Adaptive Bitrate Packaging
    • Video and Image Overlays
    • Audio Volume and Mixing
  • Properties
    • Audio Formats
    • Audio Normalization
    • Captions and Subtitles
    • Color Space Conversion
    • Dolby Vision
    • DPP Metadata
    • HDR10 Metadata
    • Tachyon and Dark Energy
    • Video Formats
    • Watermarking
  • Components
    • Audio Decoders
    • Audio Encoders
    • Audio Format Codes
    • Audio Loudness Filters
    • Active Format Description
    • Caption and Subtitle Filters
    • Color Space Filters
    • Containers
    • Dolby Atmos Filters
    • Dolby Vision Filters
    • Embedded Audio Filters
    • FrameFormer Filter
    • HDR10+ Metadata
    • Light Level Filters
    • Metadata Types
    • Packages
    • SCTE-35 Markers
    • Subtitle Format Codes
    • Tachyon Filter
    • Timecode
    • Video Decoders
    • Video Encoders
    • Video Recompressor
    • Video Format Codes
    • Watermark Filters
    • XDS Metadata
  • Schema Reference
    • Composition
    • Media Containers
    • Path Templates
    • Media Streams
    • Media Samples
    • Stream Operators
    • Video Operators
    • Audio Operators
    • Subtitle Operators
    • Stream Parts
    • Metadata Operators
    • Miscellaneous

Flip Transcoding

  • Getting Started - Flip Transcoding Service
    • Overview - Factories, profiles, jobs
    • Submitting encoding jobs
    • Supported output formats
    • Flip service events types
    • Adaptive Bitrate Encoding
    • H.264 MP4 encoding walk-through
    • Security and customer content storage policy
  • User Guides
    • Create a Factory - add storage and presets
    • Setting output path format
    • Customizing encoding profiles
    • Tachyon standards conversion guidelines
    • Creating HLS packages
    • Creating MPEG DASH packages
    • How to encode only part of the video
    • How to add watermark images
    • Enable job progress notifications using console

Cloud Quality Control

  • Getting started - Cloud QC
  • User Guides - Cloud QC
    • Running QC jobs in the Cloud
    • QC Report Review

Timed Text Speech

  • Getting Started - Timed Text Speech
  • User Guides - Timed Text Speech
    • Running Transcription Jobs in the Cloud
    • Transcription Review and Editing
    • Building Effective Custom Vocabulary
    • Getting the Best Results from Auto-Transcription

Stores Management

  • Getting Started - Stores Management
    • Overview of Stores Management
    • Introduction to watch-folders
  • User Guides - Stores Management
    • Output store - AWS S3
    • Watch-folder setup - AWS S3
    • Output store - Azure
    • Watch-folder - Azure
    • Output store - Google
    • Watch-folder - Google
    • Output store - (S)FTP
    • Watch-folder - FTP
    • Output store - IBM Aspera
    • Output store - Digital Ocean
    • Output Store - Generic S3

Notifications

  • Getting Started - Notifications
    • Notifications Overview
    • Types of events
    • Notifications delivery methods
  • User Guides - Notifications
    • E-mail notifications setup
    • Webhook notifications
    • Amazon SNS Notifications
    • Google Pub/Sub Notifications
    • Azure Event Grid Notifications

Identity and Access Management

  • Getting Started - Identity and Access Management
    • User and service accounts
    • Available policy templates and permissions
    • Walk-through – create a service account for Flip and QC services
  • User Guides - Identity and Access Management
    • Adding new service account to Telestream Cloud
    • Adding new Telestream Cloud user
    • Adding Multi-Factor Authentication
    • Beta: SSO enablement (SAML 2.0)

Qualify

  • Qualify User Guide
  • Qualify Developer Guide
    • Qualify API Usage

Using the API

Suggest Edits

In the Getting Started section you used the Transform web console to create a factory, create a template and submit a job. The web console uses the Transform REST API to perform these tasks.

This section demonstrates how to use the API directly from your media supply chain.

Updated about 2 years ago


What’s Next
  • Authenticating a Request
  • Creating a Factory
  • Creating a Template
  • Submitting a Job
  • Submitting a Composition