Text to Speech launch job

post

https://api.edenai.run/v2/audio/text_to_speech_async/

Available Providers

Provider	Model	Version	Price	Billing unit
lovoai	-	`v1`	0.16 (per 1000 char)	1 char
amazon	-	`boto3 (v1.15.18)`	4.0 (per 1000000 char)	1 char
amazon	Neural	`boto3 (v1.15.18)`	16.0 (per 1000000 char)	1 char

Supported Languages

Name	Value
Afrikaans	`af`
Albanian	`sq`
Amharic	`am`
Arabic	`ar`
Armenian	`hy`
Azerbaijani	`az`
Basque	`eu`
Bengali	`bn`
Bosnian	`bs`
Burmese	`my`
Catalan	`ca`
Chinese	`zh`
Croatian	`hr`
Czech	`cs`
Danish	`da`
Dutch	`nl`
English	`en`
Estonian	`et`
Filipino	`fil`
Finnish	`fi`
French	`fr`
Galician	`gl`
Georgian	`ka`
German	`de`
Hebrew	`he`
Hindi	`hi`
Hungarian	`hu`
Icelandic	`is`
Indonesian	`id`
Irish	`ga`
Italian	`it`
Japanese	`ja`
Javanese	`jv`
Kazakh	`kk`
Khmer	`km`
Korean	`ko`
Lao	`lo`
Latvian	`lv`
Lithuanian	`lt`
Macedonian	`mk`
Malay (macrolanguage)	`ms`
Malayalam	`ml`
Maltese	`mt`
Mandarin Chinese	`cmn`
Marathi	`mr`
Mongolian	`mn`
Nepali (macrolanguage)	`ne`
Norwegian Bokmål	`nb`
Persian	`fa`
Polish	`pl`
Portuguese	`pt`
Pushto	`ps`
Romanian	`ro`
Russian	`ru`
Serbian	`sr`
Sinhala	`si`
Slovak	`sk`
Slovenian	`sl`
Somali	`so`
Spanish	`es`
Standard Arabic	`arb`
Sundanese	`su`
Swahili (macrolanguage)	`sw`
Swedish	`sv`
Tamil	`ta`
Telugu	`te`
Thai	`th`
Turkish	`tr`
Ukrainian	`uk`
Urdu	`ur`
Uzbek	`uz`
Vietnamese	`vi`
Welsh	`cy`
Wu Chinese	`wuu`
Xhosa	`xh`
Yue Chinese	`yue`
Zulu	`zu`

Supported Detailed Languages

Name	Value
Afrikaans (South Africa)	`af-ZA`
Albanian (Albania)	`sq-AL`
Amharic (Ethiopia)	`am-ET`
Arabic (Algeria)	`ar-DZ`
Arabic (Bahrain)	`ar-BH`
Arabic (Egypt)	`ar-EG`
Arabic (Iraq)	`ar-IQ`
Arabic (Jordan)	`ar-JO`
Arabic (Kuwait)	`ar-KW`
Arabic (Lebanon)	`ar-LB`
Arabic (Libya)	`ar-LY`
Arabic (Morocco)	`ar-MA`
Arabic (Oman)	`ar-OM`
Arabic (Qatar)	`ar-QA`
Arabic (Saudi Arabia)	`ar-SA`
Arabic (Tunisia)	`ar-TN`
Arabic (United Arab Emirates)	`ar-AE`
Armenian (Armenia)	`hy-AM`
Azerbaijani (Azerbaijan)	`az-AZ`
Bangla (India)	`bn-IN`
Basque (Spain)	`eu-ES`
Bosnian (Bosnia & Herzegovina)	`bs-BA`
Burmese (Myanmar (Burma))	`my-MM`
Cantonese (China)	`yue-CN`
Catalan (Spain)	`ca-ES`
Chinese (China)	`zh-CN`
Chinese (China)	`zh-CN-henan`
Chinese (China)	`zh-CN-shandong`
Chinese (China)	`zh-CN-sichuan`
Chinese (Hong Kong SAR China)	`zh-HK`
Chinese (Taiwan)	`zh-TW`
Croatian (Croatia)	`hr-HR`
Czech (Czechia)	`cs-CZ`
Danish (Denmark)	`da-DK`
Dutch (Belgium)	`nl-BE`
Dutch (Netherlands)	`nl-NL`
English (Australia)	`en-AU`
English (Canada)	`en-CA`
English (Curaçao)	`en-AN`
English (Hong Kong SAR China)	`en-HK`
English (India)	`en-IN`
English (Ireland)	`en-IE`
English (Kenya)	`en-KE`
English (New Zealand)	`en-NZ`
English (Nigeria)	`en-NG`
English (Philippines)	`en-PH`
English (Singapore)	`en-SG`
English (South Africa)	`en-ZA`
English (Tanzania)	`en-TZ`
English (United Kingdom)	`en-GB`
English (United States)	`en-US`
Estonian (Estonia)	`et-EE`
Filipino (Philippines)	`fil-PH`
Finnish (Finland)	`fi-FI`
French (Belgium)	`fr-BE`
French (Canada)	`fr-CA`
French (France)	`fr-FR`
French (Switzerland)	`fr-CH`
Galician (Spain)	`gl-ES`
Georgian (Georgia)	`ka-GE`
German (Austria)	`de-AT`
German (Germany)	`de-DE`
German (Switzerland)	`de-CH`
Hebrew (Israel)	`he-IL`
Hindi (India)	`hi-IN`
Hungarian (Hungary)	`hu-HU`
Icelandic (Iceland)	`is-IS`
Indonesian (Indonesia)	`id-ID`
Irish (Ireland)	`ga-IE`
Italian (Italy)	`it-IT`
Japanese (Japan)	`ja-JP`
Javanese (Indonesia)	`jv-ID`
Kazakh (Kazakhstan)	`kk-KZ`
Khmer (Cambodia)	`km-KH`
Korean (South Korea)	`ko-KR`
Lao (Laos)	`lo-LA`
Latvian (Latvia)	`lv-LV`
Lithuanian (Lithuania)	`lt-LT`
Macedonian (North Macedonia)	`mk-MK`
Malay (Malaysia)	`ms-MY`
Malayalam (India)	`ml-IN`
Maltese (Malta)	`mt-MT`
Mandarin Chinese (China)	`cmn-CN`
Marathi (India)	`mr-IN`
Mongolian (Mongolia)	`mn-MN`
Nepali (Nepal)	`ne-NP`
Norwegian Bokmål (Norway)	`nb-NO`
Pashto (Afghanistan)	`ps-AF`
Persian (Iran)	`fa-IR`
Polish (Poland)	`pl-PL`
Portuguese (Brazil)	`pt-BR`
Portuguese (Portugal)	`pt-PT`
Romanian (Romania)	`ro-RO`
Russian (Russia)	`ru-RU`
Serbian (Serbia)	`sr-RS`
Sinhala (Sri Lanka)	`si-LK`
Slovak (Slovakia)	`sk-SK`
Slovenian (Slovenia)	`sl-SI`
Somali (Somalia)	`so-SO`
Spanish (Argentina)	`es-AR`
Spanish (Bolivia)	`es-BO`
Spanish (Chile)	`es-CL`
Spanish (Colombia)	`es-CO`
Spanish (Costa Rica)	`es-CR`
Spanish (Cuba)	`es-CU`
Spanish (Ecuador)	`es-EC`
Spanish (El Salvador)	`es-SV`
Spanish (Equatorial Guinea)	`es-GQ`
Spanish (Guatemala)	`es-GT`
Spanish (Mexico)	`es-MX`
Spanish (Nicaragua)	`es-NI`
Spanish (Panama)	`es-PA`
Spanish (Paraguay)	`es-PY`
Spanish (Puerto Rico)	`es-PR`
Spanish (Spain)	`es-ES`
Spanish (United States)	`es-US`
Spanish (Uruguay)	`es-UY`
Spanish (Venezuela)	`es-VE`
Sundanese (Indonesia)	`su-ID`
Swahili (Kenya)	`sw-KE`
Swahili (Tanzania)	`sw-TZ`
Swedish (Sweden)	`sv-SE`
Tamil (India)	`ta-IN`
Tamil (Malaysia)	`ta-MY`
Tamil (Singapore)	`ta-SG`
Telugu (India)	`te-IN`
Thai (Thailand)	`th-TH`
Turkish (Türkiye)	`tr-TR`
Ukrainian (Ukraine)	`uk-UA`
Urdu (India)	`ur-IN`
Urdu (Pakistan)	`ur-PK`
Uzbek (United Kingdom)	`uz-UK`
Vietnamese (Vietnam)	`vi-VN`
Welsh (United Kingdom)	`cy-GB`
Wu Chinese (China)	`wuu-CN`
Xhosa (South Africa)	`xh-ZA`
Zulu (South Africa)	`zu-ZA`

Supported Models

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

settings

string

Defaults to [object Object]

A dictionnary or a json object to specify specific models to use for some providers.
It can be in the following format: {"google" : "google_model", "ibm": "ibm_model"...}.

providers

array of strings

required

It can be one (ex: 'amazon' or 'google') or multiple provider(s) (ex: 'amazon,microsoft,google') that the data will be redirected to in order to get the processed results.
Providers can also be invoked with specific models (ex: providers: 'amazon/model1, amazon/model2, google/model3')

providers*

fallback_providers

array of strings

length ≤ 5

Defaults to

Providers in this list will be used as fallback if the call to provider in providers parameter fails. To use this feature, you must input only one provider in the providers parameter. but you can put up to 5 fallbacks.

They will be tried in the same order they are input, and it will stop to the first provider who doesn't fail.

Doesn't work with async subfeatures.

fallback_providers

response_as_dict

boolean

Defaults to true

Optional : When set to true (default), the response is an object of responses with providers names as keys :
{"google" : { "status": "success", ... }, }
When set to false the response structure is a list of response objects :
[{"status": "success", "provider": "google" ... }, ].

attributes_as_list

boolean

Defaults to false

Optional : When set to false (default) the structure of the extracted items is list of objects having different attributes :
{'items': [{"attribute_1": "x1","attribute_2": "y2"}, ... ]}
When it is set to true, the response contains an object with each attribute as a list :
{ "attribute_1": ["x1","x2", ...], "attribute_2": [y1, y2, ...]}

show_base_64

boolean

Defaults to true

show_original_response

boolean

Defaults to false

Optional : Shows the original response of the provider.
When set to true, a new attribute original_response will appear in the response object.

text

string

required

length ≥ 1

Text to analyze

language

string | null

Language code expected (ex: en, fr)

option

enum

rate

integer | null

-100 to 100

Defaults to 0

Increase or decrease the speaking rate by expressing a positif or negatif number ranging between 100 and -100 (a relative value as percentage varying from -100% to 100%)

pitch

integer | null

-100 to 100

Defaults to 0

Increase or decrease the speaking pitch by expressing a positif or negatif number ranging between 100 and -100 (a relative value as percentage varying from -100% to 100%)

volume

integer | null

-100 to 100

Defaults to 0

Increase or decrease the audio volume by expressing a positif or negatif number ranging between 100 and -100 (a relative value as percentage varying from -100% to 100%)

audio_format

string | null

Optional parameter to specify the audio format in which the audio will be generated. By default, audios are encoded in MP3, except for lovoai which use the wav container.

sampling_rate

integer | null

0 to 200000

Defaults to 0

Optional. The synthesis sample rate (in hertz) for this audio. When this is specified, the audio will be converted either to the right passed value, or to a the nearest value acceptable by the provider

webhook_receiver

uri

length ≥ 1

Webhook receiver should be a valid https URL (ex : https://your.listner.com/endpoint). After the processing is done, the webhook endpoint will receive a POST request with the result.

users_webhook_parameters

string

Json data that contains of additional parameters that will be sent back to the webhook receiver (ex: api key for security or client's data ID to link the result internally). Will only be used when webhook_receiver is set.

send_webhook_data

boolean

Defaults to true

If set to false the webhook will not contain the result data. Use if your webhook receiver has a request size limit.

Response