@telnyx/ai-agent-widget 0.33.9-beta.1 → 0.34.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/README.md CHANGED
@@ -104,6 +104,21 @@ Pin signalling to a specific region with the `region` attribute. When set, the W
104
104
 
105
105
  Known regions: `us-east`, `us-central`, `us-west`, `ca-central`, `eu`, `apac`, `south-asia`.
106
106
 
107
+ ### Environment
108
+
109
+ Select which Telnyx environment the widget connects to with the `environment` attribute. It is forwarded to the underlying `@telnyx/webrtc` SDK, which picks the WebRTC signalling host accordingly. Defaults to `production`.
110
+
111
+ | Value | WebRTC signalling host | When to use |
112
+ | ---------------------- | ------------------------ | --------------------------------------------------------------------------------------------- |
113
+ | `production` (default) | `wss://rtc.telnyx.com` | Normal usage against Telnyx production. |
114
+ | `development` | `wss://rtcdev.telnyx.com` | Testing an agent/backend deployed to the Telnyx dev environment (e.g. pre-release AI features). |
115
+
116
+ ```html
117
+ <telnyx-ai-agent agent-id="assistant-xxx" environment="development"></telnyx-ai-agent>
118
+ ```
119
+
120
+ > `development` routes signalling to `rtcdev.telnyx.com`. Only use it when your assistant **and** the backend changes you are testing are deployed to Telnyx dev — production assistants are not reachable there. `environment` and [`region`](#region) are independent: `region` only rewrites the production host and does not apply to `development`.
121
+
107
122
  ### VAD (Voice Activity Detection) Options
108
123
 
109
124
  Configure Voice Activity Detection for speech detection and latency measurement by passing a JSON object to the `vad` attribute: