--- title: Hume description: Learn how to use the Hume provider for the AI SDK. --- # Hume Provider The [Hume](https://hume.ai/) provider contains support for the Hume text-to-speech (TTS) API. ## Setup The Hume provider is available in the `@ai-sdk/hume` module. You can install it with ## Provider Instance You can import the default provider instance `hume` from `@ai-sdk/hume`: ```ts import { hume } from '@ai-sdk/hume'; ``` If you need a customized setup, you can import `createHume` from `@ai-sdk/hume` and create a provider instance with your settings: ```ts import { createHume } from '@ai-sdk/hume'; const hume = createHume({ // custom settings, e.g. fetch: customFetch, }); ``` You can use the following optional settings to customize the Hume provider instance: - **apiKey** _string_ API key that is being sent using the `X-Hume-Api-Key` header. It defaults to the `HUME_API_KEY` environment variable. - **headers** _Record<string,string>_ Custom headers to include in the requests. - **fetch** _(input: RequestInfo, init?: RequestInit) => Promise<Response>_ Custom [fetch](https://developer.mozilla.org/en-US/docs/Web/API/fetch) implementation. Defaults to the global `fetch` function. You can use it as a middleware to intercept requests, or to provide a custom fetch implementation for e.g. testing. ## Speech Models You can create models that call the [Hume speech API](https://dev.hume.ai/docs/text-to-speech-tts/overview) using the `.speech()` factory method. ```ts const model = hume.speech(); ``` You can pass standard speech generation options like `voice`, `speed`, `instructions`, and `outputFormat`: ```ts import { experimental_generateSpeech as generateSpeech } from 'ai'; import { hume } from '@ai-sdk/hume'; const result = await generateSpeech({ model: hume.speech(), text: 'Hello, world!', voice: 'd8ab67c6-953d-4bd8-9370-8fa53a0f1453', speed: 1.0, instructions: 'Speak in a friendly, conversational tone.', outputFormat: 'mp3', }); ``` ### Supported Parameters - **text** _string_ (required) The text to convert to speech. - **voice** _string_ The voice ID to use for the generated audio. Defaults to `'d8ab67c6-953d-4bd8-9370-8fa53a0f1453'`. - **speed** _number_ Speech rate multiplier. - **instructions** _string_ Description or instructions for how the text should be spoken. - **outputFormat** _string_ The audio format to generate. Supported values: `'mp3'`, `'pcm'`, `'wav'`. Defaults to `'mp3'`. The `language` parameter is not supported by Hume speech models and will be ignored with a warning. ### Provider Options You can pass additional provider-specific options using the `providerOptions` argument: ```ts import { experimental_generateSpeech as generateSpeech } from 'ai'; import { hume } from '@ai-sdk/hume'; import { type HumeSpeechModelOptions } from '@ai-sdk/hume'; const result = await generateSpeech({ model: hume.speech(), text: 'Hello, world!', providerOptions: { hume: { context: { generationId: 'previous-generation-id', }, } satisfies HumeSpeechModelOptions, }, }); ``` The following provider options are available: - **context** _object_ Context for the speech synthesis request. Can be either: - `{ generationId: string }` - ID of a previously generated speech synthesis to use as context. - `{ utterances: Utterance[] }` - An array of utterance objects for context, where each utterance has: - `text` _string_ (required) - The text content. - `description` _string_ - Instructions for how the text should be spoken. - `speed` _number_ - Speech rate multiplier. - `trailingSilence` _number_ - Duration of silence to add after the utterance in seconds. - `voice` _object_ - Voice configuration, either `{ id: string, provider?: 'HUME_AI' | 'CUSTOM_VOICE' }` or `{ name: string, provider?: 'HUME_AI' | 'CUSTOM_VOICE' }`. ### Model Capabilities | Model | Instructions | Speed | Output Formats | | --------- | ------------------- | ------------------- | -------------- | | `default` | | | mp3, pcm, wav |