0
Fork 0
mirror of https://github.com/mastra-ai/mastra.git synced 2026-11-17 08:44:46 +00:00
mastra/voice/openai
History 2026-10-28 13:15:52 +00:00
..
__fixtures__ feat: deprecate @mastra/speech-openai for @mastra/voice-openai (#1989) 2025-02-24 09:38:22 -08:00
src Extract voice internals from core (#16725) 2026-05-27 16:37:08 +02:00
test-outputs [MASTRA-2558] Update voice hono routes (#3022) 2025-03-18 12:22:53 -07:00
CHANGELOG.md chore: version - exit prerelease mode 2026-10-28 13:15:52 +00:00
lint-staged.config.js refactor(lint): replace ESLint with type-aware oxlint (#27476) 2026-10-18 10:38:35 -07:00
package.json chore: version - exit prerelease mode 2026-10-28 13:15:52 +00:00
README.md chore(*): Update/unify/add READMEs (#22858) 2026-09-02 14:36:59 +02:00
tsconfig.build.json chore: fix go-to-definition using tsc declaration maps (#6089) 2025-07-30 15:41:00 -07:00
tsconfig.json chore: migrate package builds to tsdown (#19829) 2026-07-28 12:32:21 +02:00
tsdown.config.ts chore: migrate package builds to tsdown (#19829) 2026-07-28 12:32:21 +02:00
vitest.config.ts refactor: reorganize core tests and namespace vitest projects across monorepo (#12662) 2026-02-09 10:24:48 +01:00

@mastra/voice-openai

Add OpenAI text-to-speech and speech-to-text to Mastra with configurable models, voices, audio formats, synthesis, and transcription.

Installation

npm install @mastra/voice-openai

Usage

import { OpenAIVoice } from '@mastra/voice-openai';

// Create voice with both speech and listening capabilities
const voice = new OpenAIVoice({
  speechModel: {
    name: 'tts-1', // or 'tts-1-hd' for higher quality
    apiKey: 'your-api-key', // Optional, can use OPENAI_API_KEY env var
  },
  listeningModel: {
    name: 'whisper-1',
    apiKey: 'your-api-key', // Optional, can use OPENAI_API_KEY env var
  },
  speaker: 'alloy', // Default voice
});

// Or create speech-only voice
const speechVoice = new OpenAIVoice({
  speechModel: {
    name: 'tts-1',
    apiKey: 'your-api-key',
  },
  speaker: 'nova',
});

// Or create listening-only voice
const listeningVoice = new OpenAIVoice({
  listeningModel: {
    name: 'whisper-1',
    apiKey: 'your-api-key',
  },
});

// List available voices
const speakers = await voice.getSpeakers();

// Generate speech
const audioStream = await voice.speak('Hello from Mastra!', {
  speaker: 'nova', // Optional: override default speaker
  speed: 1.0, // Optional: adjust speech speed
});

// Convert speech to text
const text = await voice.listen(audioStream, {
  filetype: 'wav',
});

Documentation

Changelog

See the package changelog for version history and release notes.

Support

We have an open community Discord. Come and say hello and let us know if you have any questions or need any help getting things running.