Skip to main content

client.tts.create(request)

Returns the full audio buffer in a single response. Best for batch/offline use where you don’t need real-time playback.
import UpliftAI from '@upliftai/sdk-js';
import { writeFileSync } from 'fs';

const client = new UpliftAI({
  apiKey: 'your-api-key',
});

const { audio, metadata } = await client.tts.create({
  text: 'السلام علیکم، یہ ایک ٹیسٹ ہے',
  voiceId: 'v_meklc281',
  outputFormat: 'MP3_22050_128',
});

writeFileSync('output.mp3', audio);
console.log('Metadata:', metadata);
console.log(`Audio size: ${audio.length} bytes`);

Request Parameters

ParameterTypeRequiredDescription
textstringYesText to synthesize (Urdu, English, or mixed)
voiceIdstringYesVoice profile ID (e.g. v_meklc281)
outputFormatstringNoAudio format — defaults to WAV_22050_32
phraseReplacementConfigIdstringNoID from phrase replacements

Response

FieldTypeDescription
audioBufferComplete audio data
metadata.requestIdstringRequest ID for debugging
metadata.contentTypestringMIME type of the audio
metadata.sampleRatenumberAudio sample rate