DocsBlogPricingEnterpriseCareersResearch Grants
Log-inSign-up

Chatterboxhd Speech to Speech

resemble-ai/chatterboxhd/speech-to-speech
Transform voices using Resemble AI's Chatterbox. Convert audio to new voices or your own samples, with expressive results and built-in perceptual watermarking.
Inference
Commercial use
Partner
PlaygroundAPI

About

This endpoint generates a voice-converted audio file from a given source audio file.

Fal.ai injects an environment variable FAL_REQUEST_ID for each request. This allows us to correlate logs belonging to a specific API call in the Fal.ai dashboard. We use "local" as a default if the variable isn't set (e.g., when running locally without fal run in a way that injects it, though fal run usually handles this). The request_id is prepended to log messages within the endpoint handlers (e.g., logger.info(f"[{request_id}] ...")).

Parameters: request: STSInput - The input parameters for the speech-to-speech request. response: Response - The response object for the STS request.

Returns: STSOutput - The generated voice-converted audio file and metadata.

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("resemble-ai/chatterboxhd/speech-to-speech", {
  input: {
    source_audio_url: "https://storage.googleapis.com/chatterbox-demo-samples/samples/duff_stewie.wav"
  },
  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("resemble-ai/chatterboxhd/speech-to-speech", {
  input: {
    source_audio_url: "https://storage.googleapis.com/chatterbox-demo-samples/samples/duff_stewie.wav"
  },
  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("resemble-ai/chatterboxhd/speech-to-speech", {
  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("resemble-ai/chatterboxhd/speech-to-speech", {
  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#

source_audio_url string* required

URL to the source audio file to be voice-converted.

target_voice TargetVoiceEnum

The voice to use for the speech-to-speech request. If neither target_voice nor target_voice_audio_url are provided, a random target voice will be used.

Possible enum values: Aurora, Blade, Britney, Carl, Cliff, Richard, Rico, Siobhan, Vicky

target_voice_audio_url string

URL to the audio file which represents the voice of the output audio. If provided, this will override the target_voice setting. If neither target_voice nor target_voice_audio_url are provided, the default target voice will be used.

high_quality_audio boolean

If True, the generated audio will be upscaled to 48kHz. The generation of the audio will take longer, but the quality will be higher. If False, the generated audio will be 24kHz.

{
  "source_audio_url": "https://storage.googleapis.com/chatterbox-demo-samples/samples/duff_stewie.wav",
  "target_voice_audio_url": "https://v3.fal.media/files/tiger/0XODRhebRLiBdu8MqgZc5_tmpljqsylwu.wav"
}

Output#

audio Audio* required

The generated voice-converted audio file.

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

Other types#

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.

file_data string

File data

Related Models