Sonauto V2 Text to Audio
About
Generate songs using Sonauto, an AI music model that transforms text into full songs with lyrics. Sonauto can turn any idea into a complete song with high-quality music in any style. For example, you can create an original birthday song sung by Frank Sinatra in just minutes.
This function accepts various combinations of prompt, tags, and lyrics to generate music, with the following requirements:
- You must provide at least one of: prompt, tags, or lyrics
- Lyrics alone are not sufficient - they must be paired with either prompt or tags
- Do not provide all three inputs (prompt, tags, and lyrics) simultaneously
- If tags are provided, you must also include either a prompt (to generate lyrics with AI) or your own lyrics
You can view a list of all available tags at https://sonauto.ai/tag-explorer.
1. Calling the API#
Install the client#
The client provides a convenient way to interact with the model API.
npm install --save @fal-ai/client
Migrate to @fal-ai/client
The @fal-ai/serverless-client
package has been deprecated in favor of @fal-ai/client
. Please check the migration guide for more information.
Setup your API Key#
Set FAL_KEY
as an environment variable in your runtime.
export FAL_KEY="YOUR_API_KEY"
Submit a request#
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("sonauto/v2/text-to-music", {
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);
2. Authentication#
The API uses an API Key for authentication. It is recommended you set the FAL_KEY
environment variable in your runtime when possible.
API Key#
import { fal } from "@fal-ai/client";
fal.config({
credentials: "YOUR_FAL_KEY"
});
Protect your API 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.
3. Queue#
Submit a request#
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("sonauto/v2/text-to-music", {
input: {},
webhookUrl: "https://optional.webhook.url/for/results",
});
Fetch request status#
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("sonauto/v2/text-to-music", {
requestId: "764cabcf-b745-4b3e-ae38-1200304cf45b",
logs: true,
});
Get the result#
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("sonauto/v2/text-to-music", {
requestId: "764cabcf-b745-4b3e-ae38-1200304cf45b"
});
console.log(result.data);
console.log(result.requestId);
4. Files#
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.
Data URI (base64)#
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.
Hosted files (URL)#
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.
Uploading files#
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);
Auto uploads
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.
5. Schema#
Input#
prompt
string
A description of the track you want to generate. This prompt will be used to automatically generate the tags and lyrics unless you manually set them. For example, if you set prompt and tags, then the prompt will be used to generate only the lyrics.
Tags/styles of the music to generate. You can view a list of all available tags at https://sonauto.ai/tag-explorer.
lyrics_prompt
string
The lyrics sung in the generated song. An empty string will generate an instrumental track.
seed
integer
The seed to use for generation. Will pick a random seed if not provided. Repeating a request with identical parameters (must use lyrics and tags, not prompt) and the same seed will generate the same song.
prompt_strength
float
Controls how strongly your prompt influences the output. Greater values adhere more to the prompt but sound less natural. (This is CFG.) Default value: 2
balance_strength
float
Greater means more natural vocals. Lower means sharper instrumentals. We recommend 0.7. Default value: 0.7
num_songs
integer
Generating 2 songs costs 1.5x the price of generating 1 song. Also, note that using the same seed may not result in identical songs if the number of songs generated is changed. Default value: 1
output_format
OutputFormatEnum
Default value: "wav"
Possible enum values: flac, mp3, wav, ogg, m4a
output_bit_rate
Enum
The bit rate to use for mp3 and m4a formats. Not available for other formats.
Possible enum values: 128, 192, 256, 320
The beats per minute of the song. This can be set to an integer or the literal string "auto" to pick a suitable bpm based on the tags. Set bpm to null to not condition the model on bpm information. Default value: auto
{
"prompt": "A pop song about turtles flying",
"prompt_strength": 2,
"balance_strength": 0.7,
"num_songs": 1,
"output_format": "wav",
"bpm": "auto"
}
Output#
seed
integer
* requiredThe seed used for generation. This can be used to generate an identical song by passing the same parameters with this seed in a future request.
The style tags used for generation.
lyrics
string
The lyrics used for generation.
The generated audio files.
{
"seed": 42,
"audio": {
"file_size": 16777294,
"file_name": "sonauto.wav",
"content_type": "audio/wav",
"url": "https://cdn.sonauto.ai/generations2_altformats/audio_c5e63f7c-fc79-4322-808d-c09911af4713.wav"
}
}
Other types#
InpaintSection#
start
float
* requiredStart time in seconds of the section to inpaint.
end
float
* requiredEnd time in seconds of the section to inpaint.
File#
url
string
* requiredThe URL where the file can be downloaded from.
content_type
string
The mime type of the file.
file_name
string
The name of the file. It will be auto-generated if not provided.
file_size
integer
The size of the file in bytes.