listVoices

function listVoices<TAdapter>(options): Promise<ListVoicesResult>;

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

List the voices an account can pass to generateSpeech().

Only providers with a per-account catalog implement this. A provider whose voices are a fixed list publishes that list as a const in its package, so import it from there rather than calling this.

Type Parameters#

TAdapter#

TAdapter extends TTSAdapter<string, TTSProviderOptions<TAdapter>>

Parameters#

options#

ListVoicesActivityOptions<TAdapter>

Returns#

Promise<ListVoicesResult>

Example#

Find the voices you created

import { listVoices } from '@tanstack/ai'
import { elevenlabsSpeech } from '@tanstack/ai-elevenlabs'

const { voices } = await listVoices({
  adapter: elevenlabsSpeech('eleven_v3'),
  origins: ['generated', 'cloned'],
})