telnyx 7.25.0 → 7.27.0

package/resources/ai/assistants/assistants.d.mts

@@ -1,6 +1,7 @@
 import { APIResource } from "../../../core/resource.mjs";
 import * as AssistantsAPI from "./assistants.mjs";
 import * as Shared from "../../shared.mjs";
+import * as AvatarsAPI from "../avatars.mjs";
 import * as ChatAPI from "../chat.mjs";
 import * as ToolsAPI from "../tools.mjs";
 import * as CanaryDeploysAPI from "./canary-deploys.mjs";
@@ -110,7 +111,10 @@ export declare class Assistants extends APIResource {
     /**
      * Updates the specified AI assistant's attributes and returns the updated
      * assistant. The request can also control how the change is promoted across
-     * assistant versions.
+     * assistant versions. Every update saves a new version, and an assistant keeps at
+     * most 10 versions: once it has more, the oldest versions are permanently deleted,
+     * except the main version and any version referenced by a traffic distribution
+     * rule.
      *
      * @example
      * ```ts
@@ -435,7 +439,7 @@ export interface AssistantMcpServer {
  * another AI assistant. By default, this will happen transparently to the end
  * user.
  */
-export type AssistantTool = AssistantTool.Function | InferenceEmbeddingWebhookToolParams | AssistantTool.ClientSideTool | RetrievalTool | AssistantTool.Handoff | AssistantTool.Hangup | AssistantTool.Transfer | AssistantTool.Invite | AssistantTool.Refer | AssistantTool.SendDtmf | AssistantTool.SendMessage | AssistantTool.SkipTurn | AssistantTool.Pay | AssistantTool.UpdateDynamicVariables;
+export type AssistantTool = AssistantTool.Function | InferenceEmbeddingWebhookToolParams | AssistantTool.ClientSideTool | RetrievalTool | AssistantTool.Handoff | AssistantTool.Hangup | AssistantTool.Transfer | AssistantTool.Invite | AssistantTool.Refer | AssistantTool.SendDtmf | AssistantTool.SendMessage | AssistantTool.SkipTurn | AssistantTool.Vision | AssistantTool.Pay | AssistantTool.UpdateDynamicVariables;
 export declare namespace AssistantTool {
     interface Function {
         function: OpenAIChatAPI.FunctionDefinition;
@@ -590,6 +594,13 @@ export declare namespace AssistantTool {
              * variables webhook and resolves to an array of target objects at runtime.
              */
             targets: Array<Transfer.TargetsList> | string;
+            /**
+             * Plays a short beep once the transfer completes and the calls are bridged, so the
+             * transfer destination knows the caller is now on the line. The warm transfer
+             * message plays before the bridge; this marks the moment the caller actually
+             * joins. Works with and without `warm_transfer_acceptance`.
+             */
+            bridge_beep?: Transfer.BridgeBeep;
             /**
              * Custom headers to be added to the SIP INVITE for the transfer command.
              */
@@ -679,6 +690,23 @@ export declare namespace AssistantTool {
                  */
                 sip_auth_username?: string;
             }
+            /**
+             * Plays a short beep once the transfer completes and the calls are bridged, so the
+             * transfer destination knows the caller is now on the line. The warm transfer
+             * message plays before the bridge; this marks the moment the caller actually
+             * joins. Works with and without `warm_transfer_acceptance`.
+             */
+            interface BridgeBeep {
+                /**
+                 * Whether to play the beep when the calls are bridged.
+                 */
+                enabled?: boolean;
+                /**
+                 * Who hears the beep. `self` plays it to the transfer destination only; `both`
+                 * plays it to the destination and the original caller.
+                 */
+                target_legs?: 'self' | 'both';
+            }
             interface CustomHeader {
                 name?: string;
                 /**
@@ -822,6 +850,30 @@ export declare namespace AssistantTool {
                  * `shared` the exchange stays in the conversation like any other messages.
                  */
                 end_user_target_context_mode?: 'private' | 'shared';
+                /**
+                 * Fail closed when the acceptance consult cannot run. Off by default: if the
+                 * consult cannot be set up for any reason — including where acceptance is
+                 * unavailable at all (`gather_using_ai`, Conversation Relay or web calls, a
+                 * conference, or additional invited participants) — the transfer degrades to a
+                 * plain warm transfer (the warm transfer message is played to the destination as
+                 * audio and the calls are bridged anyway). Set to true to treat those paths as a
+                 * decline instead: the destination is disconnected without being asked, the
+                 * assistant returns to the caller, and no bridge happens without an acceptance.
+                 * Only consult-setup failures are affected; the destination must still explicitly
+                 * accept on every consult that does run.
+                 */
+                require_acceptance?: boolean;
+                /**
+                 * How long, in seconds, the destination has to accept the transfer, counted from
+                 * when the private consult starts (right after the destination answers, or after
+                 * `warm_message_delay_ms`). The caller keeps hearing ringback the whole time. If
+                 * no acceptance arrives in time, the destination is hung up and the assistant
+                 * returns to the caller (the transfer fails as a timeout). Raise it for
+                 * destinations that answer before a human is on the line, such as a call-center
+                 * queue/ACD or an IVR playing hold audio; keep it as short as practical, since the
+                 * caller waits on ringback until it expires.
+                 */
+                timeout_secs?: number;
             }
         }
     }
@@ -1056,6 +1108,27 @@ export declare namespace AssistantTool {
             description?: string;
         }
     }
+    /**
+     * (BETA) Lets the assistant look at recent image frames the client sent into the
+     * conversation (for example webcam or screen-share frames). Frames are sent with
+     * `conversation.item.create` and `item.buffer: true`; they never trigger a
+     * response on their own. The assistant decides when to look and which frames it
+     * needs. Requires a model that supports image input.
+     */
+    interface Vision {
+        type: 'vision';
+        /**
+         * Whether this tool comes from the shared Tools Library. Responses merge shared
+         * tools into `tools` with `shared: true`; inline tools carry `shared: false`.
+         * Read-only: set by the server, not accepted in requests. When updating an
+         * assistant, omit `shared: true` tools from the request `tools` array and manage
+         * them through `tool_ids` instead — re-sending their definitions creates an inline
+         * duplicate (rejected with error code 10015 when the type allows only one instance
+         * per assistant).
+         */
+        shared?: boolean;
+        vision?: ToolsAPI.VisionToolParams;
+    }
     /**
      * (BETA) The pay tool allows the assistant to collect card payments from the
      * caller via DTMF during the conversation. Recording is automatically paused while
@@ -1118,6 +1191,31 @@ export interface AudioVisualizerConfig {
  * Authentication method used when connecting to the external LLM endpoint.
  */
 export type AuthenticationMethod = 'token' | 'certificate';
+/**
+ * **Beta:** Configuration for the Telnyx open-source avatar provider. Use a stock
+ * avatar or an organization-owned custom avatar returned by the Avatars API.
+ * Discover the available stock catalog with GET /v2/ai/avatars and
+ * filter[avatar_type]=stock; follow meta.total_pages to load every page.
+ */
+export interface AvatarSettingsRequest {
+    /**
+     * The Telnyx stock avatar or organization-owned custom avatar to render.
+     */
+    avatar_id: AvatarsAPI.AvatarID;
+    /**
+     * The background to render.
+     */
+    background_id: 'office' | 'studio' | 'reception' | 'illustrated_workspace';
+    /**
+     * Required avatar model identifier, separate from `avatar_id`. The supported value
+     * is `foxtrot-1`. Omission, null, and unsupported model identifiers are rejected.
+     */
+    model: 'foxtrot-1';
+    /**
+     * Selects the Telnyx open-source avatar provider.
+     */
+    provider: 'telnyx';
+}
 /**
  * Combine sub-expressions with a logical operator (`and` / `or` / `not`).
  *
@@ -1694,7 +1792,11 @@ export interface FlowNodeReq {
     tools_mode?: 'replace' | 'append';
     /**
      * Per-node transcription override (model/language/region). Unset fields cascade
-     * from the assistant-level transcription.
+     * from the assistant-level transcription. A node that sets `model`,
+     * `fallback_models`, or `challenger` doesn't inherit the assistant's
+     * `fallback_models` or `challenger`; it uses only the ones it sets. Otherwise it
+     * inherits them, and they must fit the model and language the node runs; a change
+     * they no longer fit is rejected.
      */
     transcription?: TranscriptionSettings;
     /**
@@ -1757,6 +1859,13 @@ export interface InferenceEmbedding {
      * capability for the conversation; it does not fail the call.
      */
     a2a_agents?: Array<AssistantA2AAgent>;
+    /**
+     * **Beta:** Configuration for the Telnyx open-source avatar provider. Use a stock
+     * avatar or an organization-owned custom avatar returned by the Avatars API.
+     * Discover the available stock catalog with GET /v2/ai/avatars and
+     * filter[avatar_type]=stock; follow meta.total_pages to load every page.
+     */
+    avatar_settings?: TelnyxAvatarSettings | null;
     /**
      * Conversation flow as returned by the API.
      */
@@ -1958,7 +2067,7 @@ export interface InferenceEmbeddingVoiceSettings {
      * supply a looped MP3 URL. If a media URL is chosen in the portal, customers can
      * preview it before saving.
      */
-    background_audio?: InferenceEmbeddingVoiceSettings.UnionMember0 | InferenceEmbeddingVoiceSettings.UnionMember1 | InferenceEmbeddingVoiceSettings.UnionMember2;
+    background_audio?: InferenceEmbeddingVoiceSettings.BackgroundAudioUnionMember0 | InferenceEmbeddingVoiceSettings.BackgroundAudioUnionMember1 | InferenceEmbeddingVoiceSettings.UnionMember2;
     /**
      * Enables emotionally expressive speech using SSML emotion tags. When enabled, the
      * assistant uses audio tags like angry, excited, content, and sad to add emotional
@@ -1993,6 +2102,13 @@ export interface InferenceEmbeddingVoiceSettings {
      * consistent, monotonous output. Only applicable when using ElevenLabs.
      */
     temperature?: number;
+    /**
+     * Optional sound played to the caller while the assistant runs a tool (for example
+     * a webhook or MCP tool). It replaces the background audio until the tool
+     * responds, then the background audio resumes. Defaults to null, which plays no
+     * sound; send `null` on update to clear it. Not played in conference calls.
+     */
+    tool_call_audio?: InferenceEmbeddingVoiceSettings.ToolCallAudioUnionMember0 | InferenceEmbeddingVoiceSettings.ToolCallAudioUnionMember1 | null;
     /**
      * Amplifies similarity to the original speaker voice. Increases computational load
      * and latency slightly. Only applicable when using ElevenLabs.
@@ -2007,7 +2123,7 @@ export interface InferenceEmbeddingVoiceSettings {
     voice_speed?: number;
 }
 export declare namespace InferenceEmbeddingVoiceSettings {
-    interface UnionMember0 {
+    interface BackgroundAudioUnionMember0 {
         /**
          * Select from predefined media options.
          */
@@ -2022,7 +2138,7 @@ export declare namespace InferenceEmbeddingVoiceSettings {
          */
         volume?: number;
     }
-    interface UnionMember1 {
+    interface BackgroundAudioUnionMember1 {
         /**
          * Provide a direct URL to an MP3 file. The audio will loop during the call.
          */
@@ -2044,6 +2160,31 @@ export declare namespace InferenceEmbeddingVoiceSettings {
          */
         value: string;
     }
+    interface ToolCallAudioUnionMember0 {
+        /**
+         * Select from predefined media options.
+         */
+        type: 'predefined_media';
+        /**
+         * The predefined media to use. `typing` plays a keyboard typing sound.
+         */
+        value: 'typing';
+        /**
+         * Volume level for the predefined media. Supports values from 0.0 to 1.0 in 0.1
+         * increments. `0.0` plays no sound.
+         */
+        volume?: number;
+    }
+    interface ToolCallAudioUnionMember1 {
+        /**
+         * Provide a direct URL to an MP3 file. The audio loops while the tool runs.
+         */
+        type: 'media_url';
+        /**
+         * HTTPS URL to an MP3 file.
+         */
+        value: string;
+    }
 }
 export interface InferenceEmbeddingWebhookToolParams {
     type: 'webhook';
@@ -2412,6 +2553,33 @@ export interface PrivacySettings {
      * border. Defaults to false.
      */
     in_transit_data_locality?: boolean;
+    /**
+     * Controls redaction of personally identifiable information (PII) from the
+     * conversation history that is stored for this assistant. `disabled` (default)
+     * stores content as-is. `redact` replaces detected PII with `<PII:type/>`
+     * placeholders (e.g. `<PII:name/>`, `<PII:phone/>`) as the stored copies are
+     * written: message content (user, assistant, and tool-result messages) and
+     * tool-call arguments are redacted when written to conversation history, so the
+     * stored transcript, its read-back via the history API, and any insights generated
+     * from the stored messages contain the placeholders instead of the PII; response
+     * bodies returned by webhook tools are redacted too, as stored in the webhook logs
+     * — a per-conversation record separate from the transcript. In the Mission Control
+     * Portal this field appears as a "PII Redaction" on/off toggle, where Enabled
+     * corresponds to `redact`. Redaction runs when the stored copy is written, after
+     * the LLM has generated its reply: the live conversation is not redacted, the
+     * assistant's tools keep receiving the full (unredacted) values during the call,
+     * and the LLM still sees full content in its context window. Call recordings
+     * (including any recording layout configured under telephony settings) and the
+     * payloads of messages/webhooks delivered during the call are never redacted by
+     * this setting. The set of detected PII types (names, street addresses, phone
+     * numbers, email addresses, government identifiers like SSN and driver's license
+     * numbers, credit card and bank account numbers, IP addresses, dates of birth, and
+     * other identifiers unique to a person) is fixed by Telnyx and cannot be
+     * configured or extended per assistant. Assistants with `redact` cannot be used
+     * for SMS/WhatsApp messaging (that combination is rejected with a 400 error);
+     * voice and web chat are unaffected.
+     */
+    pii_redaction?: 'disabled' | 'redact';
 }
 /**
  * Whether to auto-publish the assistant's instructions as a Langfuse prompt.
@@ -2524,6 +2692,15 @@ export interface StartSpeakingPlan {
     wait_seconds?: number;
 }
 export interface TelephonySettings {
+    /**
+     * When enabled, the `messages` array of the `call.conversation.ended` webhook
+     * contains the full conversation history in order: user and assistant turns,
+     * assistant tool calls (`tool_calls`), tool results (`role: tool` with
+     * `tool_call_id`), and informational `system` and `developer` entries. The
+     * assistant's instructions are never included. When disabled, `messages` contains
+     * only user and assistant text turns.
+     */
+    conversation_ended_full_history?: boolean;
     /**
      * Default Texml App used for voice calls with your assistant. This will be created
      * automatically on assistant creation.
@@ -2581,9 +2758,16 @@ export interface TelephonySettings {
     supports_unauthenticated_web_calls?: boolean;
     /**
      * Maximum duration in seconds for the AI assistant to participate on the call.
-     * When this limit is reached the assistant will be stopped. This limit does not
-     * apply to portions of a call without an active assistant (for instance, a call
-     * transferred to a human representative).
+     * When this limit is reached the assistant will be stopped. Stopping the assistant
+     * does not itself hang up the call, and what happens next depends on how the
+     * assistant is running. On Call Control (ai_assistant_start) the call leg stays
+     * connected and continues to be billed until it is hung up (for example with the
+     * Hangup call command) or until the call ends for another reason. On TeXML, the
+     * assistant's `<Connect><AIAssistant>` instruction ends; in the default TeXML
+     * setup for assistants no instructions follow it, so the call is hung up. Your
+     * application receives a call.conversation.ended webhook when the assistant stops.
+     * This limit does not apply to portions of a call without an active assistant (for
+     * instance, a call transferred to a human representative).
      */
     time_limit_secs?: number;
     /**
@@ -2594,9 +2778,16 @@ export interface TelephonySettings {
     user_idle_reply_secs?: number;
     /**
      * Maximum duration in seconds of end user silence on the call. When this limit is
-     * reached the assistant will be stopped. This limit does not apply to portions of
-     * a call without an active assistant (for instance, a call transferred to a human
-     * representative).
+     * reached the assistant will be stopped. Stopping the assistant does not itself
+     * hang up the call, and what happens next depends on how the assistant is running.
+     * On Call Control (ai_assistant_start) the call leg stays connected and continues
+     * to be billed until it is hung up (for example with the Hangup call command) or
+     * until the call ends for another reason. On TeXML, the assistant's
+     * `<Connect><AIAssistant>` instruction ends; in the default TeXML setup for
+     * assistants no instructions follow it, so the call is hung up. Your application
+     * receives a call.conversation.ended webhook when the assistant stops. This limit
+     * does not apply to portions of a call without an active assistant (for instance,
+     * a call transferred to a human representative).
      */
     user_idle_timeout_secs?: number;
     /**
@@ -2722,6 +2913,31 @@ export declare namespace TelephonySettings {
         }
     }
 }
+/**
+ * **Beta:** Configuration for the Telnyx open-source avatar provider. Use a stock
+ * avatar or an organization-owned custom avatar returned by the Avatars API.
+ * Discover the available stock catalog with GET /v2/ai/avatars and
+ * filter[avatar_type]=stock; follow meta.total_pages to load every page.
+ */
+export interface TelnyxAvatarSettings {
+    /**
+     * The Telnyx stock avatar or organization-owned custom avatar to render.
+     */
+    avatar_id: AvatarsAPI.AvatarID;
+    /**
+     * The background to render.
+     */
+    background_id: 'office' | 'studio' | 'reception' | 'illustrated_workspace';
+    /**
+     * Required avatar model identifier, separate from `avatar_id`. The supported value
+     * is `foxtrot-1`. Omission, null, and unsupported model identifiers are rejected.
+     */
+    model: 'foxtrot-1';
+    /**
+     * Selects the Telnyx open-source avatar provider.
+     */
+    provider: 'telnyx';
+}
 /**
  * A standalone tool step in a conversation flow, as returned by the API.
  */
@@ -2845,6 +3061,22 @@ export interface TranscriptionSettings {
      * used for Azure transcription regions that require a customer-provided API key.
      */
     api_key_ref?: string;
+    /**
+     * A second speech-to-text model that transcribes alongside `transcription.model`,
+     * and the rule that decides which transcript the assistant uses.
+     */
+    challenger?: TranscriptionSettings.Challenger | null;
+    /**
+     * Up to 3 streaming models that take over transcription, in this order, when the
+     * model in use fails, at the start of a call or mid-call. `model` must be a
+     * streaming model too, and must support `language` alongside other models. On
+     * update, a list replaces the stored one: omit the field to keep the stored list,
+     * or send `null` or `[]` to remove it. When an update changes `model` or
+     * `language`, stored fallbacks that no longer fit are removed without an error.
+     * Can't be combined with `challenger`, the language booster; to replace a stored
+     * language booster, send `challenger: null` in the same request.
+     */
+    fallback_models?: Array<TranscriptionSettings.FallbackModel> | null;
     /**
      * The language of the audio to be transcribed. If not set, or if set to `auto`,
      * supported models will automatically detect the language. For `deepgram/flux`,
@@ -2862,7 +3094,12 @@ export interface TranscriptionSettings {
      * `nl`, `en`, `fr`, `fy`, `de`, `it`, `pl`, `pt`, `es`, and `sv` to fix the
      * transcription language. For `cohere/ar-stt`, supported values are `ar` and `en`;
      * unlike other models, this model does not auto-detect and defaults to `ar` when
-     * `language` is omitted.
+     * `language` is omitted. For `speechmatics/linden-1`, there is no auto-detect; set
+     * a code from Speechmatics' Realtime language list (67 language codes, including
+     * `es-bilingual-en` for Spanish and English bilingual, and the spelling and script
+     * variants `en-US`, `en-GB`, `en-AU`, `cmn-Hans`, and `cmn-Hant`; `en` alone uses
+     * the default spelling); unset defaults to `en`, while an explicit `auto`,
+     * `auto_beta`, or `multi` is rejected with a 400.
      */
     language?: string;
     /**
@@ -2872,6 +3109,12 @@ export interface TranscriptionSettings {
      * - `deepgram/flux` is optimized for turn-taking with multilingual language hints.
      * - `deepgram/nova-3` is multilingual with automatic language detection.
      * - `deepgram/nova-2` is Deepgram's previous-generation multilingual model.
+     * - `speechmatics/standard` is a Speechmatics model self-hosted by Telnyx; it
+     *   supports a fixed set of language packs (including bilingual packs such as
+     *   `ar_en`) and defaults to `en`.
+     * - `speechmatics/linden-1` (preview) is a vendor-hosted streaming model with no
+     *   auto-detect; set `language` from Speechmatics' Realtime language list
+     *   (defaults to `en`).
      * - `azure/fast` is a multilingual Azure transcription model.
      * - `assemblyai/universal-3-5-pro` is a multilingual streaming model with
      *   configurable turn detection. The legacy alias `assemblyai/universal-streaming`
@@ -2889,8 +3132,9 @@ export interface TranscriptionSettings {
      * - `reson8/turns` is a turn-based streaming model covering 10 European languages
      *   with automatic language detection.
      * - `cohere/ar-stt` is a non-streaming Arabic and English transcription model.
+     * - `telnyx/basira` is a non-streaming Arabic transcription model.
      */
-    model?: 'deepgram/flux' | 'deepgram/nova-3' | 'deepgram/nova-2' | 'azure/fast' | 'assemblyai/universal-3-5-pro' | 'assemblyai/universal-streaming' | 'xai/grok-stt' | 'soniox/stt-rt-v4' | 'soniox/stt-rt-v5' | 'nvidia/parakeet-v3' | 'omi-health/omi-med-stt-v1' | 'humain/realtime' | 'reson8/turns' | 'cohere/ar-stt' | 'distil-whisper/distil-large-v2' | 'openai/whisper-large-v3-turbo';
+    model?: 'deepgram/flux' | 'deepgram/nova-3' | 'deepgram/nova-2' | 'speechmatics/standard' | 'speechmatics/linden-1' | 'azure/fast' | 'assemblyai/universal-3-5-pro' | 'assemblyai/universal-streaming' | 'xai/grok-stt' | 'soniox/stt-rt-v4' | 'soniox/stt-rt-v5' | 'nvidia/parakeet-v3' | 'omi-health/omi-med-stt-v1' | 'humain/realtime' | 'reson8/turns' | 'cohere/ar-stt' | 'telnyx/basira' | 'distil-whisper/distil-large-v2' | 'openai/whisper-large-v3-turbo';
     /**
      * Region on third party cloud providers (currently Azure) if using one of their
      * models. Some regions require `api_key_ref`.
@@ -2898,6 +3142,90 @@ export interface TranscriptionSettings {
     region?: string;
     settings?: TranscriptionSettingsConfig;
 }
+export declare namespace TranscriptionSettings {
+    /**
+     * A second speech-to-text model that transcribes alongside `transcription.model`,
+     * and the rule that decides which transcript the assistant uses.
+     */
+    interface Challenger {
+        /**
+         * The language booster's model. It must be the same kind of model as
+         * `transcription.model`: both streaming (`deepgram/flux`, `deepgram/nova-3`,
+         * `deepgram/nova-2`, `assemblyai/universal-3-5-pro` or its legacy alias
+         * `assemblyai/universal-streaming`, `xai/grok-stt`, `soniox/stt-rt-v4`,
+         * `soniox/stt-rt-v5`, `humain/realtime`, `reson8/turns`) or both non-streaming
+         * (`azure/fast`, `nvidia/parakeet-v3`, `omi-health/omi-med-stt-v1`,
+         * `cohere/ar-stt`, `distil-whisper/distil-large-v2`,
+         * `openai/whisper-large-v3-turbo`, `telnyx/basira`). It can be the same model as
+         * `transcription.model` on a different `language`.
+         */
+        model: 'deepgram/flux' | 'deepgram/nova-3' | 'deepgram/nova-2' | 'azure/fast' | 'assemblyai/universal-3-5-pro' | 'assemblyai/universal-streaming' | 'xai/grok-stt' | 'soniox/stt-rt-v4' | 'soniox/stt-rt-v5' | 'nvidia/parakeet-v3' | 'omi-health/omi-med-stt-v1' | 'humain/realtime' | 'reson8/turns' | 'cohere/ar-stt' | 'telnyx/basira' | 'distil-whisper/distil-large-v2' | 'openai/whisper-large-v3-turbo';
+        /**
+         * The language this model transcribes. Omit it or set it to `null` to use the
+         * language of `transcription.model`. The request is rejected when this model
+         * doesn't support the language it would run. It is also rejected when it would run
+         * the same model on the same language as `transcription.model`.
+         */
+        language?: string | null;
+        /**
+         * How the assistant picks the transcript it uses. The models are compared on how
+         * complete and confident their transcripts are, not on language, so the rules work
+         * best when both models understand the callers' language.
+         *
+         * - `best_turn` (default): both models transcribe the whole call. Each turn uses
+         *   the language booster's transcript only when it scores higher than the
+         *   transcript of `transcription.model` (clearly higher with non-streaming
+         *   models). With streaming models, `transcription.model` also decides when each
+         *   turn ends. Available for every pair.
+         * - `best_engine`: both models transcribe the first turns, then the call continues
+         *   alone on the model whose transcripts scored higher. If neither clearly leads,
+         *   `transcription.model` continues. Streaming models only.
+         * - `merge_words`: both models transcribe each utterance and their words are
+         *   merged, keeping Arabic and English spoken in the same sentence. Available only
+         *   for `telnyx/basira` with `cohere/ar-stt`, in either order. The pair runs on
+         *   the language that applies to `telnyx/basira` (its own, or that of
+         *   `transcription.model`), which must be Arabic (`ar` or an `ar-` locale),
+         *   `multi`, or `auto`.
+         */
+        rule?: 'best_turn' | 'best_engine' | 'merge_words';
+        /**
+         * Settings for the language booster, with the same fields and limits as
+         * `transcription.settings`. Fields that don't apply to this model's provider are
+         * dropped, and the provider's defaults fill in the rest. Omit it or set it to
+         * `null` to use the settings of `transcription.model` where they apply to this
+         * model.
+         */
+        settings?: AssistantsAPI.TranscriptionSettingsConfig | null;
+    }
+    /**
+     * A streaming speech-to-text model that takes over transcription when the model in
+     * use fails.
+     */
+    interface FallbackModel {
+        /**
+         * The fallback model. It must be a streaming model other than
+         * `transcription.model` and the other fallbacks: `deepgram/flux`,
+         * `deepgram/nova-3`, `deepgram/nova-2`, `assemblyai/universal-3-5-pro` (or its
+         * legacy alias `assemblyai/universal-streaming`), `xai/grok-stt`,
+         * `soniox/stt-rt-v4`, `soniox/stt-rt-v5`, `humain/realtime`, or `reson8/turns`.
+         */
+        model: 'deepgram/flux' | 'deepgram/nova-3' | 'deepgram/nova-2' | 'assemblyai/universal-3-5-pro' | 'assemblyai/universal-streaming' | 'xai/grok-stt' | 'soniox/stt-rt-v4' | 'soniox/stt-rt-v5' | 'humain/realtime' | 'reson8/turns';
+        /**
+         * The language the fallback transcribes. Omit it or set it to `null` to use the
+         * language of `transcription.model`. The request is rejected when the fallback
+         * model doesn't support the language it would run.
+         */
+        language?: string | null;
+        /**
+         * Settings for the fallback, with the same fields and limits as
+         * `transcription.settings`. Fields that don't apply to this model's provider are
+         * dropped, and the provider's defaults fill in the rest. Omit it or set it to
+         * `null` to use the settings of `transcription.model` where they apply to this
+         * model.
+         */
+        settings?: AssistantsAPI.TranscriptionSettingsConfig | null;
+    }
+}
 export interface TranscriptionSettingsConfig {
     /**
      * Available only for soniox/stt-rt-v4 and soniox/stt-rt-v5. A comma-separated list
@@ -2922,9 +3250,9 @@ export interface TranscriptionSettingsConfig {
      */
     enable_endpoint_detection?: boolean;
     /**
-     * Available only for assemblyai/universal-3-5-pro (and its legacy alias
-     * assemblyai/universal-streaming). Confidence level required to trigger an end of
-     * turn. Higher values require more certainty before ending a turn.
+     * @deprecated Deprecated and ignored. Accepted for backwards compatibility.
+     * AssemblyAI turn detection is configured with min_turn_silence and
+     * max_turn_silence.
      */
     end_of_turn_confidence_threshold?: number;
     /**
@@ -2943,10 +3271,13 @@ export interface TranscriptionSettingsConfig {
      */
     interim_results?: boolean;
     /**
-     * Available only for deepgram/nova-3 and deepgram/flux. A comma-separated list of
-     * key terms to boost for recognition during transcription. Helps improve accuracy
-     * for domain-specific terminology, proper nouns, or uncommon words. This field may
-     * be templated with
+     * A comma-separated list of key terms to boost for recognition during
+     * transcription, used by Deepgram, Reson8, Speechmatics Linden 1 and AssemblyAI
+     * models. Helps improve accuracy for domain-specific terminology, proper nouns, or
+     * uncommon words. At most 1000 characters in total. For
+     * assemblyai/universal-3-5-pro (and its legacy alias
+     * assemblyai/universal-streaming), also at most 100 terms of up to 50 characters
+     * each. This field may be templated with
      * [dynamic variables](https://developers.telnyx.com/docs/inference/ai-assistants/dynamic-variables)
      * using mustache syntax (e.g. `Telnyx,{{customer_name}},VoIP`). Variables are
      * resolved at call time before the value is sent to the speech-to-text engine.
@@ -2977,6 +3308,22 @@ export interface TranscriptionSettingsConfig {
      */
     min_turn_silence?: number;
     numerals?: boolean;
+    /**
+     * Available only for assemblyai/universal-3-5-pro (and its legacy alias
+     * assemblyai/universal-streaming). Context about the conversation (domain, names,
+     * terms) to improve transcription; describe the content, do not give instructions.
+     * Leave empty unless needed. At most 1750 characters.
+     */
+    prompt?: string;
+    /**
+     * Available only for speechmatics/linden-1. When true, filler words such as "um"
+     * and "uh" are removed from the transcript. Disfluency removal is supported only
+     * for `ar`, `cmn`, `da`, `de`, `el`, `en`, `es`, `fr`, `he`, `hi`, `hu`, `it`,
+     * `ja`, `nl`, `pl`, `pt`, and `ru`, determined by the base language (so `en-US`,
+     * `en-GB`, `en-AU`, `cmn-Hans`, and `cmn-Hant` are supported); for other
+     * languages, filler words remain in the transcript.
+     */
+    remove_disfluencies?: boolean;
     smart_format?: boolean;
 }
 export interface TransferTool {
@@ -3377,6 +3724,13 @@ export interface AssistantCreateParams {
      * that capability for the conversation; it does not fail the call.
      */
     a2a_agents?: Array<AssistantA2AAgent>;
+    /**
+     * Body param: **Beta:** Configuration for the Telnyx open-source avatar provider.
+     * Use a stock avatar or an organization-owned custom avatar returned by the
+     * Avatars API. Discover the available stock catalog with GET /v2/ai/avatars and
+     * filter[avatar_type]=stock; follow meta.total_pages to load every page.
+     */
+    avatar_settings?: AvatarSettingsRequest | null;
     /**
      * Body param: Conversation flow as supplied by API clients (create / update).
      *
@@ -3626,6 +3980,13 @@ export interface AssistantUpdateParams {
      * leave the assistant's agents unchanged; send an empty array to remove them all.
      */
     a2a_agents?: Array<AssistantA2AAgent>;
+    /**
+     * **Beta:** Configuration for the Telnyx open-source avatar provider. Use a stock
+     * avatar or an organization-owned custom avatar returned by the Avatars API.
+     * Discover the available stock catalog with GET /v2/ai/avatars and
+     * filter[avatar_type]=stock; follow meta.total_pages to load every page.
+     */
+    avatar_settings?: AvatarSettingsRequest | null;
     /**
      * Conversation flow as supplied by API clients (create / update).
      *
@@ -3896,7 +4257,7 @@ export interface AssistantWhatsappParams {
     'Idempotency-Key'?: string;
 }
 export declare namespace Assistants {
-    export { type ArithmeticExpression as ArithmeticExpression, type Assistant as Assistant, type AssistantA2AAgent as AssistantA2AAgent, type AssistantIntegration as AssistantIntegration, type AssistantMcpServer as AssistantMcpServer, type AssistantTool as AssistantTool, type AssistantsList as AssistantsList, type AudioVisualizerConfig as AudioVisualizerConfig, type AuthenticationMethod as AuthenticationMethod, type BooleanOpExpression as BooleanOpExpression, type ComparisonExpression as ComparisonExpression, type ConversationFlow as ConversationFlow, type ConversationFlowReq as ConversationFlowReq, type DelegationSettings as DelegationSettings, type EnabledFeatures as EnabledFeatures, type Expression as Expression, type ExternalLlm as ExternalLlm, type ExternalLlmReq as ExternalLlmReq, type FallbackConfig as FallbackConfig, type FallbackConfigReq as FallbackConfigReq, type FlowEdge as FlowEdge, type FlowNode as FlowNode, type FlowNodeReq as FlowNodeReq, type HangupTool as HangupTool, type HangupToolParams as HangupToolParams, type ImportMetadata as ImportMetadata, type InferenceEmbedding as InferenceEmbedding, type InferenceEmbeddingInterruptionSettings as InferenceEmbeddingInterruptionSettings, type InferenceEmbeddingVoiceSettings as InferenceEmbeddingVoiceSettings, type InferenceEmbeddingWebhookToolParams as InferenceEmbeddingWebhookToolParams, type InsightSettings as InsightSettings, type MessagingSettings as MessagingSettings, type NodePosition as NodePosition, type Observability as Observability, type ObservabilityReq as ObservabilityReq, type ObservabilityStatus as ObservabilityStatus, type PostConversationSettings as PostConversationSettings, type PostConversationSettingsReq as PostConversationSettingsReq, type PrivacySettings as PrivacySettings, type PromptSyncStatus as PromptSyncStatus, type RetrievalTool as RetrievalTool, type SpeakNode as SpeakNode, type SpeakNodeReq as SpeakNodeReq, type StartSpeakingPlan as StartSpeakingPlan, type TelephonySettings as TelephonySettings, type ToolNode as ToolNode, type ToolNodeReq as ToolNodeReq, type TranscriptionEndpointingPlan as TranscriptionEndpointingPlan, type TranscriptionSettings as TranscriptionSettings, type TranscriptionSettingsConfig as TranscriptionSettingsConfig, type TransferTool as TransferTool, type VoiceSettings as VoiceSettings, type WebhookTool as WebhookTool, type WebsocketSettings as WebsocketSettings, type WidgetSettings as WidgetSettings, type AssistantDeleteResponse as AssistantDeleteResponse, type AssistantChatResponse as AssistantChatResponse, type AssistantGetTexmlResponse as AssistantGetTexmlResponse, type AssistantSendSMSResponse as AssistantSendSMSResponse, type AssistantWhatsappResponse as AssistantWhatsappResponse, type AssistantCreateParams as AssistantCreateParams, type AssistantImportsParams as AssistantImportsParams, type AssistantDeleteParams as AssistantDeleteParams, type AssistantRetrieveParams as AssistantRetrieveParams, type AssistantUpdateParams as AssistantUpdateParams, type AssistantChatParams as AssistantChatParams, type AssistantCloneParams as AssistantCloneParams, type AssistantSendSMSParams as AssistantSendSMSParams, type AssistantWhatsappParams as AssistantWhatsappParams, };
+    export { type ArithmeticExpression as ArithmeticExpression, type Assistant as Assistant, type AssistantA2AAgent as AssistantA2AAgent, type AssistantIntegration as AssistantIntegration, type AssistantMcpServer as AssistantMcpServer, type AssistantTool as AssistantTool, type AssistantsList as AssistantsList, type AudioVisualizerConfig as AudioVisualizerConfig, type AuthenticationMethod as AuthenticationMethod, type AvatarSettingsRequest as AvatarSettingsRequest, type BooleanOpExpression as BooleanOpExpression, type ComparisonExpression as ComparisonExpression, type ConversationFlow as ConversationFlow, type ConversationFlowReq as ConversationFlowReq, type DelegationSettings as DelegationSettings, type EnabledFeatures as EnabledFeatures, type Expression as Expression, type ExternalLlm as ExternalLlm, type ExternalLlmReq as ExternalLlmReq, type FallbackConfig as FallbackConfig, type FallbackConfigReq as FallbackConfigReq, type FlowEdge as FlowEdge, type FlowNode as FlowNode, type FlowNodeReq as FlowNodeReq, type HangupTool as HangupTool, type HangupToolParams as HangupToolParams, type ImportMetadata as ImportMetadata, type InferenceEmbedding as InferenceEmbedding, type InferenceEmbeddingInterruptionSettings as InferenceEmbeddingInterruptionSettings, type InferenceEmbeddingVoiceSettings as InferenceEmbeddingVoiceSettings, type InferenceEmbeddingWebhookToolParams as InferenceEmbeddingWebhookToolParams, type InsightSettings as InsightSettings, type MessagingSettings as MessagingSettings, type NodePosition as NodePosition, type Observability as Observability, type ObservabilityReq as ObservabilityReq, type ObservabilityStatus as ObservabilityStatus, type PostConversationSettings as PostConversationSettings, type PostConversationSettingsReq as PostConversationSettingsReq, type PrivacySettings as PrivacySettings, type PromptSyncStatus as PromptSyncStatus, type RetrievalTool as RetrievalTool, type SpeakNode as SpeakNode, type SpeakNodeReq as SpeakNodeReq, type StartSpeakingPlan as StartSpeakingPlan, type TelephonySettings as TelephonySettings, type TelnyxAvatarSettings as TelnyxAvatarSettings, type ToolNode as ToolNode, type ToolNodeReq as ToolNodeReq, type TranscriptionEndpointingPlan as TranscriptionEndpointingPlan, type TranscriptionSettings as TranscriptionSettings, type TranscriptionSettingsConfig as TranscriptionSettingsConfig, type TransferTool as TransferTool, type VoiceSettings as VoiceSettings, type WebhookTool as WebhookTool, type WebsocketSettings as WebsocketSettings, type WidgetSettings as WidgetSettings, type AssistantDeleteResponse as AssistantDeleteResponse, type AssistantChatResponse as AssistantChatResponse, type AssistantGetTexmlResponse as AssistantGetTexmlResponse, type AssistantSendSMSResponse as AssistantSendSMSResponse, type AssistantWhatsappResponse as AssistantWhatsappResponse, type AssistantCreateParams as AssistantCreateParams, type AssistantImportsParams as AssistantImportsParams, type AssistantDeleteParams as AssistantDeleteParams, type AssistantRetrieveParams as AssistantRetrieveParams, type AssistantUpdateParams as AssistantUpdateParams, type AssistantChatParams as AssistantChatParams, type AssistantCloneParams as AssistantCloneParams, type AssistantSendSMSParams as AssistantSendSMSParams, type AssistantWhatsappParams as AssistantWhatsappParams, };
     export { Tests as Tests, type AssistantTest as AssistantTest, type TelnyxConversationChannel as TelnyxConversationChannel, type AssistantTestsDefaultFlatPagination as AssistantTestsDefaultFlatPagination, type TestListParams as TestListParams, type TestCreateParams as TestCreateParams, type TestUpdateParams as TestUpdateParams, };
     export { CanaryDeploys as CanaryDeploys, type CanaryDeploy as CanaryDeploy, type CanaryDeployResponse as CanaryDeployResponse, type Clause as Clause, type RolloutSlot as RolloutSlot, type RuleInput as RuleInput, type RuleOutput as RuleOutput, type Serve as Serve, type CanaryDeployCreateParams as CanaryDeployCreateParams, type CanaryDeployUpdateParams as CanaryDeployUpdateParams, };
     export { ScheduledEvents as ScheduledEvents, type ConversationChannelType as ConversationChannelType, type EventStatus as EventStatus, type ScheduledCallSettings as ScheduledCallSettings, type ScheduledEventResponse as ScheduledEventResponse, type ScheduledPhoneCallEventResponse as ScheduledPhoneCallEventResponse, type ScheduledSMSEventResponse as ScheduledSMSEventResponse, type ScheduledEventListResponse as ScheduledEventListResponse, type ScheduledEventListResponsesDefaultFlatPagination as ScheduledEventListResponsesDefaultFlatPagination, type ScheduledEventListParams as ScheduledEventListParams, type ScheduledEventCreateParams as ScheduledEventCreateParams, type ScheduledEventDeleteParams as ScheduledEventDeleteParams, type ScheduledEventRetrieveParams as ScheduledEventRetrieveParams, };