fal Assets is now live!
Docs
Log-inSign-up

bytedance/seed-audio-1.0

Seed Audio 1.0 is a new audio model from Bytedance that can generate high-quality, natural sounding audio using text, reference audios or an image.
Inference
Commercial use
Partner
Schema
LLMs
PlaygroundAPIExamples

Table of contents

About

Generate

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("bytedance/seed-audio-1.0", {
  input: {
    prompt: "Generate a short suspense radio drama in a late-night convenience store."
  },
  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("bytedance/seed-audio-1.0", {
  input: {
    prompt: "Generate a short suspense radio drama in a late-night convenience store."
  },
  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("bytedance/seed-audio-1.0", {
  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("bytedance/seed-audio-1.0", {
  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#

prompt string* required

Prompt or text to synthesize. Reference audio inputs by order with @Audio1, @Audio2, @Audio3.

voice Enum

Preset voice to use for synthesis.

Possible enum values: vivi_mixed_en_zh_ja_es_id, mindy_en_es_id_pt_zh, kian_en_zh, cedric_en_zh, sophie_en_zh, jean_en_zh, magnus_en_zh, mabel_en_zh, nadia_en_zh, opal_en_zh, pearl_en_zh, quentin_en_zh, corinne_mixed_en_zh, esther_mixed_en_zh, lyla_mixed_en_zh, tracy_es_zh, sandy_es_mixed_en_zh, felix_zh, celeste_zh, monkey_king_zh

audio_urls list<string>

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 string

A single reference image URL (jpeg/png/webp, up to 10MB). Cannot be combined with audio references.

output_format OutputFormatEnum

Output audio format. Default value: "mp3"

Possible enum values: wav, mp3, pcm, ogg_opus

sample_rate SampleRateEnum

Sample rate of the output audio in Hz. Default value: "24000"

Possible enum values: 8000, 16000, 24000, 32000, 44100, 48000

speed float

Speech speed. 1.0 is normal speed, 0.5 is half speed, 2.0 is double speed. Default value: 1

volume float

Volume. 1.0 is normal volume, 0.5 is half, 2.0 is double. Default value: 1

pitch integer

Voice pitch shift in semitones. 0 is normal pitch, -12 lowers by one octave, 12 raises by one octave.

{
  "prompt": "Generate a short suspense radio drama in a late-night convenience store.",
  "output_format": "mp3",
  "sample_rate": 24000,
  "speed": 1,
  "volume": 1
}

Output#

audio AudioFile* required

The generated audio file.

{
  "audio": {
    "url": "",
    "content_type": "image/png",
    "file_name": "z9RV14K95DvU.png",
    "file_size": 4404019
  }
}

Other types#

AudioFile#

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.

duration float

The duration of the audio

channels integer

The number of channels in the audio

sample_rate integer

The sample rate of the audio

bitrate string | integer

The bitrate of the audio (e.g., '192k' or 192000)