API Reference

The Vocalware API enables you to use our cloud based Text-To-Speech service, to generate & play audio in real-time within your online application. By the term “online application” we refer to any online program, including: web pages, or native code apps on either desktop, server or mobile device. The only requirement is that your application has access to an internet connection fast enough to stream 48kbps audio.

The Vocalware API allows you to generate audio and control audio playback. The API comes in two flavors: JavaScript/HTML5, and HTTP-REST - so it can be easily incorporated into any application. Whether your application runs in-browser or standalone, on mobile, desktop or server - one of our API flavors will work for you.

The Vocalware API supports TTS in over 20 languages, with several voices available in most. The API allows you to specify the language and voice to use, as well as optional audio effects such as pitch, echo, etc.

Select the API Flavor to Use

The API comes in two flavors:

1. JavaScript/HTML5 - also referred to as the JavaScript API
2. HTTP-REST - also referred to ad the HTTP API

To proceed, you should first identify the section of this document that refers to the API flavor you plan to use. The JavaScript API is covered by the first section of this guide. The HTTP API is covered by the second section.

How to select the API flavor that’s right for you? Here are rules of thumb:

1. in your web pages – use the JavaScript API (supports mobile browsers as well)
2. in your standalone (out of browser) app, including mobile app - use the HTTP API
3. on your server – use the HTTP API

 

Note: Whether mobile, desktop or server, the decision boils down to whether your intended use is within a web browser or not. If it is, use the JS APIs. If it is not – use the HTTP API.

Download the entire Vocalware API Reference Document