Skip to main content

Documentation

Everything you need to get started with SpeakEasy and master voice-driven development.

Quick Start

Get up and running in just 4 steps

Step 1

Download & Install

Download SpeakEasy for Windows 10+ and run the installer.

Step 2

Get API Key

Sign up at OpenAI and get your Whisper API key.

Step 3

Configure Settings

Right-click system tray icon → Settings → Enter API key.

Step 4

Start Dictating

Press Ctrl+Shift+Space to record. Speak naturally!

Installation Guide

Get SpeakEasy up and running on your Windows machine

Windows 10+

  1. 1Download the .exe installer from the download page
  2. 2Run the installer and follow the setup wizard
  3. 3Grant microphone permissions when prompted
  4. 4Launch SpeakEasy from the Start Menu or system tray
  5. 5Right-click system tray icon → Settings → Enter your OpenAI API key
  6. 6Select your IDE (Windsurf or Cline)
  7. 7Choose your mode (Agent Chat, Email, Document, or Outline)

OpenAI API Key Required

SpeakEasy uses OpenAI's Whisper API for transcription. You'll need your own API key to use the app.

  • Get your API key from OpenAI Platform
  • Transcription costs approximately $0.006 per minute of audio
  • You'll need to add payment info to your OpenAI account

How to Use SpeakEasy

Master the basics and unlock your voice-driven workflow

The Basics

SpeakEasy runs quietly in your system tray, ready to transcribe whenever you need it. Here's everything you need to know:

Recording Modes

Toggle Mode (Default)

Press once to start, press again to stop

Ctrl+Shift+Space

Push-to-Talk Mode

Hold to record, release to stop

Ctrl+`

System Tray

Look for the SpeakEasy icon in your Windows system tray (bottom-right corner, near the clock).

Right-click the icon to:

  • Open Settings
  • Switch Modes
  • Start/Stop Recording
  • Quit the application

Settings & Configuration

Customize SpeakEasy to match your workflow

Accessing Settings

Right-click the SpeakEasy system tray icon (bottom-right corner of Windows, near the clock) and select "Settings"

OpenAI API Key

Required

Get from OpenAI Platform - Learn more

Application Mode

Optional

Choose text formatting: Agent Chat, Email, Document, or Outline

Troubleshooting

Solutions to common issues

API Key Required Error

  • Right-click the SpeakEasy system tray icon → Settings
  • Enter your OpenAI API key in the API Key field
  • Get your API key from OpenAI Platform
  • Ensure you have payment info added to your OpenAI account

Recording Doesn't Start

  • Check that SpeakEasy is running (look for system tray icon)
  • Verify microphone permissions in Windows Settings
  • Try the alternative hotkey: Ctrl+` (backtick) for push-to-talk

Transcription Fails or Is Inaccurate

  • Verify your OpenAI API key is correct in Settings
  • Check your internet connection
  • Speak clearly in a quiet environment
  • Ensure you have OpenAI API credits available

Still need help?

Can't find the answer you're looking for? Contact our support team.

Contact Support