Convert text to speech using MiniMax HD API.
The client provides a convenient way to interact with the model API.
npm install --save @fal-ai/clientThe @fal-ai/serverless-client package has been deprecated in favor of @fal-ai/client. Install the new package and update your imports — see client setup.
Set FAL_KEY as an environment variable in your runtime.
export FAL_KEY="YOUR_API_KEY"The client API handles the API submit protocol. It will handle the request status updates and return the result when the request is completed.
import { fal } from "@fal-ai/client";
const result = await fal.subscribe("fal-ai/minimax/speech-02-hd", {
input: {
text: "Hello world! This is a test of the text-to-speech system."
},
logs: true,
onQueueUpdate: (update) => {
if (update.status === "IN_PROGRESS") {
update.logs.map((log) => log.message).forEach(console.log);
}
},
});
console.log(result.data);
console.log(result.requestId);The API uses an API Key for authentication. It is recommended you set the FAL_KEY environment variable in your runtime when possible.
import { fal } from "@fal-ai/client";
fal.config({
credentials: "YOUR_FAL_KEY"
});When running code on the client-side (e.g. in a browser, mobile app or GUI applications), make sure to not expose your FAL_KEY. Instead, use a server-side proxy to make requests to the API. For more information, check out our server-side integration guide.
The client API provides a convenient way to submit requests to the model.
import { fal } from "@fal-ai/client";
const { request_id } = await fal.queue.submit("fal-ai/minimax/speech-02-hd", {
input: {
text: "Hello world! This is a test of the text-to-speech system."
},
webhookUrl: "https://optional.webhook.url/for/results",
});You can fetch the status of a request to check if it is completed or still in progress.
import { fal } from "@fal-ai/client";
const status = await fal.queue.status("fal-ai/minimax/speech-02-hd", {
requestId: "764cabcf-b745-4b3e-ae38-1200304cf45b",
logs: true,
});Once the request is completed, you can fetch the result. See the Output Schema for the expected result format.
import { fal } from "@fal-ai/client";
const result = await fal.queue.result("fal-ai/minimax/speech-02-hd", {
requestId: "764cabcf-b745-4b3e-ae38-1200304cf45b"
});
console.log(result.data);
console.log(result.requestId);Some attributes in the API accept file URLs as input. Whenever that's the case you can pass your own URL or a Base64 data URI.
You can pass a Base64 data URI as a file input. The API will handle the file decoding for you. Keep in mind that for large files, this alternative although convenient can impact the request performance.
You can also pass your own URLs as long as they are publicly accessible. Be aware that some hosts might block cross-site requests, rate-limit, or consider the request as a bot.
We provide a convenient file storage that allows you to upload files and use them in your requests. You can upload files using the client API and use the returned URL in your requests.
import { fal } from "@fal-ai/client";
const file = new File(["Hello, World!"], "hello.txt", { type: "text/plain" });
const url = await fal.storage.upload(file);The client will auto-upload the file for you if you pass a binary object (e.g. File, Data).
Read more about file handling in our file upload guide.
enable_safety_checker booleanAuthorized callers may set false to request relaxed screening. Default value: true
text string* requiredText to convert to speech (max 5000 characters, minimum 1 non-whitespace character)
Voice configuration settings
Audio configuration settings
language_boost EnumEnhance recognition of specified languages and dialects
Possible enum values: Chinese, Chinese,Yue, English, Arabic, Russian, Spanish, French, Portuguese, German, Turkish, Dutch, Ukrainian, Vietnamese, Indonesian, Japanese, Italian, Korean, Thai, Polish, Romanian, Greek, Czech, Finnish, Hindi, Bulgarian, Danish, Hebrew, Malay, Slovak, Swedish, Croatian, Hungarian, Norwegian, Slovenian, Catalan, Nynorsk, Afrikaans, auto
output_format OutputFormatEnumFormat of the output content (non-streaming only) Default value: "hex"
Possible enum values: url, hex
Custom pronunciation dictionary for text replacement
{
"enable_safety_checker": true,
"text": "Hello world! This is a test of the text-to-speech system.",
"output_format": "hex"
}The generated audio file
duration_ms integer* requiredDuration of the audio in milliseconds
{
"audio": {
"url": "https://fal.media/files/kangaroo/kojPUCNZ9iUGFGMR-xb7h_speech.mp3"
}
}List of pronunciation replacements in format ['text/(pronunciation)', ...]. For Chinese, tones are 1-5. Example: ['燕少飞/(yan4)(shao3)(fei1)']
sample_rate SampleRateEnumSample rate of generated audio Default value: "32000"
Possible enum values: 8000, 16000, 22050, 24000, 32000, 44100
bitrate BitrateEnumBitrate of generated audio Default value: "128000"
Possible enum values: 32000, 64000, 128000, 256000
format FormatEnumAudio format Default value: "mp3"
Possible enum values: mp3, pcm, flac
channel ChannelEnumNumber of audio channels (1=mono, 2=stereo) Default value: "1"
Possible enum values: 1, 2
voice_id stringPredefined voice ID to use for synthesis Default value: "Wise_Woman"
speed floatSpeech speed (0.5-2.0) Default value: 1
vol floatVolume (0-10) Default value: 1
pitch integerVoice pitch (-12 to 12)
emotion EnumEmotion of the generated speech
Possible enum values: happy, sad, angry, fearful, disgusted, surprised, neutral
english_normalization booleanEnables English text normalization to improve number reading performance, with a slight increase in latency
url string* requiredThe URL where the file can be downloaded from.
content_type stringThe mime type of the file.
file_name stringThe name of the file. It will be auto-generated if not provided.
file_size integerThe size of the file in bytes.