generateSpeech

function generateSpeech<TAdapter, TStream>(options): TTSActivityResult<TStream>;

Defined in: packages/ai/src/activities/generateSpeech/index.ts:257

TTS activity - generates speech from text.

Uses AI text-to-speech models to create audio from natural language text.

Type Parameters

TAdapter

TAdapter extends TTSAdapter<string, TTSProviderOptions<TAdapter>>

TStream

TStream extends boolean = false

Parameters

options

TTSActivityOptions<TAdapter, TStream>

Returns

TTSActivityResult<TStream>

Examples

Generate speech from text

import { generateSpeech } from '@tanstack/ai'
import { openaiSpeech } from '@tanstack/ai-openai'

const result = await generateSpeech({
  adapter: openaiSpeech('tts-1-hd'),
  text: 'Hello, welcome to TanStack AI!',
  voice: 'nova',
  threadId,
})

console.log(result.audio) // base64-encoded audio

With format and speed options

const result = await generateSpeech({
  adapter: openaiSpeech('tts-1'),
  text: 'This is slower speech.',
  voice: 'alloy',
  threadId,
  format: 'wav',
  speed: 0.8
})