Jump to Content
Release Notes
User Interface
System Status
Guides
API Reference
Recent API Changes
v2025.10.2
v2025.11.1
v2025.11.2
v2025.12.1
v2025.12.2
v2026.1.1
Release Notes
User Interface
System Status
Log In
API Reference
Log In
v2026.1.1
Guides
API Reference
Recent API Changes
Animated GIF
All
Pages
Start typing to search…
JUMP TO
API Overview
Welcome, Developers and Video Engineers!
Workflow Overview
End Point
Authentication
Sample MP4 Template
Sample HLS Template
Complete Request Template
Test Your XML or JSON Request in Your Browser
Code Libraries
Simple Curl
PHP
JAVA
ColdFusion
C#
Unofficial API Wrappers
API Main Fields
Authentication
Action List
MediaID
Source Media Locations
Source File Clipping
Advanced Source Mapping
Blank Frames Insertion
Source File Overlay
Vantage CML Playlist File
Source Media Decryption
Notifications
Notify Response Format
Notify_upload Response Format
QC notify Response Format
Global Processing Regions
Automatic Selection
Request Metadata
Ludicrous Mode
Video Quality Metrics Report
API Output Format Parameters
Output Formats
Input Formats
Using and Creating Output Presets
Video Settings
Apple ProRes
Mainconcepts Broadcast MXF
CableLabs®
Beamr CABR Encoding
HDR
HDR 10
Dolby Vision®
HLG
Mux HDR10 Metadata
Webm Video Codecs
Libvpx VP9
VP8/VP9
Audio Settings
Audio Multitrack Settings
Audio Descriptors
MPEG-TS Audio Component Descriptor
MPEG-TS Supplementary Audio Descriptor
AC3 Descriptor
EAC3 Descriptor
Duration Settings
Nielsen Watermarking
Nielsen PCM to ID3 Conversion
Nielsen Watermarking Audio Injection
Output Destinations
Output Encryption
Other Format Options
Waveform
Extended Data Services Data
Apple QT RLE
Advanced Video Codec Parameters
H.264
Frame-Type Options
Ratecontrol
Analysis
Usability
HEVC
MPEG2
XDCAM
AV1
AV1 libaom
AV1 libsvtav1
Mainconcept AVC
Dolby Audio
Dolby Audio Processing
Downmix
Loudness Control
Audio Quality
Surround
AAC Encoding
Dolby Atmos®
Dolby Atmos® Master Files: DAMF or ADM BWF
Dolby Atmos® JOC Source
Dolby Atmos® Output
DolbyE
Advanced Adaptive Bitrate Encoding
Introduction
Sample Request
Alternate Source
Byte-range
I-Frame Playlist
Specific Options for advanced_hls and fmp4_hls Outputs
Specific Options for advanced_dash Output
Specific Options for advanced_mss Output
Specific Options for advanced_fmp4 Output
Main Manifest Parameters
Stream Manifest Parameters
Main Source Parameters
Alternate Source Parameters
Ad Breaks
Automatic Ad Breaks
Custom Ad Breaks
HLS Manifest Example
DASH Manifest Example
VTT Thumbnail Parameters
Image Playlist Parameters
ROKU BIF Thumbnail Format
Stream Parameters
Format Parameters
Output summary (Output JSON)
Adaptive Intermediate
Introduction
Intermediate HLS Destination
Intermediate Output Files
Repackaging from Intermediate
Digital Rights Management
FlashAccess DRM
KeyOS for PlayReady DRM
Widevine DRM Packager
Atlas DRM
BuyDRM KeyOS CPIX
B-HLS Content Encryption
Playout, Graphics, & Editing
Video Clipping
Thumbnail Capture
Thumbnails Set
Watermarking
Concatenation
Video Rotation
Cropping
Auto Crop
Padding
Black Frame Detection
Fade In/Out
Muxing
Metadata
Split Screen
Overlay
Video Overlay
Audio Overlay
Text Overlay
Image Transformation
Animated GIF
Ken Burns Slideshow Effect
Slideshow
Burn-In Timecode
QuickTime Timecode
Multijob Workflow
Audio Stream Validation and Automatic Repair
Closed Captions
Closed Captions
Caption to Caption Conversion
Quality Control
Introduction
Available Tests
QC Request Template
Get QC Status
QC Auto
Auto Tests List
Conditions
QC Only
QC General Tests
Duration
File Size
Bitrate
Bitrate Mode
Validate Closed Captions
No Short Segments
CMAF Conformance
Baton Validation
Qualify Validation
Video Quality Metrics
QC Video Tests
Video Codec
Video Bitrate
Frame Rate
Video Duration
Video Codec Profile
Video Level
Frame Size
Aspect Ratio
Video Streams Count
Validate DTS
Validate PTS
PCR Interval
PID Interval
Validate B-Frames
Validate B-Frames DTS Increase
Validate IDR Interval
Segment Starts with IDR
Blank Frames Detection
Detect Frames Freeze
QC Audio Tests
Audio Codec
Audio Bitrate
Audio Duration
Audio Sample Rate
Audio Channels
Audio Channel Layout
Audio Stream Validation
QC Manifest Tests
Master Manifest Bitrate
Master Manifest Codec
Validate Discontinuity Tags
Validate DRM URI
Validate HLS Version
Validate CUE-OUT:0 Placement
Validate Sample AES Encryption
Validate Segment Duration
Validate Declared Segment Duration
CUE-inserts validation
MPD manifest is valid
Miscellaneous Requests
GetQueueTime
GetQueueStats
GetPresetsList
GetPreset
SavePreset
Delete Preset
GetReservedInfo
SetHostKey
Sub-Account Management
Introduction
Actions
Parameters
Sample Requests
Sample Responses
Errors
API Responses
Introduction
AddMedia
GetMediaList
Version 1 (default)
Version 2
Version 3
GetStatus
GetStatus (extended)
GetTaskStatus
GetMediaInfo
GetMediaInfoEx
Other Actions
API Error Responses
Common Errors
Media Errors
Queue Errors
Encoding Error Codes
Status API
Introduction
Current Status
Status History
Animated GIF
Ask AI
Create animated GIF snippets from your source video.
