26 February 2026

Speech-to-Text Conversion

High-accuracy transcription of audio to text

<?xml version="1.0"?>
<query>
    <userid>[UserID]</userid> <!-- required -->
    <userkey>[UserKey]</userkey> <!-- required -->
    <action>[Action]</action> <!-- required -->
    <source>[SourceFile]</source> <!-- required -->
    <format>
        <output>closed_captions</output> <!-- required-->
        <stt> 
            <model>[base|tiny|small|medium|largev2|largev3]</model> 
            <language>[LanguageCode]</language> 
            <prompt></prompt> 
            <refine_timing>[yes|no]</refine_timing>
            <audio_stream>
                [AudioStreamDefinition]
            </audio_stream>
        </stt>
    </format>
</query>

{
  "query": {
    "userid": "[UserID]", // required
    "userkey": "[UserKey]", // required
    "action": "[Action]", // required
    "source": "[SourceFile]", // required
    "format": {
      "output": "closed_captions",
      "stt": {
        "model": "[base|tiny|small|medium|largev2|largev3]",
        "language": "[LanguageCode]",
        "prompt": "",
        "refine_timing": "[yes|no]",
        "audio_stream": {
          [AudioStreamDefinition]
        }
      }
    }
  }
}

Parameter	Description	Allowed Values	Default Value
model	Language model to use	base, tiny, small, medium, largev2, largev3 (experimental)	largev2
language	Language of speech	2 or 3 characters language code	none
prompt	Prompt for speech to text conversion	Text	none
refine_timing	Refine timing	yes, no	no
audio_stream	Define audio stream to handle	see Audio Stream definition

Caption Legal Adaptation & Compliance

Adjusting captions to regulatory requirements. More details

<?xml version="1.0"?>
<query>
    <userid>[UserID]</userid> <!-- required -->
    <userkey>[UserKey]</userkey> <!-- required -->
    <action>[Action]</action> <!-- required -->
    <source>[SourceFile]</source> <!-- required -->
    <format>
        <output>closed_captions</output> <!-- required-->
        <legalize> 
            <mode>[cea-608|teletext|custom]</mode> 
            <max_line_count>[MaxLineCount]</max_line_count> 
            <max_line_length>[MaxLineLength]</max_line_length> 
            <min_duration>[MinDuration]</min_duration> 
            <max_duration>[MaxDuration]</max_duration> 
            <max_cps>[MaxCPS]</max_cps> 
        </legalize>
    </format>
</query>

{
  "query": {
    "userid": "[UserID]", // required
    "userkey": "[UserKey]", // required
    "action": "[Action]", // required
    "source": "[SourceFile]", // required
    "format": {
      "output": "closed_captions",
      "legalize": {
        "mode": "[cea-608|teletext|custom]",
        "max_line_count": "[MaxLineCount]",
        "max_line_length": "[MaxLineLength]",
        "min_duration": "[MinDuration]",
        "max_cps": "[MaxCPS]"
      }
    }
  }
}

Parameter	Description	Allowed Values	Default Value
mode	CEA-608: 4 lines and 32 characters per item, Teletext: 4 lines and 37 characters, Custom: custom number of lines and characters	cea-608, teletext, custom	none
max_line_count	Max line count	Positive integer	none
max_line_length	Max line length	Positive integer	none
min_duration	Min duration	Positive integer	none
max_duration	Max duration	Positive integer	none
max_cps	Max characters per second	Positive integer	none

Upgrade Qualify Template

Upgrades a specified Qualify Template to the latest version or a specific target version.

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<query>
    <userid>[UserID]</userid> <!-- required -->
    <userkey>[UserKey]</userkey> <!-- required -->
    <action>UpgradeQualifyTemplate</action> <!-- required -->
	<version_to>[VersionToUpgrade]</version_to>
	<template><![CDATA[
		{
			"name": "[TemplateName]",
			"tests": {
				[TestsList]
			},
			"package_layout": {
				// package_layout params
			},
			"audio_layout": {
				// audio_layout params
			}
        }
	]]></template> <!-- required -->
</query>

{
  "query": {
    "userid": "[UserID]",
    "userkey": "[UserKey]",
    "action": "UpgradeQualifyTemplate",
    "version_to": "[VersionToUpgrade]",
    "template": {
      "name": "[TemplateName]",
      "tests": {
        "//": "[TestsList]"
      },
      "package_layout": {
        "//": "package_layout params"
      },
      "audio_layout": {
        "//": "audio_layout params"
      }
    }
  }
}

Parameter	Description	Allowed Values	Default Value
version_to	The target version for the upgrade.	Supported Engine Versions	Latest stable version
template	The Qualify Template object to be upgraded.	JSON Object / CDATA	(Required)