ElevenLabs Speech to Text Speech to Text
About
ElevenLabs Speech to Text: Transcribe audio with high accuracy.
Transforms spoken audio into text with word-level timestamps and optional speaker identification. Supports 99 languages with state-of-the-art accuracy.
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
Migrate to @fal-ai/client
The @fal-ai/serverless-client
package has been deprecated in favor of @fal-ai/client
. Please check the migration guide for more information.
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/elevenlabs/speech-to-text", {
input: {
audio_url: "https://v3.fal.media/files/zebra/zJL_oRY8h5RWwjoK1w7tx_output.mp3"
},
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#
import { fal } from "@fal-ai/client";
fal.config({
credentials: "YOUR_FAL_KEY"
});
Protect your API 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.
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/elevenlabs/speech-to-text", {
input: {
audio_url: "https://v3.fal.media/files/zebra/zJL_oRY8h5RWwjoK1w7tx_output.mp3"
},
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/elevenlabs/speech-to-text", {
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/elevenlabs/speech-to-text", {
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);
Auto uploads
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.
5. Schema#
Input#
audio_url
 string
* requiredURL of the audio file to transcribe
language_code
 string
Language code of the audio
tag_audio_events
 boolean
Tag audio events like laughter, applause, etc. Default value: true
diarize
 boolean
Whether to annotate who is speaking Default value: true
{
"audio_url": "https://v3.fal.media/files/zebra/zJL_oRY8h5RWwjoK1w7tx_output.mp3",
"language_code": "eng",
"tag_audio_events": true,
"diarize": true
}
Output#
text
 string
* requiredThe full transcribed text
language_code
 string
* requiredDetected or specified language code
language_probability
 float
* requiredConfidence in language detection
Word-level transcription details
{
"text": "",
"language_code": "",
"words": [
{
"text": "",
"type": ""
}
]
}
Other types#
VoiceCloningRequest#
List of audio files to use for voice cloning
remove_background_noise
 boolean
Whether to remove background noise from the audio files Default value: true
File#
url
 string
* requiredThe 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.
TextToSpeechRequest#
text
 string
* requiredThe text to convert to speech
voice
 string
The voice to use for speech generation Default value: "Rachel"
stability
 float
Voice stability (0-1) Default value: 0.5
similarity_boost
 float
Similarity boost (0-1) Default value: 0.75
style
 float
Style exaggeration (0-1)
speed
 float
Speech speed (0.7-1.2). Values below 1.0 slow down the speech, above 1.0 speed it up. Extreme values may affect quality. Default value: 1
AudioIsolationRequest#
audio_url
 string
* requiredURL of the audio file to isolate voice from
SoundEffectRequest#
text
 string
* requiredThe text describing the sound effect to generate
duration_seconds
 float
Duration in seconds (0.5-22). If None, optimal duration will be determined from prompt.
prompt_influence
 float
How closely to follow the prompt (0-1). Higher values mean less variation. Default value: 0.3
TranscriptionWord#
text
 string
* requiredThe transcribed word or audio event
start
 float
* requiredStart time in seconds
end
 float
* requiredEnd time in seconds
type
 string
* requiredType of element (word, spacing, or audio_event)
speaker_id
 string
Speaker identifier if diarization was enabled