Loading API documentation
Generate multiple speech outputs from batch of texts using Maya-1-Voice
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/maya/batch", {
input: {},
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/maya/batch", {
input: {},
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/batch", {
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/batch", {
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.
List of texts to synthesize into speech. You can embed emotion tags in each text using the format <emotion_name>.
List of voice descriptions for each text. Must match the length of texts list. Each describes the voice/character attributes.
temperature floatSampling temperature for all generations. Default value: 0.4
top_p floatNucleus sampling parameter for all generations. Default value: 0.9
max_tokens integerMaximum SNAC tokens per generation. Default value: 2000
repetition_penalty floatRepetition penalty for all generations. Default value: 1.1
sample_rate SampleRateEnumOutput audio sample rate for all generations. 48 kHz provides higher quality, 24 kHz is faster. Default value: "48 kHz"
Possible enum values: 48 kHz, 24 kHz
output_format OutputFormatEnumOutput audio format for all generated speech files Default value: "wav"
Possible enum values: wav, mp3
enable_safety_checker booleanAuthorized callers may set false to request relaxed screening. Default value: true
{
"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
}List of generated audio files
Duration of each generated audio in seconds
sample_rate string* requiredSample rate of all generated audio files
total_generation_time float* requiredTotal time taken to generate all audio files in seconds
average_rtf float* requiredAverage real-time factor across all generations
{
"audios": [
{
"url": "",
"content_type": "image/png",
"file_name": "z9RV14K95DvU.png",
"file_size": 4404019
}
],
"sample_rate": "48 kHz",
"total_generation_time": 5.7,
"average_rtf": 0.15
}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.