Loading API documentation
Generate speech from text using Maya-1-Voice
The client provides a convenient way to interact with the model API.
npm install --save @fal-ai/clientSet 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/maya", {
input: {
text: "Hello world! This is a test of the Maya-1-Voice text-to-speech system.",
prompt: "Realistic male voice in the 30s age with american accent. Normal pitch, warm timbre, conversational pacing, neutral tone delivery at med intensity."
},
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"
});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/maya", {
input: {
text: "Hello world! This is a test of the Maya-1-Voice text-to-speech system.",
prompt: "Realistic male voice in the 30s age with american accent. Normal pitch, warm timbre, conversational pacing, neutral tone delivery at med intensity."
},
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/maya", {
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/maya", {
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);Read more about file handling in our file upload guide.
text string* requiredThe text to synthesize into speech. You can embed emotion tags anywhere in the text using the format <emotion_name>. Available emotions: laugh, laugh_harder, sigh, chuckle, gasp, angry, excited, whisper, cry, scream, sing, snort, exhale, gulp, giggle, sarcastic, curious. Example: 'Hello world! <excited> This is amazing!' or 'I can't believe this <sigh> happened again.'
prompt string* requiredDescription of the voice/character. Includes attributes like age, accent, pitch, timbre, pacing, tone, and intensity. See examples for format.
temperature floatSampling temperature. Lower values (0.2-0.5) produce more stable/consistent audio. Higher values add variation. Default value: 0.4
top_p floatNucleus sampling parameter. Controls diversity of token selection. Default value: 0.9
max_tokens integerMaximum number of SNAC tokens to generate (7 tokens per frame). Controls maximum audio length. Default value: 2000
repetition_penalty floatPenalty for repeating tokens. Higher values reduce repetition artifacts. Default value: 1.1
sample_rate SampleRateEnumOutput audio sample rate. 48 kHz provides higher quality audio, 24 kHz is faster. Default value: "48 kHz"
Possible enum values: 48 kHz, 24 kHz
output_format OutputFormatEnumOutput audio format for the generated speech Default value: "wav"
Possible enum values: wav, mp3
enable_safety_checker booleanAuthorized callers may set false to request relaxed screening. Default value: true
{
"text": "Hello world! This is a test of the Maya-1-Voice text-to-speech system.",
"prompt": "Realistic male voice in the 30s age with american accent. Normal pitch, warm timbre, conversational pacing, neutral tone delivery at med intensity.",
"temperature": 0.4,
"top_p": 0.9,
"max_tokens": 2000,
"repetition_penalty": 1.1,
"sample_rate": "48 kHz",
"output_format": "wav",
"enable_safety_checker": true
}The generated audio file containing the speech (WAV or MP3 format, 24kHz or 48kHz mono depending on upsampler)
duration float* requiredDuration of the generated audio in seconds
sample_rate string* requiredSample rate of the generated audio
generation_time float* requiredTime taken to generate the audio in seconds
rtf float* requiredReal-time factor (generation_time / audio_duration). Lower is better.
{
"audio": {
"url": "",
"content_type": "image/png",
"file_name": "z9RV14K95DvU.png",
"file_size": 4404019
},
"duration": 4.5,
"sample_rate": "48 kHz",
"generation_time": 2.3,
"rtf": 0.51
}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.