Happy Horse 1.0 is now on fal
Docs
Log-inSign-up

mirelo-ai/sfx1.6/text-to-audio

Generate ambient sounds for any text prompt. Now you can turn any SFX into a natural loop for ambient soundscapes.
Inference
Commercial use
Partner
Schema
LLMs
PlaygroundAPI

Table of contents

About

Text To Audio

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

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("mirelo-ai/sfx1.6/text-to-audio", {
  input: {
    text_prompt: "city ambience"
  },
  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#

In case your app is running in an environment where you cannot set environment variables, you can set the API Key manually as a client configuration.
import { fal } from "@fal-ai/client";

fal.config({
  credentials: "YOUR_FAL_KEY"
});

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("mirelo-ai/sfx1.6/text-to-audio", {
  input: {
    text_prompt: "city ambience"
  },
  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("mirelo-ai/sfx1.6/text-to-audio", {
  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("mirelo-ai/sfx1.6/text-to-audio", {
  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);

Read more about file handling in our file upload guide.

5. Schema#

Input#

text_prompt string* required

Text prompt for the generated audio.

duration float

Duration of the generated audio in seconds. Default value: 10

ambience boolean

When true, generate a seamlessly loopable ambience tile (room tone, rain, drones, etc.). When false, generate a generic text-conditioned SFX of duration seconds.

double_output boolean

Only used when ambience=true: concatenate the loop with itself for a 2x-length output.

num_samples integer

Number of variations to generate. Default value: 1

seed integer

Seed for generation. -1 or None for random.

upload_audio_format UploadAudioFormatEnum

Audio format for the returned files. Default value: "wav"

Possible enum values: wav, mp3, aac, flac

{
  "text_prompt": "city ambience",
  "duration": 10,
  "num_samples": 1,
  "upload_audio_format": "wav"
}

Output#

audio list<Audio>* required

Generated SFX audio from a text prompt.

{
  "audio": [
    {
      "content_type": "audio/wav",
      "file_name": "text_to_audio_1.wav",
      "url": "https://v3b.fal.media/files/b/kangaroo/text_to_audio_example.wav"
    }
  ]
}

Other types#

Video#

url string* required

The 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.

Audio#

url string* required

The 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.

AudioSegmentSpec#

start_s float* required

Start of the inpaint region in seconds. Must leave a 1s left gap (>= 1.0).

end_s float* required

End of the inpaint region in seconds. Must be <= 10.0.

Related Models