Transcribe Audio
curl --request POST \
--url https://api.example.com/api/audio/transcriptions \
--header 'Authorization: <authorization>' \
--header 'Content-Type: application/json' \
--data '
{
"language": "<string>"
}
'import requests
url = "https://api.example.com/api/audio/transcriptions"
payload = { "language": "<string>" }
headers = {
"Authorization": "<authorization>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: '<authorization>', 'Content-Type': 'application/json'},
body: JSON.stringify({language: '<string>'})
};
fetch('https://api.example.com/api/audio/transcriptions', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.example.com/api/audio/transcriptions",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'language' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"Authorization: <authorization>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.example.com/api/audio/transcriptions"
payload := strings.NewReader("{\n \"language\": \"<string>\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "<authorization>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.example.com/api/audio/transcriptions")
.header("Authorization", "<authorization>")
.header("Content-Type", "application/json")
.body("{\n \"language\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.example.com/api/audio/transcriptions")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = '<authorization>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"language\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"text": "<string>",
"filename": "<string>"
}Files & Media
Transcribe Audio
POST
/
api
/
audio
/
transcriptions
Transcribe Audio
curl --request POST \
--url https://api.example.com/api/audio/transcriptions \
--header 'Authorization: <authorization>' \
--header 'Content-Type: application/json' \
--data '
{
"language": "<string>"
}
'import requests
url = "https://api.example.com/api/audio/transcriptions"
payload = { "language": "<string>" }
headers = {
"Authorization": "<authorization>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: '<authorization>', 'Content-Type': 'application/json'},
body: JSON.stringify({language: '<string>'})
};
fetch('https://api.example.com/api/audio/transcriptions', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.example.com/api/audio/transcriptions",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'language' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"Authorization: <authorization>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.example.com/api/audio/transcriptions"
payload := strings.NewReader("{\n \"language\": \"<string>\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "<authorization>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.example.com/api/audio/transcriptions")
.header("Authorization", "<authorization>")
.header("Content-Type", "application/json")
.body("{\n \"language\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.example.com/api/audio/transcriptions")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = '<authorization>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"language\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"text": "<string>",
"filename": "<string>"
}Transcribe audio files to text using configured speech-to-text engines. Supports multiple STT providers including OpenAI Whisper, Deepgram, Azure, and Mistral.
Admin-only endpoint to update STT engine, model, and API credentials.
Request
Headers
string
required
Bearer token for authentication
Body
file
required
Audio file to transcribe. Supported formats: flac, m4a, mp3, mp4, mpeg, wav, webmMaximum file size varies by engine:
- Default engines: 20 MB
- Azure: 200 MB
string
Language code for transcription (e.g.,
en, es, fr). Used as a hint to improve accuracy.Response
string
The transcribed text from the audio file
string
Name of the processed audio file
Example
curl -X POST https://your-domain.com/api/audio/transcriptions \
-H "Authorization: Bearer YOUR_TOKEN" \
-F "file=@recording.mp3" \
-F "language=en"
Response
{
"text": "Hello, this is a sample audio transcription. The quick brown fox jumps over the lazy dog.",
"filename": "550e8400-e29b-41d4-a716-446655440000.mp3"
}
Supported Engines
Configure the STT engine in Admin Settings > Audio:Local Whisper (Default)
- Uses Faster Whisper model running locally
- Configurable model size and compute type
- Supports VAD filtering and multilingual mode
OpenAI Whisper API
- Cloud-based transcription using OpenAI’s API
- Requires OpenAI API key
- Supports language parameter
Deepgram
- High-accuracy transcription API
- Smart formatting enabled by default
- Requires Deepgram API key
Azure Speech Services
- Microsoft Azure cognitive services
- Supports speaker diarization (up to 3 speakers by default)
- Multi-locale detection
- Requires Azure subscription key and region
Mistral
- Uses Voxtral models for transcription
- Two methods: dedicated transcriptions API or chat completions
- Requires Mistral API key
Audio Processing
The API automatically handles:- Format conversion: Non-supported formats are converted to MP3
- Compression: Large files are compressed to reduce size
- Chunking: Files exceeding size limits are split into chunks
- Parallel processing: Multiple chunks processed concurrently
Permissions
Requires thechat.stt permission. Admin users have access by default.
Error Responses
Invalid file format or transcription failed
User does not have permission to use transcription
Configuration
To configure STT settings:POST /api/audio/config/update