Complete Request Template

Here is a complete request sample to get you started.

<?xml version="1.0"?>
<query>
<!-- Main fields -->
    <userid><<i>></userid>
    <userkey>[UserKey]</userkey>
    <action>[Action]</action>
    <mediaid>[MediaID]</mediaid>
    <source>[SourceFile]</source>
 
    <!-- if multiple SourceFile added, they will be concatenated or join to split screen-->
    <source>[SourceFile1]</source>
    <!-- ... -->
    <source>[SourceFileN]</source>
 
    <!-- Split Screen fields (OPTIONAL) -->
    <split_screen>
        <columns>[ColumnsNumber]</columns>
        <rows>[RowsNumber]</rows>
        <padding_left>[PaddingLeftInPx]</padding_left>
        <padding_right>[PaddingRightInPx]</padding_right>
        <padding_bottom>[PaddingBottomInPx]</padding_bottom>
        <padding_top>[PaddingTopInPx]</padding_top>
    </split_screen>
 
    <region>[us-east-1|us-east-2|us-west-1|us-west-2|eu-west-1|eu-central-1|ap-southeast-1|ap-southeast-2|ap-northeast-1|sa-east-1]</region> 
    <notify_format>[xml|json]</notify_format>
    <notify>[NotifyURL]</notify>
    <notify_encoding_errors>[NotifyEncodingErrorURL]</notify_encoding_errors>
    <notify_upload>[NotifyUploadURL]</notify_upload>
    <notify_live_start>[NotifyLiveStartedURL]</notify_live_start>
    <qc_notify>[QCNotifyURL]</qc_notify>
    <format>
 
        <!-- Format fields -->
        <noise_reduction>luma_spatial:chroma_spatial:luma_temp</noise_reduction>
        <output>[Output format]</output>
        <video_codec>[Video Codec]</video_codec>
        <audio_codec>[Audio Codec]</audio_codec>
        <bitrate>[Video bitrate]</bitrate>
        <audio_bitrate>[Audio bitrate]</audio_bitrate>
        <audio_sample_rate>[Audio quality]</audio_sample_rate>
        <audio_channels_number>[Audio channels number]</audio_channels_number>
        <audio_volume>[Volume]</audio_volume>   
        <copy_audio_streams>[Audio streams]</copy_audio_streams>   
        <framerate>[Frame Rate]</framerate>
        <framerate_upper_threshold>[Frame Rate Upper Threshold]</framerate_upper_threshold>
        <size>[Size]</size>
        <fade_in>[FadeInStart:FadeInDuration]</fade_in>
        <fade_out>[FadeOutStart:FadeOutDuration]</fade_out>
        <crop_left>[Crop Left]</crop_left>
        <crop_top>[Crop Top]</crop_top>
        <crop_right>[Crop Right]</crop_right>
        <crop_bottom>[Crop Bottom]</crop_bottom>
        <keep_aspect_ratio>[yes|no]</keep_aspect_ratio>
        <set_aspect_ratio>[ASPECT_RATIO|source]</set_aspect_ratio>
        <add_meta>[yes/no]</add_meta>
        <hint>[yes/no]</hint>
        <rc_init_occupancy>[RC Occupancy]</rc_init_occupancy>
        <minrate>[Min Rate]</minrate>
        <maxrate>[Max Rate]</maxrate>
        <bufsize>[RC Buffer Size]</bufsize>
        <keyframe>[Keyframe Period (GOP)]</keyframe>
        <start>[Start From]</start>
        <duration>[Result Duration]</duration>
        <output>mpeg2</output>
        <force_keyframes>[Keyframe Period]</force_keyframes>
        <!-- Every Nth frame <force_keyframes>*/N</force_keyframes>-->
        <!-- Specified position for keyframes <force_keyframes>1,100,230,555</force_keyframes>-->
        <bframes>[2|0]</bframes>
        <gop>[cgop|sgop]</gop> 
        <output>[PRESET_NAME]</output>
 
        <!-- Metadata fields (OPTIONAL) -->
        <metadata> 
            <title>[Title]</title>
            <copyright>[Copyright]</copyright> 
            <author>[Author]</author> 
            <description>[Description]</description> 
            <album>[Album]</album> 
        </metadata> 
 
        <!-- Destination fields --> 
        <destination>[DestFile]</destination> 
        <destination>[DestFile2]</destination> 
        <!-- ... -->
        <destination>[DestFileN]</destination>
 
        <!-- Logo fields (OPTIONAL) --> 
        <logo> 
             <logo_source>[LogoURL]</logo_source> 
             <logo_x>[LogoLeft]</logo_x> 
             <logo_y>[LogoTop]</logo_y> 
             <logo_mode>[LogoMode]</logo_mode> 
             <logo_threshold>[LogoTreshold]</logo_threshold> 
        </logo>
 
        <!-- Overlay fields (OPTIONAL) -->
        <overlay>
            <overlay_source>[Overlay1Source]</overlay_source>
            <overlay_left>[Overlay1PositionXfromLeft]</overlay_left>
            <overlay_right>[Overlay1PositionXfromRight]</overlay_right>
            <overlay_top>[Overlay1PositionYfromTop]</overlay_top>
            <overlay_bottom>[Overlay1PositionYfromBottom]</overlay_bottom>
            <size>[Overlay1Size]</size>
            <overlay_start>[OverlayNStartInSeconds]</overlay_start>
            <overlay_duration>[OverlayNDurationInSeconds]</overlay_duration>
        </overlay>
        <!-- ... -->
        <overlay>
            <overlay_source>[OverlayNSource]</overlay_source>
            <overlay_left>[OverlayNPositionXfromLeft]</overlay_left>
            <overlay_right>[OverlayNPositionXfromRight]</overlay_right>
            <overlay_top>[OverlayNPositionYfromTop]</overlay_top>
            <overlay_bottom>[OverlayNPositionYfromBottom]</overlay_bottom>
            <size>[OverlayNSize]</size>
            <overlay_start>[OverlayNStartInSeconds]</overlay_start>
            <overlay_duration>[OverlayNDurationInSeconds]</overlay_duration>
        </overlay>    
    
        <!-- Text Overlay fields (OPTIONAL) -->
        <text_overlay>
            <text>[Text1]</text>
            <font_source>[Font1Source]</font_source>
            <font_size>[Font1Size]</font_size>
            <font_rotate>[Font1Rotate]</font_rotate>
            <font_color>[Font1Color]</font_color>
            <align_center>[0|1]</align_center>
            <overlay_x>[TextOverlay1PositionX]</overlay_x>
            <overlay_y>[TextOverlay1PositionY]</overlay_y>
            <size>[TextOverlay1Size]</size>
            <overlay_start>[TextOverlay1StartInSeconds]</overlay_start>
            <overlay_duration>[TextOverlay1DurationInSeconds]</overlay_duration>
        </text_overlay>
        <!-- ... -->
        <text_overlay>
            <text>[TextN]</text>
            <font_source>[FontNSource]</font_source>
            <font_size>[FontNSize]</font_size>
            <font_rotate>[FontNRotate]</font_rotate>
            <font_color>[FontNColor]</font_color>
            <align_center>[0|1]</align_center>
            <overlay_x>[TextOverlayNPositionX]</overlay_x>
            <overlay_y>[TextOverlayNPositionY]</overlay_y>
            <size>[TextOverlayNSize]</size>
            <overlay_start>[TextOverlayNStartInSeconds]</overlay_start>
            <overlay_duration>[TextOverlayNDurationInSeconds]</overlay_duration>
        </text_overlay>
 
        
        <!-- Video codec parameters (OPTIONAL, while only for libx264 video codec) --> 
        <video_codec_parameters> To see the example for parameters please follow this link below * </video_codec_parameters> 
 
        <!-- Profile (OPTIONAL, while only for libx264 video codec) --> 
        <profile>[high|main|baseline]</profile>
 
        <!-- Turbo Encoding switch (OPTIONAL) --> 
        <turbo>[yes|no]</turbo>
 
        <!-- Video rotation (OPTIONAL) -->
        <rotate>def|0|90|270</rotate>
        <set_rotate>def|0|90|270</set_rotate>
 
        <audio_sync>[1..N]</audio_sync> 
        <video_sync>old|passthrough|cfr|vfr|auto</video_sync>
        <force_interlaced>tff|bff|no</force_interlaced>
        <strip_chapters>[yes|no]</strip_chapters> 
    </format> 
</query>
{
    "query": {
        "userid": "[UserID]",
        "userkey": "[UserKey]",
        "action": "[Action]",
        "mediaid": "[MediaID]",
        "source": [
            "[SourceFile]",
            "[SourceFile1]",
            "[SourceFileN]"
        ],
        "split_screen": {
            "columns": "[ColumnsNumber]",
            "rows": "[RowsNumber]",
            "padding_left": "[PaddingLeftInPx]",
            "padding_right": "[PaddingRightInPx]",
            "padding_bottom": "[PaddingBottomInPx]",
            "padding_top": "[PaddingTopInPx]"
        },
        "region": "[us-east-1|us-east-2|us-west-1|us-west-2|eu-west-1|eu-central-1|ap-southeast-1|ap-southeast-2|ap-northeast-1|sa-east-1]",
        "notify_format": "[xml|json]",
        "notify": "[NotifyURL]",
        "notify_encoding_errors": "[NotifyEncodingErrorURL]",
        "notify_upload": "[NotifyUploadURL]",
        "notify_live_start": "[NotifyLiveStartedURL]",
        "qc_notify": "[QCNotifyURL]",
        "format": {
            "noise_reduction": "luma_spatial:chroma_spatial:luma_temp",
            "output": [
                "[Output format]",
                "mpeg2",
                "[PRESET_NAME]"
            ],
            "video_codec": "[Video Codec]",
            "audio_codec": "[Audio Codec]",
            "bitrate": "[Video bitrate]",
            "audio_bitrate": "[Audio bitrate]",
            "audio_sample_rate": "[Audio quality]",
            "audio_channels_number": "[Audio channels number]",
            "audio_volume": "[Volume]",
            "copy_audio_streams": "[Audio streams]",
            "framerate": "[Frame Rate]",
            "framerate_upper_threshold": "[Frame Rate Upper Threshold]",
            "size": "[Size]",
            "fade_in": "[FadeInStart:FadeInDuration]",
            "fade_out": "[FadeOutStart:FadeOutDuration]",
            "crop_left": "[Crop Left]",
            "crop_top": "[Crop Top]",
            "crop_right": "[Crop Right]",
            "crop_bottom": "[Crop Bottom]",
            "keep_aspect_ratio": "[yes|no]",
            "set_aspect_ratio": "[ASPECT_RATIO|source]",
            "add_meta": "[yes/no]",
            "hint": "[yes/no]",
            "rc_init_occupancy": "[RC Occupancy]",
            "minrate": "[Min Rate]",
            "maxrate": "[Max Rate]",
            "bufsize": "[RC Buffer Size]",
            "keyframe": "[Keyframe Period (GOP)]",
            "start": "[Start From]",
            "duration": "[Result Duration]",
            "force_keyframes": "[Keyframe Period]",
            "bframes": "[2|0]",
            "gop": "[cgop|sgop]",
            "metadata": {
                "title": "[Title]",
                "copyright": "[Copyright]",
                "author": "[Author]",
                "description": "[Description]",
                "album": "[Album]"
            },
            "destination": [
                "[DestFile]",
                "[DestFile2]",
                "[DestFileN]"
            ],
            "logo": {
                "logo_source": "[LogoURL]",
                "logo_x": "[LogoLeft]",
                "logo_y": "[LogoTop]",
                "logo_mode": "[LogoMode]",
                "logo_threshold": "[LogoTreshold]"
            },
            "overlay": [
                {
                    "overlay_source": "[Overlay1Source]",
                    "overlay_left": "[Overlay1PositionXfromLeft]",
                    "overlay_right": "[Overlay1PositionXfromRight]",
                    "overlay_top": "[Overlay1PositionYfromTop]",
                    "overlay_bottom": "[Overlay1PositionYfromBottom]",
                    "size": "[Overlay1Size]",
                    "overlay_start": "[OverlayNStartInSeconds]",
                    "overlay_duration": "[OverlayNDurationInSeconds]"
                },
                {
                    "overlay_source": "[OverlayNSource]",
                    "overlay_left": "[OverlayNPositionXfromLeft]",
                    "overlay_right": "[OverlayNPositionXfromRight]",
                    "overlay_top": "[OverlayNPositionYfromTop]",
                    "overlay_bottom": "[OverlayNPositionYfromBottom]",
                    "size": "[OverlayNSize]",
                    "overlay_start": "[OverlayNStartInSeconds]",
                    "overlay_duration": "[OverlayNDurationInSeconds]"
                }
            ],
            "text_overlay": [
                {
                    "text": "[Text1]",
                    "font_source": "[Font1Source]",
                    "font_size": "[Font1Size]",
                    "font_rotate": "[Font1Rotate]",
                    "font_color": "[Font1Color]",
                    "align_center": "[0|1]",
                    "overlay_x": "[TextOverlay1PositionX]",
                    "overlay_y": "[TextOverlay1PositionY]",
                    "size": "[TextOverlay1Size]",
                    "overlay_start": "[TextOverlay1StartInSeconds]",
                    "overlay_duration": "[TextOverlay1DurationInSeconds]"
                },
                {
                    "text": "[TextN]",
                    "font_source": "[FontNSource]",
                    "font_size": "[FontNSize]",
                    "font_rotate": "[FontNRotate]",
                    "font_color": "[FontNColor]",
                    "align_center": "[0|1]",
                    "overlay_x": "[TextOverlayNPositionX]",
                    "overlay_y": "[TextOverlayNPositionY]",
                    "size": "[TextOverlayNSize]",
                    "overlay_start": "[TextOverlayNStartInSeconds]",
                    "overlay_duration": "[TextOverlayNDurationInSeconds]"
                }
            ],
            "video_codec_parameters": "To see the example for parameters please follow this link below *",
            "profile": "[high|main|baseline]",
            "turbo": "[yes|no]",
            "rotate": "def|0|90|270",
            "set_rotate": "def|0|90|270",
            "audio_sync": "[1..N]",
            "video_sync": "old|passthrough|cfr|vfr|auto",
            "force_interlaced": "tff|bff|no",
            "strip_chapters": "[yes|no]"
        }
    }
}