Woord provides a simple API delivering audio files from any text input. Get your ACCESS_KEY here.


API Access Key & Authentication

After signing up, every user is assigned a personal API access key, a unique combination of letters and digits provided to access to our API endpoint. To authenticate with the Woord API, simply attach your access_key to your preferred endpoint URL.

API Features

Object Description
access_key [Required] Your API Access Key.
text [Required] Your text content. 10000 characters limit for any plan.
gender_voice [Required] Gender voice. Options: male, female or neutral
language [Required] Language. Options: en_US, en_GB, en_IN, en_AU, pt_BR,pt_PT, fr_FR, fr_CA, de_DE, es_ES, sv_SE, ru_RU or tr_TR. Please add "text_premium_" (if text content) or "ssml_premium_" (if SSML code) before the language code if you want to use the premium voice (for e.g. for en_US will be text_premium_en_US)
speakingRate [Optional] Speaking rate/speed. Options are in the range [0.25, 4.0]. 1.0 is the normal native speed supported by the specific voice.

Example API Request:

 curl 'https://www.getwoord.com/api/convert' -X POST  -H 'Accept: application/json' -H 'Authorization: Bearer ACCESS_KEY' --data $'text=Hello+World&gender_voice=male&language=en_US&speakingRate=1.00&effectsProfileId=telephony-class-application'

Example API Response:

{"message":"Your audio has been created!","audio_src":"https:\/\/getwoord.s3.amazonaws.com\/4273352455515882618255eaaf3c1cbdbe0.55443890.mp3","error":false}

API Features

Property Description
message Returns an error message or success message depending on whether or not your query succeeds.
audio_src Returns the URL of the audio generated
error Returns true or false depending on whether or not your query succeeds.