# OpenWhispr

## Docs

- [Request verification code](https://docs.openwhispr.com/api-reference/auth/request-verification-code.md): Send a 6-digit verification code to the given email address. The code expires after 10 minutes.
- [Verify code](https://docs.openwhispr.com/api-reference/auth/verify-code.md): Verify a 6-digit code and receive a short-lived session token (valid for 15 minutes).
- [Create folder](https://docs.openwhispr.com/api-reference/folders/create-folder.md): Create a new folder. Max 50 folders per user.
- [List folders](https://docs.openwhispr.com/api-reference/folders/list-folders.md): List all folders sorted by sort_order, then created_at.
- [Create API key](https://docs.openwhispr.com/api-reference/keys/create-api-key.md): Create a new API key. The full key is only returned once in the response.
- [List API keys](https://docs.openwhispr.com/api-reference/keys/list-api-keys.md): List all active API keys for the authenticated user.
- [Revoke API key](https://docs.openwhispr.com/api-reference/keys/revoke-api-key.md): Revoke an API key. The key will stop working immediately.
- [Create note](https://docs.openwhispr.com/api-reference/notes/create-note.md): Create a new note.
- [Delete note](https://docs.openwhispr.com/api-reference/notes/delete-note.md): Soft-delete a note.
- [Get note](https://docs.openwhispr.com/api-reference/notes/get-note.md): Get a single note by ID.
- [List notes](https://docs.openwhispr.com/api-reference/notes/list-notes.md): List notes with optional folder filtering and cursor pagination.
- [Search notes](https://docs.openwhispr.com/api-reference/notes/search-notes.md): Search notes using hybrid semantic (vector) and full-text search. Costs 5x against the rate limit.
- [Update note](https://docs.openwhispr.com/api-reference/notes/update-note.md): Update a note's title, content, or folder. All fields are optional — only provided fields are updated.
- [List spaces](https://docs.openwhispr.com/api-reference/spaces/list-spaces.md): List the team spaces a workspace API key can address, sorted by name. Archived spaces are omitted. Requires a workspace key (ow_wks_live_) holding any of workspace:notes:read, workspace:notes:write, workspace:folders:read or workspace:folders:write.
- [Delete transcription](https://docs.openwhispr.com/api-reference/transcriptions/delete-transcription.md): Soft-delete a transcription by ID.
- [Get note transcript](https://docs.openwhispr.com/api-reference/transcriptions/get-note-transcript.md): Get the transcript associated with a note. If the note has a linked transcription record, returns it with structured segments. For older notes with only raw transcript text, returns the text with segments as null.
- [Get transcription](https://docs.openwhispr.com/api-reference/transcriptions/get-transcription.md): Get a single transcription by ID. Supports multiple output formats including SRT and VTT subtitles.
- [List transcriptions](https://docs.openwhispr.com/api-reference/transcriptions/list-transcriptions.md): List transcription history with cursor pagination, newest first. Supports filtering by language or linked note.
- [Get usage](https://docs.openwhispr.com/api-reference/usage/get-usage.md): Get current usage statistics, word counts, and plan details.
- [Errors](https://docs.openwhispr.com/api/errors.md): Error codes and how to handle them.
- [API overview](https://docs.openwhispr.com/api/overview.md): Authenticate, understand rate limits, and work with the OpenWhispr REST API.
- [API quickstart](https://docs.openwhispr.com/api/quickstart.md): Make your first API call in under a minute.
- [Workspace API keys](https://docs.openwhispr.com/api/workspace-keys.md): Reach your team's shared notes and folders from the API using a workspace key.
- [CLI authentication](https://docs.openwhispr.com/cli/authentication.md): How the CLI authenticates to the local desktop app and the cloud API.
- [Local vs cloud backends](https://docs.openwhispr.com/cli/backends.md): How the CLI decides whether to talk to the desktop app or the cloud API.
- [Command reference](https://docs.openwhispr.com/cli/commands.md): Every OpenWhispr CLI command, organized by noun.
- [CLI install](https://docs.openwhispr.com/cli/install.md): Install the OpenWhispr CLI and verify it can reach your data.
- [Contributing](https://docs.openwhispr.com/contributing.md): How to contribute to OpenWhispr.
- [FAQ](https://docs.openwhispr.com/faq.md): Frequently asked questions about OpenWhispr.
- [AI agent](https://docs.openwhispr.com/guides/agent-mode.md): Speak an instruction instead of text, or open a chat that can work with your notes.
- [Cloud vs local processing](https://docs.openwhispr.com/guides/cloud-vs-local.md): Choose between cloud, bring-your-own-key, enterprise, and fully local processing.
- [Make OpenWhispr yours](https://docs.openwhispr.com/guides/custom-dictionary.md): Teach OpenWhispr your vocabulary, set up snippets, pick your microphone, and find any setting.
- [How dictation works](https://docs.openwhispr.com/guides/dictation.md): Speak into any app and have your words typed at the cursor — and the settings that control it.
- [Enterprise providers](https://docs.openwhispr.com/guides/enterprise.md): Use your organization's AWS Bedrock account for AI text cleanup and Agent Mode — no personal API keys.
- [Local models](https://docs.openwhispr.com/guides/local-models.md): Set up Whisper, NVIDIA Parakeet, and Nemotron for private, offline transcription.
- [How meetings work](https://docs.openwhispr.com/guides/meeting-transcription.md): Record a call, get a transcript with speaker labels, and find it again afterwards.
- [How notes work](https://docs.openwhispr.com/guides/notes.md): Where your dictations, meetings and uploads are kept — organising, searching, syncing, exporting and sharing them.
- [Team Spaces & Sharing](https://docs.openwhispr.com/guides/team-spaces.md): Collaborate in shared spaces with roles and invitations, and publish notes to the web.
- [Cancelling your subscription](https://docs.openwhispr.com/help/account/cancel-your-subscription.md): How to cancel, what happens to your notes and transcriptions, and what keeps working afterwards.
- [Changing your email address](https://docs.openwhispr.com/help/account/change-your-email.md): How to move your account — and your subscription — to a different email address.
- [Changing your plan](https://docs.openwhispr.com/help/account/change-your-plan.md): Upgrading, downgrading, and switching between monthly and annual billing — including what you're charged today.
- [Deleting your account](https://docs.openwhispr.com/help/account/delete-your-account.md): How to permanently delete your account and all your data, and what happens to your subscription.
- [Discounts and promo codes](https://docs.openwhispr.com/help/account/discounts-and-promo-codes.md): Where to enter a promo code, and what discounts exist.
- [Invoices and receipts](https://docs.openwhispr.com/help/account/invoices-and-receipts.md): Where to download your invoices, and how to get a company name or VAT number onto them.
- [Is OpenWhispr free?](https://docs.openwhispr.com/help/account/is-openwhispr-free.md): What the Free plan actually gives you, what it doesn't, and whether you need to pay.
- [Managing your subscription](https://docs.openwhispr.com/help/account/manage-your-subscription.md): Where your plan, billing date and payment details live, and what you can change yourself.
- [A payment failed](https://docs.openwhispr.com/help/account/payment-failed.md): What happens when a card is declined, what you keep in the meantime, and how to fix it.
- [Referrals — give a month, get a month](https://docs.openwhispr.com/help/account/referrals.md): How the referral programme works, when the free month actually lands, and how to track invites.
- [Refunds](https://docs.openwhispr.com/help/account/refunds.md): How to ask for a refund, what we can usually do, and how long it takes to arrive.
- [Seats — adding, removing and what counts](https://docs.openwhispr.com/help/account/seats.md): What uses up a seat, how to buy more, and how seats come back when people leave.
- [Transferring or deleting a workspace](https://docs.openwhispr.com/help/account/transfer-or-delete-a-workspace.md): Handing a workspace to someone else, closing one down, and what happens to the subscription.
- [Why can't I manage billing?](https://docs.openwhispr.com/help/account/who-pays-for-my-plan.md): What it means when your plan is managed by someone else, and what you can still change yourself.
- [Billing for a team](https://docs.openwhispr.com/help/account/workspace-billing.md): How a workspace pays for OpenWhispr, who can change it, and how it relates to your personal plan.
- [Your agent's name](https://docs.openwhispr.com/help/agent/agent-name.md): Saying your agent's name during dictation hands the rest over to the agent. How that's detected, and how to rename or switch it off.
- [The chat agent](https://docs.openwhispr.com/help/agent/chat-agent.md): A chat window you can talk to, which can search your notes, create and edit them, search the web, and check your calendar.
- [The voice agent](https://docs.openwhispr.com/help/agent/voice-agent.md): Press a key, say what you want done, and the result is typed at your cursor instead of your words.
- [The four things your voice can start](https://docs.openwhispr.com/help/agent/voice-modes.md): Dictation, the voice agent, translation and meeting mode all listen to you but do different things. This is how to tell them apart.
- [Choose your microphone](https://docs.openwhispr.com/help/customise/choose-your-microphone.md): Pick which input device OpenWhispr listens to, and why the built-in one is often the better choice.
- [Teach OpenWhispr your words](https://docs.openwhispr.com/help/customise/custom-dictionary.md): Add names, jargon and acronyms to the custom dictionary so they come out right every time.
- [Where every setting lives](https://docs.openwhispr.com/help/customise/settings-reference.md): A map of OpenWhispr's settings — the nine sections, what each one holds, and the tabs that hide things.
- [Snippets: say a short phrase, get the full text](https://docs.openwhispr.com/help/customise/snippets.md): Set up a trigger phrase that expands into a link, an intro, a sign-off or a prompt whenever you say it.
- [Where your text goes](https://docs.openwhispr.com/help/dictation/auto-paste-and-clipboard.md): OpenWhispr pastes at your cursor when dictation finishes. What that needs, how to turn it off, and what happens on Wayland.
- [Choosing a shortcut that works](https://docs.openwhispr.com/help/dictation/choosing-a-shortcut.md): The rules a hotkey has to follow, which combinations your system won't give up, and what to use instead.
- [Dictation cleanup](https://docs.openwhispr.com/help/dictation/cleanup.md): OpenWhispr tidies your dictation before pasting it — removing filler words, fixing grammar and punctuation. Here's what it changes and how to switch it off.
- [Hold or tap](https://docs.openwhispr.com/help/dictation/hold-or-tap.md): Press once to start and again to stop, or hold the key while you speak. Which you can use depends on your platform.
- [Your hotkeys](https://docs.openwhispr.com/help/dictation/hotkeys.md): OpenWhispr has five separate shortcuts, not one. Here's what each does, what it defaults to, and how to change or unbind it.
- [Getting better accuracy](https://docs.openwhispr.com/help/dictation/improve-accuracy.md): Practical things that improve transcription quality — the engine you use, your microphone, your language setting, and teaching it your vocabulary.
- [Dictating in other languages](https://docs.openwhispr.com/help/dictation/languages.md): Set the language you speak, use auto-detect, and see which languages each transcription engine supports.
- [Translation](https://docs.openwhispr.com/help/dictation/translation.md): Dictate in one language and have the text pasted in another, using a dedicated hotkey.
- [Antivirus or firewall blocks OpenWhispr](https://docs.openwhispr.com/help/fix/antivirus-blocks-openwhispr.md): Windows Defender or a security suite flagging the installer, quarantining bundled binaries, or prompting about the local server.
- [OpenWhispr won't open](https://docs.openwhispr.com/help/fix/app-wont-open.md): Installed but no window appears, the app seems to be running invisibly, or the dictation panel is off-screen.
- [Can't reach OpenWhispr Cloud](https://docs.openwhispr.com/help/fix/cant-reach-openwhispr-cloud.md): Connection errors during setup or dictation — networks, corporate proxies and certificate warnings.
- [It says I hit a daily limit](https://docs.openwhispr.com/help/fix/daily-limit-message.md): The free allowance is weekly, not daily — what the limit actually is, and when it frees up.
- [My hotkey doesn't work](https://docs.openwhispr.com/help/fix/hotkey-not-working.md): Nothing happens when you press the shortcut — conflicts, blocked keys, and the per-desktop rules on Linux.
- [It answers me instead of typing what I said](https://docs.openwhispr.com/help/fix/it-answers-instead-of-typing.md): You dictated a sentence and got a reply, a rewrite, or an answer to your question — here's which feature did it.
- [Clipboard and system audio on Linux](https://docs.openwhispr.com/help/fix/linux-clipboard-and-audio.md): Wayland clipboard behaviour, paste tools, and PipeWire capture — the two Linux-specific things that need setup.
- [Local transcription isn't working](https://docs.openwhispr.com/help/fix/local-transcription-not-working.md): Whisper or Parakeet failing on your own machine — models, GPU acceleration, and the per-mode setting people miss.
- [Meeting audio isn't captured](https://docs.openwhispr.com/help/fix/meeting-audio-not-captured.md): Only your voice is recorded, or nothing is — permissions, the Windows audio helper, and what to check per platform.
- [My microphone isn't working](https://docs.openwhispr.com/help/fix/microphone-not-working.md): Permission prompts that never appear, "No microphones detected", and the wrong input device — fixed per operating system.
- [A model won't download](https://docs.openwhispr.com/help/fix/model-download-fails.md): Downloads that fail, stall, or install incorrectly — and what each error message actually means.
- [Nothing was transcribed](https://docs.openwhispr.com/help/fix/nothing-was-transcribed.md): What "No Audio Detected" means, why an empty result happens, and how to get the take back.
- [I paid but still see the Free plan](https://docs.openwhispr.com/help/fix/paid-but-shows-free.md): Your payment went through and the app hasn't caught up — what to check, and when to just email us.
- [I lost a dictation](https://docs.openwhispr.com/help/fix/recover-a-lost-dictation.md): Re-transcribe audio you already recorded, and recover a dictation you cancelled by mistake.
- [The text doesn't paste](https://docs.openwhispr.com/help/fix/text-not-pasting.md): Transcription works but nothing appears in the app you're typing into — permissions, paste tools, and the clipboard fallback.
- [My text is pasted twice](https://docs.openwhispr.com/help/fix/text-pasted-twice.md): Dictated text arriving duplicated on Windows — what to do now, and where the fix stands.
- [Updates and reinstalling](https://docs.openwhispr.com/help/fix/updates-and-reinstalling.md): Updates that fail, permissions that stop working afterwards, and how to reinstall without losing anything you need.
- [The words come out wrong](https://docs.openwhispr.com/help/fix/wrong-words-or-language.md): Names and jargon mis-heard, the wrong language, or accuracy that dropped — what to change, in order.
- [Getting help](https://docs.openwhispr.com/help/getting-help.md): How to reach us, what to include so we can fix it fast, and where to report a bug.
- [Network allowlist](https://docs.openwhispr.com/help/it/network-allowlist.md): Every host the OpenWhispr desktop app contacts, for firewall, proxy and DNS-filter configuration.
- [Capturing both sides of the call](https://docs.openwhispr.com/help/meetings/capture-both-sides.md): Why recording the other participants is separate from recording your microphone, and what OpenWhispr does and doesn't capture.
- [Connect Google Calendar](https://docs.openwhispr.com/help/meetings/connect-google-calendar.md): Link your calendar so meeting notes arrive titled, with attendees filled in and a one-click join.
- [How meeting detection works](https://docs.openwhispr.com/help/meetings/how-meeting-detection-works.md): What makes the take-notes prompt appear, why it sometimes doesn't, and how to turn it off.
- [Meeting hours on your plan](https://docs.openwhispr.com/help/meetings/meeting-hours-on-your-plan.md): How many hours of meeting recording each plan includes, and what else applies while you record.
- [Record a meeting](https://docs.openwhispr.com/help/meetings/record-a-meeting.md): Start a meeting note by hand or from a prompt, watch it transcribe live, and find it afterwards.
- [Speaker labels](https://docs.openwhispr.com/help/meetings/speaker-labels.md): How OpenWhispr works out who said what, how to correct it, and how to turn it off for a recording.
- [Export your notes](https://docs.openwhispr.com/help/notes/export-your-notes.md): Save a single note as Markdown, or keep every note mirrored to a folder on disk automatically.
- [Organise notes with folders](https://docs.openwhispr.com/help/notes/organise-with-folders.md): Create folders, move notes between them, and understand the folders OpenWhispr makes for you.
- [Search your notes](https://docs.openwhispr.com/help/notes/search-your-notes.md): Find a note by the words in it or by what it was about, including transcripts of past meetings.
- [Share a note](https://docs.openwhispr.com/help/notes/share-a-note.md): Send someone a link or invite them by email, choose who can see it, and take access away again.
- [Sync notes across devices](https://docs.openwhispr.com/help/notes/sync-across-devices.md): Turn on cloud backup, what syncs and what doesn't, and why shared notes behave differently.
- [Plans and limits](https://docs.openwhispr.com/help/plans-and-limits.md): What each plan includes, the exact limits that apply, and what happens when you reach one.
- [Answering a security review](https://docs.openwhispr.com/help/privacy/for-your-it-team.md): Everything an IT or security team usually asks about OpenWhispr, in one place — with the documents to attach.
- [GDPR and your data rights](https://docs.openwhispr.com/help/privacy/gdpr-and-your-data-rights.md): What rights you have over your data, how to exercise each one, and what business customers need for their own compliance.
- [HIPAA and healthcare use](https://docs.openwhispr.com/help/privacy/hipaa-and-healthcare.md): Where OpenWhispr stands on HIPAA, when you need a BAA, and which processing modes keep PHI out of our cloud entirely.
- [How OpenWhispr is secured](https://docs.openwhispr.com/help/privacy/how-openwhispr-is-secured.md): Encryption, credential storage, access control, and where our compliance attestations actually stand.
- [Is my data used to train AI models?](https://docs.openwhispr.com/help/privacy/is-my-data-used-to-train-ai.md): No. What that covers, what our providers are contractually held to, and what it means for bring-your-own-key setups.
- [What OpenWhispr stores, and for how long](https://docs.openwhispr.com/help/privacy/what-we-store-and-for-how-long.md): The retention settings, what they default to, where your data sits on disk, and how to delete it.
- [Where your voice and text go](https://docs.openwhispr.com/help/privacy/where-your-data-goes.md): What leaves your device when you dictate, what reaches OpenWhispr's servers, and what never goes anywhere — per processing mode.
- [Introduction](https://docs.openwhispr.com/index.md): OpenWhispr is an open-source voice-to-text dictation app with AI agents, meeting transcription, and notes. Available on macOS, Windows, and Linux.
- [Agent setup](https://docs.openwhispr.com/integrations/agent-setup.md): Let your AI assistant create its own API key in under 30 seconds.
- [API keys](https://docs.openwhispr.com/integrations/api-keys.md): Create and manage API keys for the OpenWhispr API and MCP server.
- [MCP server](https://docs.openwhispr.com/integrations/mcp.md): Connect your AI assistant to OpenWhispr using the Model Context Protocol.
- [Dictating into other apps](https://docs.openwhispr.com/platform/dictating-into-other-apps.md): How your words get from OpenWhispr into whatever you're typing in — and what to do when they don't.
- [Editors, IDEs and terminals](https://docs.openwhispr.com/platform/editors-and-terminals.md): Why terminals need a different paste shortcut, which ones OpenWhispr recognises, and what to do when yours isn't recognised.
- [Linux](https://docs.openwhispr.com/platform/linux.md): Which package to install, what changes between X11 and Wayland, and the desktop-specific behaviour for hotkeys, pasting and system audio.
- [macOS](https://docs.openwhispr.com/platform/macos.md): Installing on a Mac, the three permissions macOS asks for, the Globe key, and how updates work.
- [Mobile and tablets](https://docs.openwhispr.com/platform/mobile.md): Whether there's an iPhone, iPad or Android app — the honest current answer, and how to get on the beta.
- [Running in the background](https://docs.openwhispr.com/platform/running-in-the-background.md): The tray icon, the floating panel, starting with your computer, and the small settings that decide how much OpenWhispr is in the way.
- [System requirements](https://docs.openwhispr.com/platform/system-requirements.md): What OpenWhispr needs on macOS, Windows and Linux — and what the on-device models need on top of that.
- [Where your files live](https://docs.openwhispr.com/platform/where-your-files-live.md): Every folder OpenWhispr writes to on each platform — settings, history, logs, downloaded models and note files.
- [Windows](https://docs.openwhispr.com/platform/windows.md): Installing on Windows, why no permission prompts appear, hold-to-talk, and how meeting audio is captured.
- [Work and managed computers](https://docs.openwhispr.com/platform/work-computers.md): Installing where IT has locked things down, what to send your security team, and the settings that make OpenWhispr fit a restrictive policy.
- [Quickstart](https://docs.openwhispr.com/quickstart.md): Get OpenWhispr running in under five minutes.
- [Common problems](https://docs.openwhispr.com/troubleshooting.md): Find the fix for what's actually happening — start from the symptom.

## OpenAPI Specs

- [openapi](https://docs.openwhispr.com/openapi.json)