# 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. - [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. - [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): Talk to an AI assistant with voice commands and streaming responses. - [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. - [Custom dictionary](https://docs.openwhispr.com/guides/custom-dictionary.md): Improve transcription accuracy for names, jargon, and technical terms. - [Dictation](https://docs.openwhispr.com/guides/dictation.md): Use voice-to-text dictation with a global hotkey in any app. - [Enterprise providers](https://docs.openwhispr.com/guides/enterprise.md): Use your organization's AWS, Azure, or GCP account for AI text cleanup — no personal API keys. - [Local models](https://docs.openwhispr.com/guides/local-models.md): Set up Whisper and NVIDIA Parakeet for private, offline transcription. - [Meeting transcription](https://docs.openwhispr.com/guides/meeting-transcription.md): Auto-detect and transcribe meetings with speaker labels and calendar integration. - [Notes](https://docs.openwhispr.com/guides/notes.md): Create, organize, and search notes with folders, cloud sync, and AI actions. - [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. - [Linux](https://docs.openwhispr.com/platform/linux.md): Linux-specific setup including Wayland, paste tools, and package formats. - [macOS](https://docs.openwhispr.com/platform/macos.md): macOS-specific setup, permissions, and features. - [Windows](https://docs.openwhispr.com/platform/windows.md): Windows-specific setup, push-to-talk, and paste configuration. - [Quickstart](https://docs.openwhispr.com/quickstart.md): Get OpenWhispr running in under five minutes. - [Troubleshooting](https://docs.openwhispr.com/troubleshooting.md): Solutions to common issues with OpenWhispr. ## OpenAPI Specs - [openapi](https://docs.openwhispr.com/openapi.json)