Voice Agents API

The Voice Agents API enables you to create and manage voice-enabled AI agents with text-to-speech (TTS) and speech-to-text (STT) capabilities. Voice agents can handle real-time voice conversations using ElevenLabs voices and LiveKit for WebRTC communication.

Base URL

https://api.aloochat.ai/api/public

Authentication

All requests require an API key in the x-api-key header:

x-api-key: your_api_key_here

Endpoints Overview

Method	Endpoint	Description
`GET`	`/voice-agents`	List all voice agents
`POST`	`/voice-agents`	Create a new voice agent
`PUT`	`/voice-agents/{id}`	Update a voice agent
`DELETE`	`/voice-agents/{id}`	Delete a voice agent
`GET`	`/voice-agents/arabic`	Get curated Arabic voices
`GET`	`/voice-agents/english`	Get curated English voices
`GET`	`/voice-agents/multilingual`	Get multilingual voices
`POST`	`/voice-agents/elevenlabs/voices/{voiceId}/tts`	Text-to-speech
`POST`	`/voice-agents/stt`	Speech-to-text

Voice Agent Properties

Property	Type	Description
`id`	`string`	Unique voice agent identifier (UUID)
`name`	`string`	Voice agent name
`description`	`string`	Description of the voice agent
`voice_id`	`string`	ElevenLabs voice ID
`voice_name`	`string`	Human-readable voice name
`language`	`string`	Primary language code
`model_id`	`string`	ElevenLabs model ID (default: “eleven_turbo_v2_5”)
`active`	`boolean`	Whether the voice agent is active
`temperature`	`number`	Response creativity (0.0-1.0)
`voice_speed`	`number`	Speech speed percentage (100 = normal)
`voice_stability`	`number`	Voice stability (0.0-1.0)
`voice_similarity_boost`	`number`	Voice similarity boost (0.0-1.0)
`voice_style`	`number`	Style exaggeration (0.0-1.0)
`output_format`	`string`	Audio format (e.g., “mp3_44100_128”)
`company_id`	`string`	Associated company ID
`main_agent_id`	`string`	Linked main agent ID

List Voice Agents

Retrieve all voice agents for your company.

Endpoint: GET /voice-agents

curl -X GET "https://api.aloochat.ai/api/public/voice-agents" \
  -H "x-api-key: your_api_key_here" \
  -H "Content-Type: application/json"

const response = await fetch('https://api.aloochat.ai/api/public/voice-agents', {
  method: 'GET',
  headers: {
    'x-api-key': 'your_api_key_here',
    'Content-Type': 'application/json'
  }
});
 
const voiceAgents = await response.json();
console.log('Voice agents:', voiceAgents);

import requests
 
response = requests.get(
    'https://api.aloochat.ai/api/public/voice-agents',
    headers={
        'x-api-key': 'your_api_key_here',
        'Content-Type': 'application/json'
    }
)
 
voice_agents = response.json()
print('Voice agents:', voice_agents)

<?php
$ch = curl_init();
 
curl_setopt_array($ch, [
    CURLOPT_URL => 'https://api.aloochat.ai/api/public/voice-agents',
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_HTTPHEADER => [
        'x-api-key: your_api_key_here',
        'Content-Type: application/json'
    ]
]);
 
$response = curl_exec($ch);
$voiceAgents = json_decode($response, true);
curl_close($ch);
 
print_r($voiceAgents);
?>

require 'net/http'
require 'json'
 
uri = URI('https://api.aloochat.ai/api/public/voice-agents')
http = Net::HTTP.new(uri.host, uri.port)
http.use_ssl = true
 
request = Net::HTTP::Get.new(uri)
request['x-api-key'] = 'your_api_key_here'
request['Content-Type'] = 'application/json'
 
response = http.request(request)
voice_agents = JSON.parse(response.body)
puts voice_agents

Response

[
  {
    "id": "550e8400-e29b-41d4-a716-446655440000",
    "name": "Sarah - Customer Support",
    "description": "Friendly female voice for customer support",
    "voice_id": "EXAVITQu4vr4xnSDxMaL",
    "voice_name": "Sarah",
    "language": "en",
    "model_id": "eleven_turbo_v2_5",
    "active": true,
    "temperature": 0.7,
    "voice_speed": 100.0,
    "voice_stability": 0.5,
    "voice_similarity_boost": 0.5,
    "voice_style": 0.0,
    "output_format": "mp3_44100_128",
    "company_id": "123e4567-e89b-12d3-a456-426614174000",
    "created_at": "2024-01-15T10:30:00Z",
    "updated_at": "2024-01-15T10:30:00Z"
  }
]

Create Voice Agent

Create a new voice agent with custom voice settings.

Endpoint: POST /voice-agents

Request Body

Field	Type	Required	Description
`name`	`string`	Yes	Voice agent name
`voice_id`	`string`	Yes	ElevenLabs voice ID
`description`	`string`	No	Description
`voice_name`	`string`	No	Human-readable voice name
`language`	`string`	No	Language code (e.g., “en”, “ar”)
`model_id`	`string`	No	ElevenLabs model ID
`active`	`boolean`	No	Whether active (default: false)
`temperature`	`number`	No	Creativity level (default: 0.7)
`voice_speed`	`number`	No	Speed percentage (default: 100)
`voice_stability`	`number`	No	Stability (default: 0.5)
`voice_similarity_boost`	`number`	No	Similarity boost (default: 0.5)
`voice_style`	`number`	No	Style exaggeration (default: 0.0)
`main_agent_id`	`string`	No	Link to main agent

curl -X POST "https://api.aloochat.ai/api/public/voice-agents" \
  -H "x-api-key: your_api_key_here" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "Customer Support Voice",
    "voice_id": "EXAVITQu4vr4xnSDxMaL",
    "voice_name": "Sarah",
    "description": "Friendly female voice for customer support",
    "language": "en",
    "model_id": "eleven_turbo_v2_5",
    "active": true,
    "temperature": 0.7,
    "voice_speed": 100.0,
    "voice_stability": 0.5,
    "voice_similarity_boost": 0.75,
    "voice_style": 0.0,
    "output_format": "mp3_44100_128"
  }'

const response = await fetch('https://api.aloochat.ai/api/public/voice-agents', {
  method: 'POST',
  headers: {
    'x-api-key': 'your_api_key_here',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    name: 'Customer Support Voice',
    voice_id: 'EXAVITQu4vr4xnSDxMaL',
    voice_name: 'Sarah',
    description: 'Friendly female voice for customer support',
    language: 'en',
    model_id: 'eleven_turbo_v2_5',
    active: true,
    temperature: 0.7,
    voice_speed: 100.0,
    voice_stability: 0.5,
    voice_similarity_boost: 0.75,
    voice_style: 0.0,
    output_format: 'mp3_44100_128'
  })
});
 
const voiceAgent = await response.json();
console.log('Voice agent created:', voiceAgent);

import requests
 
response = requests.post(
    'https://api.aloochat.ai/api/public/voice-agents',
    headers={
        'x-api-key': 'your_api_key_here',
        'Content-Type': 'application/json'
    },
    json={
        'name': 'Customer Support Voice',
        'voice_id': 'EXAVITQu4vr4xnSDxMaL',
        'voice_name': 'Sarah',
        'description': 'Friendly female voice for customer support',
        'language': 'en',
        'model_id': 'eleven_turbo_v2_5',
        'active': True,
        'temperature': 0.7,
        'voice_speed': 100.0,
        'voice_stability': 0.5,
        'voice_similarity_boost': 0.75,
        'voice_style': 0.0,
        'output_format': 'mp3_44100_128'
    }
)
 
voice_agent = response.json()
print('Voice agent created:', voice_agent)

<?php
$ch = curl_init();
 
$data = [
    'name' => 'Customer Support Voice',
    'voice_id' => 'EXAVITQu4vr4xnSDxMaL',
    'voice_name' => 'Sarah',
    'description' => 'Friendly female voice for customer support',
    'language' => 'en',
    'model_id' => 'eleven_turbo_v2_5',
    'active' => true,
    'temperature' => 0.7,
    'voice_speed' => 100.0,
    'voice_stability' => 0.5,
    'voice_similarity_boost' => 0.75,
    'voice_style' => 0.0,
    'output_format' => 'mp3_44100_128'
];
 
curl_setopt_array($ch, [
    CURLOPT_URL => 'https://api.aloochat.ai/api/public/voice-agents',
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_POST => true,
    CURLOPT_POSTFIELDS => json_encode($data),
    CURLOPT_HTTPHEADER => [
        'x-api-key: your_api_key_here',
        'Content-Type: application/json'
    ]
]);
 
$response = curl_exec($ch);
$voiceAgent = json_decode($response, true);
curl_close($ch);
 
print_r($voiceAgent);
?>

require 'net/http'
require 'json'
 
uri = URI('https://api.aloochat.ai/api/public/voice-agents')
http = Net::HTTP.new(uri.host, uri.port)
http.use_ssl = true
 
request = Net::HTTP::Post.new(uri)
request['x-api-key'] = 'your_api_key_here'
request['Content-Type'] = 'application/json'
request.body = {
  name: 'Customer Support Voice',
  voice_id: 'EXAVITQu4vr4xnSDxMaL',
  voice_name: 'Sarah',
  description: 'Friendly female voice for customer support',
  language: 'en',
  model_id: 'eleven_turbo_v2_5',
  active: true,
  temperature: 0.7,
  voice_speed: 100.0,
  voice_stability: 0.5,
  voice_similarity_boost: 0.75,
  voice_style: 0.0,
  output_format: 'mp3_44100_128'
}.to_json
 
response = http.request(request)
voice_agent = JSON.parse(response.body)
puts voice_agent

Response

{
  "id": "550e8400-e29b-41d4-a716-446655440000",
  "name": "Customer Support Voice",
  "description": "Friendly female voice for customer support",
  "voice_id": "EXAVITQu4vr4xnSDxMaL",
  "voice_name": "Sarah",
  "language": "en",
  "model_id": "eleven_turbo_v2_5",
  "active": true,
  "temperature": 0.7,
  "voice_speed": 100.0,
  "voice_stability": 0.5,
  "voice_similarity_boost": 0.75,
  "voice_style": 0.0,
  "output_format": "mp3_44100_128",
  "company_id": "123e4567-e89b-12d3-a456-426614174000",
  "created_at": "2024-01-15T10:30:00Z",
  "updated_at": "2024-01-15T10:30:00Z"
}

Update Voice Agent

Update an existing voice agent’s settings.

Endpoint: PUT /voice-agents/{id}

curl -X PUT "https://api.aloochat.ai/api/public/voice-agents/550e8400-e29b-41d4-a716-446655440000" \
  -H "x-api-key: your_api_key_here" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "Updated Voice Agent",
    "voice_stability": 0.7,
    "voice_speed": 110.0,
    "active": true
  }'

const voiceAgentId = '550e8400-e29b-41d4-a716-446655440000';
 
const response = await fetch(`https://api.aloochat.ai/api/public/voice-agents/${voiceAgentId}`, {
  method: 'PUT',
  headers: {
    'x-api-key': 'your_api_key_here',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    name: 'Updated Voice Agent',
    voice_stability: 0.7,
    voice_speed: 110.0,
    active: true
  })
});
 
const updatedVoiceAgent = await response.json();
console.log('Voice agent updated:', updatedVoiceAgent);

import requests
 
voice_agent_id = '550e8400-e29b-41d4-a716-446655440000'
 
response = requests.put(
    f'https://api.aloochat.ai/api/public/voice-agents/{voice_agent_id}',
    headers={
        'x-api-key': 'your_api_key_here',
        'Content-Type': 'application/json'
    },
    json={
        'name': 'Updated Voice Agent',
        'voice_stability': 0.7,
        'voice_speed': 110.0,
        'active': True
    }
)
 
updated_voice_agent = response.json()
print('Voice agent updated:', updated_voice_agent)

<?php
$voiceAgentId = '550e8400-e29b-41d4-a716-446655440000';
$ch = curl_init();
 
$data = [
    'name' => 'Updated Voice Agent',
    'voice_stability' => 0.7,
    'voice_speed' => 110.0,
    'active' => true
];
 
curl_setopt_array($ch, [
    CURLOPT_URL => "https://api.aloochat.ai/api/public/voice-agents/{$voiceAgentId}",
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_CUSTOMREQUEST => 'PUT',
    CURLOPT_POSTFIELDS => json_encode($data),
    CURLOPT_HTTPHEADER => [
        'x-api-key: your_api_key_here',
        'Content-Type: application/json'
    ]
]);
 
$response = curl_exec($ch);
$updatedVoiceAgent = json_decode($response, true);
curl_close($ch);
 
print_r($updatedVoiceAgent);
?>

require 'net/http'
require 'json'
 
voice_agent_id = '550e8400-e29b-41d4-a716-446655440000'
uri = URI("https://api.aloochat.ai/api/public/voice-agents/#{voice_agent_id}")
http = Net::HTTP.new(uri.host, uri.port)
http.use_ssl = true
 
request = Net::HTTP::Put.new(uri)
request['x-api-key'] = 'your_api_key_here'
request['Content-Type'] = 'application/json'
request.body = {
  name: 'Updated Voice Agent',
  voice_stability: 0.7,
  voice_speed: 110.0,
  active: true
}.to_json
 
response = http.request(request)
updated_voice_agent = JSON.parse(response.body)
puts updated_voice_agent

Delete Voice Agent

Delete a voice agent.

Endpoint: DELETE /voice-agents/{id}

curl -X DELETE "https://api.aloochat.ai/api/public/voice-agents/550e8400-e29b-41d4-a716-446655440000" \
  -H "x-api-key: your_api_key_here"

const voiceAgentId = '550e8400-e29b-41d4-a716-446655440000';
 
const response = await fetch(`https://api.aloochat.ai/api/public/voice-agents/${voiceAgentId}`, {
  method: 'DELETE',
  headers: {
    'x-api-key': 'your_api_key_here'
  }
});
 
if (response.status === 204) {
  console.log('Voice agent deleted successfully');
}

import requests
 
voice_agent_id = '550e8400-e29b-41d4-a716-446655440000'
 
response = requests.delete(
    f'https://api.aloochat.ai/api/public/voice-agents/{voice_agent_id}',
    headers={
        'x-api-key': 'your_api_key_here'
    }
)
 
if response.status_code == 204:
    print('Voice agent deleted successfully')

<?php
$voiceAgentId = '550e8400-e29b-41d4-a716-446655440000';
$ch = curl_init();
 
curl_setopt_array($ch, [
    CURLOPT_URL => "https://api.aloochat.ai/api/public/voice-agents/{$voiceAgentId}",
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_CUSTOMREQUEST => 'DELETE',
    CURLOPT_HTTPHEADER => [
        'x-api-key: your_api_key_here'
    ]
]);
 
$response = curl_exec($ch);
$httpCode = curl_getinfo($ch, CURLINFO_HTTP_CODE);
curl_close($ch);
 
if ($httpCode === 204) {
    echo 'Voice agent deleted successfully';
}
?>

require 'net/http'
 
voice_agent_id = '550e8400-e29b-41d4-a716-446655440000'
uri = URI("https://api.aloochat.ai/api/public/voice-agents/#{voice_agent_id}")
http = Net::HTTP.new(uri.host, uri.port)
http.use_ssl = true
 
request = Net::HTTP::Delete.new(uri)
request['x-api-key'] = 'your_api_key_here'
 
response = http.request(request)
puts 'Voice agent deleted successfully' if response.code == '204'

Get Available Voices

Arabic Voices

Get curated Arabic voices from ElevenLabs.

Endpoint: GET /voice-agents/arabic

Query Parameters:

Parameter	Type	Description
`gender`	`string`	Filter by gender (“male” or “female”)

curl -X GET "https://api.aloochat.ai/api/public/voice-agents/arabic?gender=female" \
  -H "x-api-key: your_api_key_here"

const response = await fetch('https://api.aloochat.ai/api/public/voice-agents/arabic?gender=female', {
  headers: {
    'x-api-key': 'your_api_key_here'
  }
});
 
const arabicVoices = await response.json();
console.log('Arabic voices:', arabicVoices);

import requests
 
response = requests.get(
    'https://api.aloochat.ai/api/public/voice-agents/arabic',
    params={'gender': 'female'},
    headers={'x-api-key': 'your_api_key_here'}
)
 
arabic_voices = response.json()
print('Arabic voices:', arabic_voices)

<?php
$ch = curl_init();
 
curl_setopt_array($ch, [
    CURLOPT_URL => 'https://api.aloochat.ai/api/public/voice-agents/arabic?gender=female',
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_HTTPHEADER => [
        'x-api-key: your_api_key_here'
    ]
]);
 
$response = curl_exec($ch);
$arabicVoices = json_decode($response, true);
curl_close($ch);
 
print_r($arabicVoices);
?>

require 'net/http'
require 'json'
 
uri = URI('https://api.aloochat.ai/api/public/voice-agents/arabic?gender=female')
http = Net::HTTP.new(uri.host, uri.port)
http.use_ssl = true
 
request = Net::HTTP::Get.new(uri)
request['x-api-key'] = 'your_api_key_here'
 
response = http.request(request)
arabic_voices = JSON.parse(response.body)
puts arabic_voices

English Voices

Get curated English voices from ElevenLabs.

Endpoint: GET /voice-agents/english

Query Parameters:

Parameter	Type	Description
`gender`	`string`	Filter by gender
`category`	`string`	Filter by category
`accent`	`string`	Filter by accent
`featured_only`	`boolean`	Only featured voices
`max_voices`	`integer`	Maximum voices to return (default: 100)

Multilingual Voices

Get voices that support multiple languages (Arabic and English).

Endpoint: GET /voice-agents/multilingual

Text-to-Speech (TTS)

Convert text to speech using a specific voice.

Endpoint: POST /voice-agents/elevenlabs/voices/{voiceId}/tts

Request Body

Field	Type	Required	Description
`text`	`string`	Yes	Text to convert to speech
`model_id`	`string`	No	ElevenLabs model ID
`language_code`	`string`	No	Language code (e.g., “en”, “ar”)
`voice_speed`	`number`	No	Speed percentage
`voice_stability`	`number`	No	Stability (0.0-1.0)
`voice_similarity_boost`	`number`	No	Similarity boost (0.0-1.0)
`voice_style`	`number`	No	Style exaggeration (0.0-1.0)
`output_format`	`string`	No	Audio format

curl -X POST "https://api.aloochat.ai/api/public/voice-agents/elevenlabs/voices/EXAVITQu4vr4xnSDxMaL/tts" \
  -H "x-api-key: your_api_key_here" \
  -H "Content-Type: application/json" \
  -d '{
    "text": "Hello! Welcome to our customer support. How can I help you today?",
    "model_id": "eleven_turbo_v2_5",
    "language_code": "en",
    "voice_stability": 0.5,
    "voice_similarity_boost": 0.75
  }' \
  --output audio.mp3

const voiceId = 'EXAVITQu4vr4xnSDxMaL';
 
const response = await fetch(`https://api.aloochat.ai/api/public/voice-agents/elevenlabs/voices/${voiceId}/tts`, {
  method: 'POST',
  headers: {
    'x-api-key': 'your_api_key_here',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    text: 'Hello! Welcome to our customer support. How can I help you today?',
    model_id: 'eleven_turbo_v2_5',
    language_code: 'en',
    voice_stability: 0.5,
    voice_similarity_boost: 0.75
  })
});
 
// Response is audio stream
const audioBlob = await response.blob();
const audioUrl = URL.createObjectURL(audioBlob);
 
// Play the audio
const audio = new Audio(audioUrl);
audio.play();

import requests
 
voice_id = 'EXAVITQu4vr4xnSDxMaL'
 
response = requests.post(
    f'https://api.aloochat.ai/api/public/voice-agents/elevenlabs/voices/{voice_id}/tts',
    headers={
        'x-api-key': 'your_api_key_here',
        'Content-Type': 'application/json'
    },
    json={
        'text': 'Hello! Welcome to our customer support. How can I help you today?',
        'model_id': 'eleven_turbo_v2_5',
        'language_code': 'en',
        'voice_stability': 0.5,
        'voice_similarity_boost': 0.75
    }
)
 
# Save audio to file
with open('audio.mp3', 'wb') as f:
    f.write(response.content)
 
print('Audio saved to audio.mp3')

<?php
$voiceId = 'EXAVITQu4vr4xnSDxMaL';
$ch = curl_init();
 
$data = [
    'text' => 'Hello! Welcome to our customer support. How can I help you today?',
    'model_id' => 'eleven_turbo_v2_5',
    'language_code' => 'en',
    'voice_stability' => 0.5,
    'voice_similarity_boost' => 0.75
];
 
curl_setopt_array($ch, [
    CURLOPT_URL => "https://api.aloochat.ai/api/public/voice-agents/elevenlabs/voices/{$voiceId}/tts",
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_POST => true,
    CURLOPT_POSTFIELDS => json_encode($data),
    CURLOPT_HTTPHEADER => [
        'x-api-key: your_api_key_here',
        'Content-Type: application/json'
    ]
]);
 
$audioData = curl_exec($ch);
curl_close($ch);
 
// Save audio to file
file_put_contents('audio.mp3', $audioData);
echo 'Audio saved to audio.mp3';
?>

require 'net/http'
require 'json'
 
voice_id = 'EXAVITQu4vr4xnSDxMaL'
uri = URI("https://api.aloochat.ai/api/public/voice-agents/elevenlabs/voices/#{voice_id}/tts")
http = Net::HTTP.new(uri.host, uri.port)
http.use_ssl = true
 
request = Net::HTTP::Post.new(uri)
request['x-api-key'] = 'your_api_key_here'
request['Content-Type'] = 'application/json'
request.body = {
  text: 'Hello! Welcome to our customer support. How can I help you today?',
  model_id: 'eleven_turbo_v2_5',
  language_code: 'en',
  voice_stability: 0.5,
  voice_similarity_boost: 0.75
}.to_json
 
response = http.request(request)
 
# Save audio to file
File.open('audio.mp3', 'wb') { |f| f.write(response.body) }
puts 'Audio saved to audio.mp3'

Speech-to-Text (STT)

Convert speech audio to text.

Endpoint: POST /voice-agents/stt

Content-Type: multipart/form-data

Request Body

Field	Type	Required	Description
`file`	`file`	Yes	Audio file to transcribe

curl -X POST "https://api.aloochat.ai/api/public/voice-agents/stt" \
  -H "x-api-key: your_api_key_here" \
  -F "file=@audio.mp3"

const formData = new FormData();
formData.append('file', audioFile); // audioFile is a File object
 
const response = await fetch('https://api.aloochat.ai/api/public/voice-agents/stt', {
  method: 'POST',
  headers: {
    'x-api-key': 'your_api_key_here'
  },
  body: formData
});
 
const result = await response.json();
console.log('Transcribed text:', result.text);

import requests
 
with open('audio.mp3', 'rb') as audio_file:
    response = requests.post(
        'https://api.aloochat.ai/api/public/voice-agents/stt',
        headers={
            'x-api-key': 'your_api_key_here'
        },
        files={
            'file': ('audio.mp3', audio_file, 'audio/mpeg')
        }
    )
 
result = response.json()
print('Transcribed text:', result['text'])

<?php
$ch = curl_init();
 
$cfile = new CURLFile('audio.mp3', 'audio/mpeg', 'audio.mp3');
 
curl_setopt_array($ch, [
    CURLOPT_URL => 'https://api.aloochat.ai/api/public/voice-agents/stt',
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_POST => true,
    CURLOPT_POSTFIELDS => ['file' => $cfile],
    CURLOPT_HTTPHEADER => [
        'x-api-key: your_api_key_here'
    ]
]);
 
$response = curl_exec($ch);
$result = json_decode($response, true);
curl_close($ch);
 
echo 'Transcribed text: ' . $result['text'];
?>

require 'net/http'
require 'json'
 
uri = URI('https://api.aloochat.ai/api/public/voice-agents/stt')
http = Net::HTTP.new(uri.host, uri.port)
http.use_ssl = true
 
request = Net::HTTP::Post.new(uri)
request['x-api-key'] = 'your_api_key_here'
 
# Create multipart form data
boundary = "----WebKitFormBoundary#{rand(1000000)}"
request['Content-Type'] = "multipart/form-data; boundary=#{boundary}"
 
audio_data = File.binread('audio.mp3')
body = "--#{boundary}\r\n"
body += "Content-Disposition: form-data; name=\"file\"; filename=\"audio.mp3\"\r\n"
body += "Content-Type: audio/mpeg\r\n\r\n"
body += audio_data
body += "\r\n--#{boundary}--\r\n"
 
request.body = body
 
response = http.request(request)
result = JSON.parse(response.body)
puts "Transcribed text: #{result['text']}"

Response

{
  "text": "Hello, I need help with my order."
}

Error Responses

Status Code	Description
`400`	Bad Request - Invalid input data
`401`	Unauthorized - Invalid or missing API key
`403`	Forbidden - Insufficient permissions
`404`	Not Found - Voice agent not found
`429`	Too Many Requests - Rate limit exceeded
`500`	Internal Server Error

Error Response Format

{
  "detail": "Voice agent not found"
}

Documents Integrations