Loading API documentation
Create a formatted lyrics video for generated or uploaded audio.
Customize its layout, aspect ratio, title, visuals, and included lyric or time range.
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("mureka/api/generate/lyrics-video", {
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("mureka/api/generate/lyrics-video", {
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("mureka/api/generate/lyrics-video", {
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("mureka/api/generate/lyrics-video", {
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.
song_id stringGenerated audio ID from song_id in a song or instrumental response. Provide exactly one of song_id or upload_audio_id.
upload_audio_id stringAudio ID returned by /files/upload with purpose='audio'. Provide exactly one of song_id or upload_audio_id.
background_id stringBackground image ID returned by /files/upload with purpose='lyrics-video'.
cover_url stringOptional public HTTPS URL or data URI for a JPG, PNG, or WebP cover. Not supported with layout_1.
title stringOptional title displayed in the lyrics video.
aspect_ratio AspectRatioEnumOutput video aspect ratio. Default value: "9:16"
Possible enum values: 16:9, 9:16, 3:4, 4:3
layout LayoutEnumVisual layout template for the lyrics video. Default value: "layout_1"
Possible enum values: layout_1, layout_2, layout_3, layout_4, layout_5, layout_6, layout_7
lyrics_start_row integerFirst lyric row to include, starting at 1. Must be paired with lyrics_end_row and cannot be combined with a time selection.
lyrics_end_row integerLast lyric row to include. Must be paired with lyrics_start_row and cannot be combined with a time selection.
selection_start integerStart of the included audio range in milliseconds. Must be paired with selection_end and cannot be combined with lyric-row selection.
selection_end integerEnd of the included audio range in milliseconds. Must be paired with selection_start and cannot be combined with lyric-row selection.
enable_safety_checker booleanAuthorized callers may set false to request relaxed screening. Default value: true
{
"aspect_ratio": "9:16",
"layout": "layout_1",
"enable_safety_checker": true
}The generated video file.
{
"video": {
"url": "",
"content_type": "image/png",
"file_name": "z9RV14K95DvU.png",
"file_size": 4404019
}
}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.