Realtime audio conversation over WebSocket.
The client provides a convenient way to interact with the model API.
npm install --save @fal-ai/clientThe @fal-ai/serverless-client package has been deprecated in favor of @fal-ai/client. Install the new package and update your imports — see client setup.
Set FAL_KEY as an environment variable in your runtime.
export FAL_KEY="YOUR_API_KEY"This model has a real-time mode via WebSockets, supported by fal.realtime.connect.
import { fal } from "@fal-ai/client";
const connection = fal.realtime.connect("fal-ai/personaplex/realtime", {
onResult: (result) => {
console.log(result);
},
onError: (error) => {
console.error(error);
},
// Fetch short-lived JWT token from your backend
tokenProvider: async (app) => {
const response = await fetch("/api/fal/realtime-token", {
method: "POST",
headers: { "Content-Type": "application/json" },
body: JSON.stringify({ app }),
});
return response.text();
},
tokenExpirationSeconds: 10,
});
connection.send({
audio: ""
});The API uses an API Key for authentication. It is recommended you set the FAL_KEY environment variable in your runtime when possible.
import { fal } from "@fal-ai/client";
fal.config({
credentials: "YOUR_FAL_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.
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.
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.
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.
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);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.
voice_audio_url stringURL to a voice sample audio for on-the-fly voice cloning. When provided, the AI responds in the cloned voice instead of the preset 'voice'. 10+ seconds of clear speech recommended. Billed at 2x rate. Default value: "null"
prompt stringText prompt describing the AI persona and conversation context. Default value: "You are a wise and friendly teacher. Answer questions or provide advice in a clear and engaging way."
seed integerRandom seed for reproducibility.
top_k_audio integerTop-K sampling for audio tokens. Default value: 250
audio string* requiredInput audio chunk (PCM s16le, 24kHz mono). Base64-encoded in JSON transport.
temperature_audio floatAudio sampling temperature. Higher values produce more diverse outputs. Default value: 0.8
voice VoiceEnumVoice ID for the AI response. NAT = natural, VAR = variety. F = female, M = male. Ignored when voice_audio_url is provided. Default value: "NATF2"
Possible enum values: NATF0, NATF1, NATF2, NATF3, NATM0, NATM1, NATM2, NATM3, VARF0, VARF1, VARF2, VARF3, VARF4, VARM0, VARM1, VARM2, VARM3, VARM4
top_k_text integerTop-K sampling for text tokens. Default value: 25
temperature_text floatText sampling temperature. Higher values produce more diverse outputs. Default value: 0.7
{
"prompt": "You work for SwiftPlex Appliances which is a appliance repair company and your name is Farhod Toshmatov. Information: The dishwasher model is out of stock for replacement parts; we can use an alternative part with a 3-day delay. Labor cost remains $60 per hour.",
"top_k_audio": 250,
"audio": "",
"temperature_audio": 0.8,
"voice": "NATF2",
"top_k_text": 25,
"temperature_text": 0.7
}text stringGenerated text tokens for this chunk. Default value: ""
audio string* requiredGenerated audio chunk (PCM s16le, 24kHz mono). Base64-encoded in JSON transport.
{
"audio": ""
}