POST
/
tts

This endpoint allows you to generate speech from text by specifying the text content, voice characteristics, and language. It creates a new Text to Speech task and provides a task_id for tracking and fetching the result. To check the status of the task, the /tts/{id} endpoint can be polled.

​
Specifying Gender

The gender parameter accepts the following integer values:

  • 0: Unknown
  • 1: Male
  • 2: Female
  • 9: Not Applicable

​
Choosing a Voice

  • In order to list available voices, use the /list-voices endpoint to obtain voice_id and associated metadata.
  • To create a custom voice, use the /create-custom-voice endpoint to create your own custom voice. The voice is specified in the payload as an integer.

Ensure that the language is specified by the id provided from the system:

Authorizations

​
x-api-key
string
header
required

The x-api-key is a custom header required for authenticating requests to our API. Include this header in your request with the appropriate API key value to securely access our endpoints. You can find your API key(s) in the 'API' section of our studio website.

Body

application/json
​
language
enum<integer>
required

The language in which the provided text is written in.

Available options:
1,
2,
3,
4,
5,
6,
7,
8,
9,
10,
11,
12,
13,
14,
15,
16,
17,
18,
19,
20,
21,
22,
23,
24,
25,
26,
27,
28,
29,
30,
31,
32,
33,
34,
35,
36,
37,
38,
39,
40,
41,
42,
43,
44,
45,
46,
47,
48,
49,
50,
51,
52,
53,
54,
55,
56,
57,
58,
59,
60,
61,
62,
63,
64,
65,
66,
67,
68,
69,
70,
71,
72,
73,
74,
75,
76,
77,
78,
79,
80,
81,
82,
83,
84,
85,
86,
87,
88,
89,
90,
91,
92,
93,
94,
95,
96,
97,
98,
99,
100,
101,
102,
103,
104,
105,
106,
107,
108,
109,
110,
111,
112,
113,
114,
115,
116,
117,
118,
119,
120,
121,
122,
123,
124,
125,
126,
127,
128,
129,
130,
131,
132,
133,
134,
135,
136,
137,
138,
139,
140,
141,
142,
143,
144,
145,
146,
147,
148
​
text
string
required

The text to be converted to speech

​
voice_id
integer
required

The voice ID to be used to generate speech.

​
age
integer | null

The age of the speaker of in the speech to be generated.

Required range: x > 1
​
gender
enum<integer>
default:
1

The gender of the speaker.

Available options:
0,
1,
2,
9

Response

200 - application/json

A JSON that contains the unique identifier for the task. This is used to query the status of the story task that is running. It is returned when a create request is made for a text-to-speech.

​
task_id
string
IntroductionGet Text to Speech Task Status