From c48c0e0d046a9f04f499fb203e0b97de285455b0 Mon Sep 17 00:00:00 2001
From: "github-actions[bot]" <github-actions[bot]@users.noreply.github.com>
Date: Wed, 3 Jun 2026 15:49:30 +0000
Subject: [PATCH] docs: update Azure TTS for private_endpoint parameter

Updates Azure TTS documentation to reflect changes from pipecat PR #4549:
- Add private_endpoint parameter to both AzureTTSService and AzureHttpTTSService
- Update region parameter to show it's conditionally required
- Add usage example with private endpoint
- Update prerequisites to mention private endpoint option
---
 api-reference/server/services/tts/azure.mdx | 38 ++++++++++++++++++---
 1 file changed, 33 insertions(+), 5 deletions(-)

diff --git a/api-reference/server/services/tts/azure.mdx b/api-reference/server/services/tts/azure.mdx
index 6bb48731..2dbdd7d9 100644
--- a/api-reference/server/services/tts/azure.mdx
+++ b/api-reference/server/services/tts/azure.mdx
@@ -60,7 +60,7 @@ Before using Azure TTS services, you need:
 ### Required Environment Variables
 
 - `AZURE_SPEECH_API_KEY`: Your Azure Speech service API key
-- `AZURE_SPEECH_REGION`: Your Azure Speech service region (e.g., "eastus")
+- `AZURE_SPEECH_REGION`: Your Azure Speech service region (e.g., "eastus") _or_ a custom endpoint URL when using Private Link
 
 ## Configuration
 
@@ -70,8 +70,16 @@ Before using Azure TTS services, you need:
   Azure Cognitive Services subscription key.
 </ParamField>
 
-<ParamField path="region" type="str" required>
-  Azure region identifier (e.g., `"eastus"`, `"westus2"`).
+<ParamField path="region" type="str">
+  Azure region identifier (e.g., `"eastus"`, `"westus2"`). Required unless
+  `private_endpoint` is provided.
+</ParamField>
+
+<ParamField path="private_endpoint" type="str">
+  Custom endpoint URL for Azure Speech Services (e.g.,
+  `"https://my-resource.cognitiveservices.azure.com/"`). Use this when
+  connecting via Private Link or a custom domain. See [Azure Private Link
+  documentation](https://learn.microsoft.com/en-us/azure/ai-services/speech-service/speech-services-private-link).
 </ParamField>
 
 <ParamField path="voice" type="str" default="en-US-SaraNeural" deprecated>
@@ -116,8 +124,14 @@ The HTTP service accepts the same parameters as the streaming service except `te
   Azure Cognitive Services subscription key.
 </ParamField>
 
-<ParamField path="region" type="str" required>
-  Azure region identifier.
+<ParamField path="region" type="str">
+  Azure region identifier. Required unless `private_endpoint` is provided.
+</ParamField>
+
+<ParamField path="private_endpoint" type="str">
+  Custom endpoint URL for Azure Speech Services. Use this when connecting via
+  Private Link or a custom domain. See [Azure Private Link
+  documentation](https://learn.microsoft.com/en-us/azure/ai-services/speech-service/speech-services-private-link).
 </ParamField>
 
 <ParamField path="voice" type="str" default="en-US-SaraNeural" deprecated>
@@ -201,6 +215,20 @@ tts = AzureHttpTTSService(
 )
 ```
 
+### With Private Endpoint
+
+```python
+from pipecat.services.azure import AzureTTSService
+
+tts = AzureTTSService(
+    api_key=os.getenv("AZURE_SPEECH_API_KEY"),
+    private_endpoint="https://my-resource.cognitiveservices.azure.com/",
+    settings=AzureTTSService.Settings(
+        voice="en-US-SaraNeural",
+    ),
+)
+```
+
 <Tip>
   The `InputParams` / `params=` pattern is deprecated as of v0.0.105. Use
   `Settings` / `settings=` instead. See the [Service Settings