Generate
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("bytedance/seed-audio-1.0", {
input: {
prompt: "Here's a quick look at your day: you've got three meetings, one lunch, and just enough time in between to grab a coffee and relax."
},
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("bytedance/seed-audio-1.0", {
input: {
prompt: "Here's a quick look at your day: you've got three meetings, one lunch, and just enough time in between to grab a coffee and relax."
},
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("bytedance/seed-audio-1.0", {
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("bytedance/seed-audio-1.0", {
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.
prompt string* requiredPrompt or text to synthesize. Reference audio inputs by order with @Audio1, @Audio2, @Audio3.
voice stringVoice to use for synthesis: either a preset voice name or a cloned voice id.
Up to 3 reference audio URLs, referenced in prompt as @Audio1, @Audio2, @Audio3. Each clip: up to 30s, 10MB, wav/mp3/pcm/ogg_opus.
image_url stringA single reference image URL (jpeg/png/webp, up to 10MB). Cannot be combined with audio references.
output_format OutputFormatEnumOutput audio format. Default value: "mp3"
Possible enum values: wav, mp3, pcm, ogg_opus
sample_rate SampleRateEnumSample rate of the output audio in Hz. Default value: "24000"
Possible enum values: 8000, 16000, 24000, 32000, 44100, 48000
speed floatSpeech speed. 1.0 is normal speed, 0.5 is half speed, 2.0 is double speed. Default value: 1
volume floatVolume. 1.0 is normal volume, 0.5 is half, 2.0 is double. Default value: 1
pitch integerVoice pitch shift in semitones. 0 is normal pitch, -12 lowers by one octave, 12 raises by one octave.
multilingual booleanUse the multilingual model variant, which handles non-English and mixed-language prompts better.
{
"prompt": "Here's a quick look at your day: you've got three meetings, one lunch, and just enough time in between to grab a coffee and relax.",
"voice": "stokie_en",
"output_format": "mp3",
"sample_rate": 24000,
"speed": 1,
"volume": 1
}The generated audio file.
{
"audio": {
"url": "https://v3b.fal.media/files/b/0aa97081/TYxWX8Yp1jjq9qObOdSRn_speech.mp3"
}
}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.
duration floatThe duration of the audio
channels integerThe number of channels in the audio
sample_rate integerThe sample rate of the audio