# Alter Documentation

## Docs

- [Create a chat completion](https://docs.alterhq.com/api-reference/create-a-chat-completion.md)
- [Create a completion](https://docs.alterhq.com/api-reference/create-a-completion.md)
- [List available models](https://docs.alterhq.com/api-reference/list-available-models.md)
- [API Gateway & Router Service](https://docs.alterhq.com/api-router/api-gateway.md): Use Alter as an OpenAI-compatible API endpoint for model routing
- [App Integrations with API Router](https://docs.alterhq.com/api-router/app-integrations.md): Connect third-party apps to Alter API Router
- [API Router for Development](https://docs.alterhq.com/api-router/development.md): Use Alter API Router from SDKs and custom code
- [Set Up Msty.ai with Alter API](https://docs.alterhq.com/api-router/msty.md): Connect Msty.ai to Alter API Router with endpoint and API key configuration
- [API Router Operations & Troubleshooting](https://docs.alterhq.com/api-router/operations.md): Model selection, limits, reliability, and common fixes for Alter API Router
- [Set Up TypingMind with Alter API](https://docs.alterhq.com/api-router/typingmind.md): Connect TypingMind to Alter API Router using OpenAI Chat Completions format
- [Calendar](https://docs.alterhq.com/apps-tools/calendar.md): What Alter can do with Apple Calendar local tools
- [Overview](https://docs.alterhq.com/apps-tools/computer-use.md): Screen-based automation and extraction with Computer Use tools
- [Get Active App Context](https://docs.alterhq.com/apps-tools/computer-use-get-active-app-context.md): Capture active window content and OCR text for Computer Use workflows
- [Perform](https://docs.alterhq.com/apps-tools/computer-use-perform.md): Run click, fill, and shortcut actions against UI elements
- [Scroll](https://docs.alterhq.com/apps-tools/computer-use-scroll.md): Scroll active app windows in Computer Use flows
- [Wait](https://docs.alterhq.com/apps-tools/computer-use-wait.md): Pause execution between Computer Use actions
- [Contacts](https://docs.alterhq.com/apps-tools/contacts.md): What Alter can do with Apple Contacts local tools
- [DEVONthink](https://docs.alterhq.com/apps-tools/devonthink.md): Set up Alter as your AI provider in DEVONthink
- [Overview](https://docs.alterhq.com/apps-tools/integrations-overview.md): Understand local tools and external integrations in Alter
- [Troubleshooting](https://docs.alterhq.com/apps-tools/integrations-troubleshooting.md): Fix common integration and tool issues in Alter
- [Mail](https://docs.alterhq.com/apps-tools/mail.md): What Alter can do with Apple Mail local tools
- [Maps](https://docs.alterhq.com/apps-tools/maps.md): What Alter can do with Apple Maps local tools
- [Messages](https://docs.alterhq.com/apps-tools/messages.md): What Alter can do with Apple Messages local tools
- [Notes](https://docs.alterhq.com/apps-tools/notes.md): What Alter can do with Apple Notes local tools
- [Reminders](https://docs.alterhq.com/apps-tools/reminders.md): What Alter can do with Apple Reminders local tools
- [Custom Models Not Showing](https://docs.alterhq.com/common-issues/custom-provider-not-showing.md): Fix missing OpenAI, Mistral, or local models in the model selector
- [Data missing after reinstall or cleanup](https://docs.alterhq.com/common-issues/data-missing-after-reinstall.md): Understand why chats and transcripts can disappear after uninstalling Alter and what recovery options you may still have.
- [Keyboard Shortcut Not Working](https://docs.alterhq.com/common-issues/hotkey-not-working.md): Fix hotkey issues when Alt+Space or your custom shortcut won't open Alter
- [Microphone Not Working](https://docs.alterhq.com/common-issues/mic-not-transcribing.md): Fix voice input and dictation issues when Alter doesn't transcribe your speech
- [API Gateway Won't List Models](https://docs.alterhq.com/common-issues/models-not-listed-in-api-gateway.md): Fix empty model lists when connecting external apps to Alter's API
- [Tools Not Working](https://docs.alterhq.com/common-issues/tool-not-working.md): Fix integrations when Alter won't use your connected tools and apps
- [Create reusable actions](https://docs.alterhq.com/getting-started/actions-basics.md): Turn repeated prompts into reliable workflows with model and tool control
- [Add files, folders, and media](https://docs.alterhq.com/getting-started/add-files-and-media.md): Use drag and drop context for documents, images, audio, and code
- [Automate with workspaces and actions](https://docs.alterhq.com/getting-started/automate-with-workspaces-and-actions.md): Get repeatable results by combining persistent context and reusable actions
- [Capture voice and meetings](https://docs.alterhq.com/getting-started/capture-voice-and-meetings.md): Use dictation, transcription, and meeting workflows from day one
- [Core features](https://docs.alterhq.com/getting-started/core-features.md): Overview of app context, files, workspaces, and actions with links to focused getting-started pages
- [Run Your First Workflows](https://docs.alterhq.com/getting-started/first-workflows.md): Use practical workflows for writing, meetings, and everyday tasks
- [Getting Started](https://docs.alterhq.com/getting-started/getting-started-path.md): Learn the different ways to open and interact with Alter on your Mac
- [Open Alter](https://docs.alterhq.com/getting-started/open-alter.md): Learn the fastest ways to open Alter and send your first prompt
- [Understand context and app awareness](https://docs.alterhq.com/getting-started/understand-context-and-apps.md): Learn how Alter uses app context, follow mode, and files to give better answers
- [Use current app and Follow Mode](https://docs.alterhq.com/getting-started/use-current-app-and-follow-mode.md): Keep app context synced so Alter can help without repeated explanations
- [Window Types: Notch, Hub, and Panels](https://docs.alterhq.com/getting-started/window-types-notch-hub-panels.md): Understand Alter's interface modes, including Notch interactions, The Hub, and the Quick Panel
- [Use workspaces for bigger tasks](https://docs.alterhq.com/getting-started/workspaces-basics.md): Index folders and files once so Alter can work across larger contexts
- [Understand the Interface](https://docs.alterhq.com/getting-started/your-workspace.md): Get comfortable with the Alter window, context area, and chat flow
- [How-To: Change Quick Access Hotkey](https://docs.alterhq.com/how-to/change-hotkey.md): Customize your keyboard shortcut for opening Alter
- [Choose your generative model](https://docs.alterhq.com/how-to/choose-generative-model.md): Pick the right model for speed, quality, vision, and privacy in Alter
- [Choosing your language](https://docs.alterhq.com/how-to/choose-language.md): Set your preferred language for AI generation output
- [Manage context window](https://docs.alterhq.com/how-to/managing-context-window.md): Optimize your AI interactions by understanding and managing context window usage
- [Reinstall or downgrade Alter safely](https://docs.alterhq.com/how-to/reinstall-or-downgrade-alter.md): Replace Alter with another version without removing your local chats, transcripts, and other app data.
- [Configuring Alter Settings](https://docs.alterhq.com/how-to/settings-guide.md): Learn how to customize Alter to match your preferences and manage your account
- [Manage tools](https://docs.alterhq.com/how-to/tool-manager-guide.md): Connect and manage integrations safely with clear troubleshooting steps
- [How-To: Use Your Own API Key](https://docs.alterhq.com/how-to/use-byok.md): Connect your own API keys from OpenAI, Mistral, and other providers
- [Welcome](https://docs.alterhq.com/index.md): Documentation for Alter, the macOS AI assistant that lives in your notch
- [Quickstart](https://docs.alterhq.com/quickstart.md): Get started with Alter in three simple steps
- [API Model Reference](https://docs.alterhq.com/references/api-model-names.md): Complete list of AI models available through the Alter API Router
- [API Router Overview](https://docs.alterhq.com/references/api-router-overview.md): Overview of the Alter API Router service and OpenAI-compatible endpoint
- [Documentation Map](https://docs.alterhq.com/references/docs-map.md): Quick reference to all sections of the Alter documentation
- [Core FAQ](https://docs.alterhq.com/references/faq-core.md): Quick answers to common questions about using Alter
- [General FAQ](https://docs.alterhq.com/references/general-faq.md): Use this for high-level 'about Alter' questions from the main website FAQ
- [Image Library](https://docs.alterhq.com/references/image-library.md): Canonical image URLs and references for Alter documentation
- [Local data and privacy](https://docs.alterhq.com/references/local-data-and-privacy.md): Understand what Alter stores locally, what is not synced to the cloud, and how to protect your data before reinstalling.
- [Pricing FAQ](https://docs.alterhq.com/references/pricing-faq.md): Information about Alter plans, billing, fair use, and device limits
- [Shortcuts](https://docs.alterhq.com/references/shortcuts.md): Complete list of keyboard shortcuts for Alter
- [Alter Actions](https://docs.alterhq.com/workflows/alter-actions.md): Create and configure custom AI workflows with voice triggers and automation
- [Automate Blogging with Alter](https://docs.alterhq.com/workflows/automate-blogging-with-alter.md): Teach Alter your writing style so it can help you automate content creation
- [Connect Exa](https://docs.alterhq.com/workflows/connect-exa.md): Use Exa in Alter for web search workflows
- [Connect Firecrawl](https://docs.alterhq.com/workflows/connect-firecrawl.md): Use Firecrawl with Alter for structured multi-page scraping
- [Connect LinkUp](https://docs.alterhq.com/workflows/connect-linkup.md): Set up LinkUp in Alter through Apps Gallery or Remote MCP
- [Connect Tavily](https://docs.alterhq.com/workflows/connect-tavily.md): Connect Tavily as a Remote MCP Server for web research and extraction
- [Dictation](https://docs.alterhq.com/workflows/dictation.md): Voice commands, speech-to-text, and advanced dictation features
- [Keep Your Data Private with Local AI](https://docs.alterhq.com/workflows/local-model-privacy.md): How to run AI models on your own Mac for sensitive documents and confidential work
- [Manage your schedule with Alter](https://docs.alterhq.com/workflows/manage-calendar-with-alter.md): What Alter can do with Apple Calendar, when to use it, and prompts you can copy
- [Manage contacts with Alter](https://docs.alterhq.com/workflows/manage-contacts-with-alter.md): What Alter can currently do with Apple Contacts, with practical prompts and setup
- [Check unread emails and draft replies with Alter](https://docs.alterhq.com/workflows/manage-mail-with-alter.md): What Alter can currently do with Apple Mail, with practical prompts and setup
- [Capture and organize notes with Alter](https://docs.alterhq.com/workflows/manage-notes-with-alter.md): What Alter can do with Apple Notes, when to use it, and prompts you can copy
- [Stay on top of tasks with Alter](https://docs.alterhq.com/workflows/manage-reminders-with-alter.md): What Alter can do with Apple Reminders, when to use it, and prompts you can copy
- [Never Miss Action Items from Meetings](https://docs.alterhq.com/workflows/meeting-workflow.md): How to automatically record, transcribe, and extract tasks from your meetings
- [Meetings](https://docs.alterhq.com/workflows/meetings.md): Professional meeting transcription with speaker identification and offline processing
- [Router-native search](https://docs.alterhq.com/workflows/native-web-search-in-alter-routers.md): Use Fast, Best, Fair, and Light for recent web-backed answers without extra connectors
- [Plan places and routes with Alter Maps](https://docs.alterhq.com/workflows/plan-places-and-routes-with-alter-maps.md): What Alter can currently do with Apple Maps, with practical prompts and setup
- [Send iMessages faster with Alter](https://docs.alterhq.com/workflows/send-messages-with-alter.md): What Alter can currently do with Messages, with practical prompts and setup
- [Summarize your X feed with Computer Use](https://docs.alterhq.com/workflows/summarize-x-feed-with-computer-use.md): Use Alter Computer Use to read what is visible in your X timeline and generate structured summaries
- [URL Callbacks](https://docs.alterhq.com/workflows/url-callbacks.md): Integrate Alter with other apps using x-callback-url schemes
- [Use Flow for Tool Orchestration](https://docs.alterhq.com/workflows/use-flow-orchestration.md): Let Flow automatically select and orchestrate your tools to reduce context usage and improve performance
- [Getting started](https://docs.alterhq.com/workflows/web-research-getting-started.md): Get started with web research connectors in Alter
- [Included search tools](https://docs.alterhq.com/workflows/web-search-local-tools.md): Use Alter's built-in web search tools with no extra provider account
- [Workspaces and Actions Guide](https://docs.alterhq.com/workflows/workspaces-actions.md): Build repeatable flows by combining workspaces and Alter Actions

## OpenAPI Specs

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

## Optional

- [Website](https://alterhq.com)
- [Discord](https://discord.gg/gvCMmfBRWZ)
- [YouTube](https://youtube.com/@useAlter)