This is the documentation for a previous version of our product. Click here to see the latest version.

Batch Virtual Appliance

High-Level Summary

This release adds HTTPS support for the appliance REST APIs, with the ability to upload your own security certificates. TLS 1.2 and 1.3 are supported; certificates and keys that are uploaded should be in the PKCS #8 format.

The following languages now support advanced punctuation: English (en), German (de), Spanish (es), French (fr), Dutch (nl), Danish (da), Turkish (tr) and Malay (ms).

It is recommended that customers on previous releases upgrade to this version.

Important Notices

The legacy V1 API that the Batch Virtual Appliance currently supports will be discontinued in a future release as we align the product with the same V2 API used by the Speechmatics SaaS: We recommend that customers familiarise themselves with the configuration object used to specify job configurations, and only use form parameters for callback notifications. Future notices will be provided to announce the end of life of the V1 API, and provide detailed instructions on migrations to the V2 API.

What's New

  • HTTPS for Management, Monitoring and Speech APIs
  • For the English language model, numbers less than 10 are output as words ('zero', 'one', 'two', etc)
  • Improved localised spellings for en-GB and en-US output locales

Issues Fixed

The following issues are addressed since the previous release:

Issue IDSummaryResolution Description
REQ-12489The en-GB output locale sometimes outputs en-US spellingsThe latest rebuild of English (en) addresses this issue.
REQ-12183Callback transcriptions from Batch Appliance do not include Jobs sectionThis has now been resolved; the job section is now included as part of the JSON transcript when a callback notification is used.
REQ-13430Virtual Appliance conflict of internal (docker) and customer subnetsA smaller subnet is now used to reduce the likelihood of conflicts.
REQ-9838batch_jobs_api will let you set channel_diarization_labels regardless of diarization typeThe inconsistency in the Speech API that allowed you to set channel_diarization_labels even if you weren't using channel diarisation has been resolved; this is no longer possible.
REQ-12405English Transcription Includes Russian WordsThe latest rebuild of English (en) addresses this issue.

Known Limitations

The following are known issues in this release:

Issue IDSummaryDetailed Description and Possible Workarounds
REQ-1409Proteus HCL with <unk> causes out of memory errorA custom dictionary list that contains the word '' causes the worker to crash.
REQ-7549Memory leak affecting gRPCThere is a small memory leak in the gRPC Python server (
REQ-10160Advanced punctuation for Spanish (es) does not contain inverted marks.Inverted marks [ ¿ ¡ ] are not currently available for Spanish advanced punctuation.
REQ-10627Double full stops when acronym is at the end of the sentenceIf there is an acronym at the end of the sentence, then a double full stop will be output, for example: "team G.B.."
REQ-111353.2.0 introduced unwanted hesitations in transcripts for English (en).Due to changes in the way that training data is now ingested to improve the accuracy of spontaneous speech for English (en) there is a greater likelihood that hesitations will be included in the output transcrtips. We plan to support a hesitation filtering capability in a future release for customers that do not want to see hesitations on transcripts.

Supported Platforms

Virtual Appliance image (OVA) for installation on:

  • VMware ESXi 6.5+ or VMware Workstation Player.
  • VirtualBox 5.2+
  • Amazon EC2

See the Installation and Admin Guide for details on the minimum specifications for the VM. The maximum number of concurrent jobs (maxworkers) that you can run on a single appliance is 32.

Form Factors

VariantImage SizeMax. Disk SpaceLanguages
mini21GB40GBen, de, es
midi41GB60GBen, de, es, fr, ko, ja, nl, pt
maxi65GB80GBen, de, es, fr, ko, ja, nl, pt, it, da, pl, ca, hi, ru, sv
plus75GB80GBen, cmn, no, ar, bg, cs, el, fi, hu, hr, lt, lv, ro, sk, sl, tr, ms

Upgrade Path

Remove the license from your old appliance (see the Admin Guide), then re-import the new OVA and configure networking as per the Installation and Admin guide. You will need to re-apply the license code you have once the OVA has imported.


Upload the OVA to VMWare ESX, VMWare Workstation Player, or VirtualBox. See the Installation and Admin Guide for more information.