> For the complete documentation index, see [llms.txt](https://docs.mikopbx.com/mikopbx/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.mikopbx.com/mikopbx/english/modules/miko/module-local-speech-to-text/quick-start.md). # Quick Start Quick start for the Local Speech To Text module and Local STT Worker ### Installing the module 1. Open the MikoPBX web interface. 2. Go to **Modules** → **Module marketplace**.

3. Find **Local Speech To Text** and install it. 4. Open the **Installed modules** tab and enable the module.

5. Click the settings button to the right of the module version.

### Initial module setup 1. On the **Settings** tab, select the main language used in calls or leave **Auto - detect automatically** selected. 2. Select the **Recording processing window** and **Transcript retention**. The processing window cannot exceed the retention period. 3. If necessary, add internal names and abbreviations under **Recognition terms**. 4. Save the settings.

### Selecting a model 1. Open the **Model marketplace** tab. 2. Select the model for call transcription. The default **Parakeet TDT 0.6B v3** is recommended for most calls; use a WhisperKit model for languages outside Parakeet's 25 supported languages. 3. Click **Save model**. {% hint style="info" %} The selected model is downloaded to the Mac when the worker receives its first job. Keep the Mac connected to the internet until the model and its supporting files finish downloading. {% endhint %}

### Downloading the worker and creating an API key 1. Open the **Workers** tab. Use HTTPS for the web interface: over HTTP, the created key is not displayed. 2. Click **Download for macOS** to download Local STT Worker. 3. Click **Create API key**. 4. Copy the displayed token immediately. It cannot be viewed again after the page is refreshed. {% hint style="info" %} Create a separate key for each Mac. One key cannot be bound to multiple worker UIDs. {% endhint %}

### Connecting Local STT Worker Install and open **Local STT Worker**. A three-step onboarding wizard appears on first launch. #### Step 1. Language Select English or Russian as the interface language, then click **Next**. Changing the language may require a restart; after restarting, the onboarding wizard opens again.

#### Step 2. Connect to MikoPBX Complete these fields: | Field | What to enter | | -------------------- | ----------------------------------------------------------------------------- | | **MikoPBX address** | An address such as `https://pbx.example.com`, without credentials in the URL. | | **Worker name** | A recognizable Mac name that will be displayed in MikoPBX. | | **STT worker token** | The key created on the **Workers** tab. |

Expand **Advanced settings** to configure: * TLS certificate verification; * a custom CA PEM file; * a custom worker UID.

Click **Connect and continue**. The application checks the connection and validates the supplied settings. #### Step 3. Ready to use The final step displays the worker status. You can also enable two options here: * **Launch at login** — open Local STT Worker automatically when you sign in to macOS. * **Keep worker running** — resume the worker automatically after the network connection is restored, the Mac wakes from sleep, or a temporary error occurs.

In the application, open **Overview**. If the worker is stopped, click **Start Worker**. The readiness panel should display the model selected in MikoPBX. ### Verifying operation 1. Make a call for which call recording is enabled. 2. Wait for a job to appear on the module's **Queue** tab. 3. On first use, wait for the model to download to the Mac. 4. Check local processing stages under **Overview**, or review events under **Diagnostics**. 5. Open the completed result on the **Transcripts** tab in MikoPBX, or click **Show transcript** in the call history.

Call processing on the worker Overview page

See [Local STT Worker](/mikopbx/english/modules/miko/module-local-speech-to-text/miko-ai-worker.md) for a detailed description of the application sections. --- # Agent Instructions This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com. ## Querying This Documentation If you need additional information that is not directly available in this page, you can query the documentation by asking a question. Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters: ``` GET https://docs.mikopbx.com/mikopbx/english/modules/miko/module-local-speech-to-text/quick-start.md?ask=&goal= ``` `ask` is the immediate question: it should be specific, self-contained, and written in natural language. `goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case. The response will contain a direct answer to the question and relevant excerpts and sources from the documentation. Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.