Windows API



Complete documentation for the LumenVox Speech Engine and API is available in our online help file


Total Time:
20-55 Minutes

Get Started – Windows API

If you're developing a custom application with the LumenVox Speech Engine or integrating it into your telephony platform, you'll want to take advantage of our published API.

This page describes how to install our software on Windows and then how to build and run a simple C++ application that uses our API (see also our instructions on doing this on Linux). By the time you're done — less than an hour's work — you will have a working application.

Want proof that it's really this fast?

Watch a timed video of the process, which you can use as a visual aide.

Play Video

Download and Install LumenVox

5–25 Minutes

  1. Open a Web browser and go to and log in with your username and password (email us if you've misplaced it or didn't receive it).
  2. Before you can download your software, you have to deploy it. A deployment is just a group of licenses (or even one single license) that will be on the same machine. To create a deployment, click on Your Account Information.
  3. Click Create New Deployment and assign at least one license to the deployment. Optionally, you may add information like a computer name and a location to help keep track of where you are putting these licenses. Make sure that the license is a Platform license.
  4. Click Back to Welcome Screen at the top of the page once you have saved the deployment.
  5. Click on Your Software Downloads to be taken to the download page. Download the License Server and the Speech Engine. The Speech Engine is a large file, so it may take a while to download.
  6. Once they have all downloaded, run the Speech Engine installer you downloaded. The installer will walk you through the setup. Once it has finished, reboot your computer.
  7. Now run the License Server installer applications. You do not need to reboot once they're done.

Installing a License

5–10 Minutes

  1. The first thing you need to do is generate a file called Info.bts that will save some information about your system. Run the License Administrator by going to Start > Programs > LumenVox > Product > License Administrator.
  2. Click Connect and then click Create Server ID File. This saves the Info.bts file to C:\Program Files\Lumenvox\License Server\
  3. Open a Web browser and go to and log in.
  4. Go to your Account Information and find the deployment you made earlier. Click License Upload. Deployments
  5. In the License Upload screen, click Browse, select your Info.bts file, and upload it.
  6. Go back to your account screen and find that deployment — the License Upload link has turned into License Download. Click it and save the LicenseXXXX.bts ( XXXX is a 4–digit number) file.
  7. Back in the License Administrator, click Install License. Select the LicenseXXXX.bts file you downloaded to install it.

Running LVSpeechPortConsole

10–20 Minutes

  1. LumenVox includes a simple C++ application that will take a grammar (a list of words and phrases to be recognized by the Speech Engine) and allow you to have your voice recognized. You must have a microphone hooked up to your computer to use this.
  2. The sample program is called LVSpeechPortConsole and is located in
    C:\Program Files\Lumenvox\Engine\Examples\LVSpeechPortConsole\. Using your IDE of choice (this document assumes you are using Microsoft Visual Studio), open the LVSpeechPortConsole.dsw file. Note that this project was originally created in Visual Studio 6; if you are using a more recent version you will need to first convert the workspace file to your version.
  3. Once you have opened the project, you can build and run it without modification.
  4. The application runs in a console window. By default you can press a key and then say any state name in the United States. The application will then display what it recognized you saying and you can confirm it by saying yes or no.


Congratulations! You are now getting back results using your own voice. You can now try other audio files and grammars (look at /opt/lumenvox/engine/Lang/BuiltinGrammars/ for more built grammars).

© 2018 LumenVox, LLC. All rights reserved.