DocsBlogPricingEnterpriseCareersResearch Grants
Log-inSign-up

Kokoro TTS Text to Audio

fal-ai/kokoro/american-english
Kokoro is a lightweight text-to-speech model that delivers comparable quality to larger models while being significantly faster and more cost-efficient.
Inference
Commercial use
PlaygroundAPI

About

Generate Am English

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("fal-ai/kokoro/american-english", {
  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#

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("fal-ai/kokoro/american-english", {
  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("fal-ai/kokoro/american-english", {
  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("fal-ai/kokoro/american-english", {
  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

Default value: ""

voice VoiceEnum

Voice ID for the desired voice. Default value: "af_heart"

Possible enum values: af_heart, af_alloy, af_aoede, af_bella, af_jessica, af_kore, af_nicole, af_nova, af_river, af_sarah, af_sky, am_adam, am_echo, am_eric, am_fenrir, am_liam, am_michael, am_onyx, am_puck, am_santa

speed float

Speed of the generated audio. Default is 1.0. Default value: 1

{
  "prompt": "The future belongs to those who believe in the beauty of their dreams. So, dream big, work hard, and make it happen!",
  "voice": "af_heart",
  "speed": 1
}

Output#

audio File* required

The generated music

{
  "audio": {
    "url": "https://fal.media/files/elephant/dXVMqWsBDG9yan3kaOT0Z_tmp0vvkha3s.wav"
  }
}

Other types#

JapaneseRequest#

prompt string* required
voice VoiceEnum* required

Voice ID for the desired voice.

Possible enum values: jf_alpha, jf_gongitsune, jf_nezumi, jf_tebukuro, jm_kumo

speed float

Speed of the generated audio. Default is 1.0. Default value: 1

HindiRequest#

prompt string* required
voice VoiceEnum* required

Voice ID for the desired voice.

Possible enum values: hf_alpha, hf_beta, hm_omega, hm_psi

speed float

Speed of the generated audio. Default is 1.0. Default value: 1

BrEnglishRequest#

prompt string* required
voice VoiceEnum* required

Voice ID for the desired voice.

Possible enum values: bf_alice, bf_emma, bf_isabella, bf_lily, bm_daniel, bm_fable, bm_george, bm_lewis

speed float

Speed of the generated audio. Default is 1.0. Default value: 1

SpanishRequest#

prompt string* required
voice VoiceEnum* required

Voice ID for the desired voice.

Possible enum values: ef_dora, em_alex, em_santa

speed float

Speed of the generated audio. Default is 1.0. Default value: 1

FrenchRequest#

prompt string* required
voice VoiceEnum* required

Voice ID for the desired voice.

Possible enum values: ff_siwis

speed float

Speed of the generated audio. Default is 1.0. Default value: 1

File#

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.

file_data string

File data

ItalianRequest#

prompt string* required
voice VoiceEnum* required

Voice ID for the desired voice.

Possible enum values: if_sara, im_nicola

speed float

Speed of the generated audio. Default is 1.0. Default value: 1

MandarinRequest#

prompt string* required
voice VoiceEnum* required

Voice ID for the desired voice.

Possible enum values: zf_xiaobei, zf_xiaoni, zf_xiaoxiao, zf_xiaoyi, zm_yunjian, zm_yunxi, zm_yunxia, zm_yunyang

speed float

Speed of the generated audio. Default is 1.0. Default value: 1

BrPortugueseRequest#

prompt string* required
voice VoiceEnum* required

Voice ID for the desired voice.

Possible enum values: pf_dora, pm_alex, pm_santa

speed float

Speed of the generated audio. Default is 1.0. Default value: 1

Related Models