telnyx 5.55.0 → 5.56.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 356e6c41b63f97ca790fb4ce787423939e5baa395db3d2f1ac1c578f5d0c62d8
-  data.tar.gz: c89902273a5a02f7f098e51b59e0a9eac53b1bfe61a174bad47914aafab46ecd
+  metadata.gz: f1fa910eb357763c534e127ffdba479e62d9816bd2247a0851d4d5bb54a2946c
+  data.tar.gz: e31d13fbfbc448b8bd6f20da460909324512da59c59983284c67d288d69f6a68
 SHA512:
-  metadata.gz: 396aad1572805770b72fd861aa39ae2b52d639bb912cebe46a966e0232e07f30cf3f3a4ce7b6f58da4c5cb523652276ae064968356224a9074513705ca8e2a1c
-  data.tar.gz: 81c386d95f49aa38ffdbbcd3b6a5dd45ea2f4839822cf9f1c5014306b3b96c472ee4b5172fa97512797759dd4024a42489aef3e52049c26482a754e56be6cd04
+  metadata.gz: d84011d798fcfa77678a6e49b06f77fdf3431d5a26daaf0e5cf00261c001feada7c624eeee163c1931c30b7082bfe23534be726cb58be2b495b47e55c88c7f7d
+  data.tar.gz: dfbe61cfb6e0910241474c9429624b87c8c9c70843ed28b60311faf2e4e9ca21fffa3575b7107247e2bfa8afecd1a7df76485b35ccc6e7e50b59cf038fe0e9dc

data/CHANGELOG.md

@@ -1,5 +1,13 @@
 # Changelog
 
+## 5.56.0 (2026-03-17)
+
+Full Changelog: [v5.55.0...v5.56.0](https://github.com/team-telnyx/telnyx-ruby/compare/v5.55.0...v5.56.0)
+
+### Features
+
+* add ai_assistant_join call control command OpenAPI spec ([5ab91f5](https://github.com/team-telnyx/telnyx-ruby/commit/5ab91f5327fd55aa5338bdaf1ba33de84994f3e1))
+
 ## 5.55.0 (2026-03-16)
 
 Full Changelog: [v5.54.0...v5.55.0](https://github.com/team-telnyx/telnyx-ruby/compare/v5.54.0...v5.55.0)

data/README.md

@@ -24,7 +24,7 @@ To use this gem, install via Bundler by adding the following to your application
 <!-- x-release-please-start-version -->
 
 ```ruby
-gem "telnyx", "~> 5.55.0"
+gem "telnyx", "~> 5.56.0"
 ```
 
 <!-- x-release-please-end -->

data/lib/telnyx/client.rb

@@ -639,6 +639,10 @@ module Telnyx
     # @return [Telnyx::Resources::X402]
     attr_reader :x402
 
+    # Speech to text command operations
+    # @return [Telnyx::Resources::SpeechToText]
+    attr_reader :speech_to_text
+
     # @api private
     #
     # @return [Hash{String=>String}]
@@ -892,6 +896,7 @@ module Telnyx
       @voice_clones = Telnyx::Resources::VoiceClones.new(client: self)
       @voice_designs = Telnyx::Resources::VoiceDesigns.new(client: self)
       @x402 = Telnyx::Resources::X402.new(client: self)
+      @speech_to_text = Telnyx::Resources::SpeechToText.new(client: self)
     end
   end
 end

data/lib/telnyx/models/calls/action_join_ai_assistant_params.rb

@@ -0,0 +1,119 @@
+# frozen_string_literal: true
+
+module Telnyx
+  module Models
+    module Calls
+      # @see Telnyx::Resources::Calls::Actions#join_ai_assistant
+      class ActionJoinAIAssistantParams < Telnyx::Internal::Type::BaseModel
+        extend Telnyx::Internal::Type::RequestParameters::Converter
+        include Telnyx::Internal::Type::RequestParameters
+
+        # @!attribute call_control_id
+        #
+        #   @return [String]
+        required :call_control_id, String
+
+        # @!attribute conversation_id
+        #   The ID of the AI assistant conversation to join.
+        #
+        #   @return [String]
+        required :conversation_id, String
+
+        # @!attribute participant
+        #
+        #   @return [Telnyx::Models::Calls::ActionJoinAIAssistantParams::Participant]
+        required :participant, -> { Telnyx::Calls::ActionJoinAIAssistantParams::Participant }
+
+        # @!attribute client_state
+        #   Use this field to add state to every subsequent webhook. It must be a valid
+        #   Base-64 encoded string.
+        #
+        #   @return [String, nil]
+        optional :client_state, String
+
+        # @!attribute command_id
+        #   Use this field to avoid duplicate commands. Telnyx will ignore any command with
+        #   the same `command_id` for the same `call_control_id`.
+        #
+        #   @return [String, nil]
+        optional :command_id, String
+
+        # @!method initialize(call_control_id:, conversation_id:, participant:, client_state: nil, command_id: nil, request_options: {})
+        #   Some parameter documentations has been truncated, see
+        #   {Telnyx::Models::Calls::ActionJoinAIAssistantParams} for more details.
+        #
+        #   @param call_control_id [String]
+        #
+        #   @param conversation_id [String] The ID of the AI assistant conversation to join.
+        #
+        #   @param participant [Telnyx::Models::Calls::ActionJoinAIAssistantParams::Participant]
+        #
+        #   @param client_state [String] Use this field to add state to every subsequent webhook. It must be a valid Base
+        #
+        #   @param command_id [String] Use this field to avoid duplicate commands. Telnyx will ignore any command with
+        #
+        #   @param request_options [Telnyx::RequestOptions, Hash{Symbol=>Object}]
+
+        class Participant < Telnyx::Internal::Type::BaseModel
+          # @!attribute id
+          #   The call_control_id of the participant to add to the conversation.
+          #
+          #   @return [String]
+          required :id, String
+
+          # @!attribute role
+          #   The role of the participant in the conversation.
+          #
+          #   @return [Symbol, Telnyx::Models::Calls::ActionJoinAIAssistantParams::Participant::Role]
+          required :role, enum: -> { Telnyx::Calls::ActionJoinAIAssistantParams::Participant::Role }
+
+          # @!attribute name
+          #   Display name for the participant.
+          #
+          #   @return [String, nil]
+          optional :name, String
+
+          # @!attribute on_hangup
+          #   Determines what happens to the conversation when this participant hangs up.
+          #
+          #   @return [Symbol, Telnyx::Models::Calls::ActionJoinAIAssistantParams::Participant::OnHangup, nil]
+          optional :on_hangup, enum: -> { Telnyx::Calls::ActionJoinAIAssistantParams::Participant::OnHangup }
+
+          # @!method initialize(id:, role:, name: nil, on_hangup: nil)
+          #   @param id [String] The call_control_id of the participant to add to the conversation.
+          #
+          #   @param role [Symbol, Telnyx::Models::Calls::ActionJoinAIAssistantParams::Participant::Role] The role of the participant in the conversation.
+          #
+          #   @param name [String] Display name for the participant.
+          #
+          #   @param on_hangup [Symbol, Telnyx::Models::Calls::ActionJoinAIAssistantParams::Participant::OnHangup] Determines what happens to the conversation when this participant hangs up.
+
+          # The role of the participant in the conversation.
+          #
+          # @see Telnyx::Models::Calls::ActionJoinAIAssistantParams::Participant#role
+          module Role
+            extend Telnyx::Internal::Type::Enum
+
+            USER = :user
+
+            # @!method self.values
+            #   @return [Array<Symbol>]
+          end
+
+          # Determines what happens to the conversation when this participant hangs up.
+          #
+          # @see Telnyx::Models::Calls::ActionJoinAIAssistantParams::Participant#on_hangup
+          module OnHangup
+            extend Telnyx::Internal::Type::Enum
+
+            CONTINUE_CONVERSATION = :continue_conversation
+            END_CONVERSATION = :end_conversation
+
+            # @!method self.values
+            #   @return [Array<Symbol>]
+          end
+        end
+      end
+    end
+  end
+end

data/lib/telnyx/models/calls/action_join_ai_assistant_response.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+module Telnyx
+  module Models
+    module Calls
+      # @see Telnyx::Resources::Calls::Actions#join_ai_assistant
+      class ActionJoinAIAssistantResponse < Telnyx::Internal::Type::BaseModel
+        # @!attribute data
+        #
+        #   @return [Telnyx::Models::Calls::CallControlCommandResultWithConversationID, nil]
+        optional :data, -> { Telnyx::Calls::CallControlCommandResultWithConversationID }
+
+        # @!method initialize(data: nil)
+        #   @param data [Telnyx::Models::Calls::CallControlCommandResultWithConversationID]
+      end
+    end
+  end
+end

data/lib/telnyx/models/speech_to_text_transcribe_params.rb

@@ -0,0 +1,140 @@
+# frozen_string_literal: true
+
+module Telnyx
+  module Models
+    # @see Telnyx::Resources::SpeechToText#transcribe
+    class SpeechToTextTranscribeParams < Telnyx::Internal::Type::BaseModel
+      extend Telnyx::Internal::Type::RequestParameters::Converter
+      include Telnyx::Internal::Type::RequestParameters
+
+      # @!attribute input_format
+      #   The format of input audio stream.
+      #
+      #   @return [Symbol, Telnyx::Models::SpeechToTextTranscribeParams::InputFormat]
+      required :input_format, enum: -> { Telnyx::SpeechToTextTranscribeParams::InputFormat }
+
+      # @!attribute transcription_engine
+      #   The transcription engine to use for processing the audio stream.
+      #
+      #   @return [Symbol, Telnyx::Models::SpeechToTextTranscribeParams::TranscriptionEngine]
+      required :transcription_engine, enum: -> { Telnyx::SpeechToTextTranscribeParams::TranscriptionEngine }
+
+      # @!attribute endpointing
+      #   Silence duration (in milliseconds) that triggers end-of-speech detection. When
+      #   set, the engine uses this value to determine when a speaker has stopped talking.
+      #   Not all engines support this parameter.
+      #
+      #   @return [Integer, nil]
+      optional :endpointing, Integer
+
+      # @!attribute interim_results
+      #   Whether to receive interim transcription results.
+      #
+      #   @return [Boolean, nil]
+      optional :interim_results, Telnyx::Internal::Type::Boolean
+
+      # @!attribute keyterm
+      #   A key term to boost in the transcription. The engine will be more likely to
+      #   recognize this term. Can be specified multiple times for multiple terms.
+      #
+      #   @return [String, nil]
+      optional :keyterm, String
+
+      # @!attribute keywords
+      #   Comma-separated list of keywords to boost in the transcription. The engine will
+      #   prioritize recognition of these words.
+      #
+      #   @return [String, nil]
+      optional :keywords, String
+
+      # @!attribute language
+      #   The language spoken in the audio stream.
+      #
+      #   @return [String, nil]
+      optional :language, String
+
+      # @!attribute model
+      #   The specific model to use within the selected transcription engine.
+      #
+      #   @return [Symbol, Telnyx::Models::SpeechToTextTranscribeParams::Model, nil]
+      optional :model, enum: -> { Telnyx::SpeechToTextTranscribeParams::Model }
+
+      # @!attribute redact
+      #   Enable redaction of sensitive information (e.g., PCI data, SSN) from
+      #   transcription results. Supported values depend on the transcription engine.
+      #
+      #   @return [String, nil]
+      optional :redact, String
+
+      # @!method initialize(input_format:, transcription_engine:, endpointing: nil, interim_results: nil, keyterm: nil, keywords: nil, language: nil, model: nil, redact: nil, request_options: {})
+      #   Some parameter documentations has been truncated, see
+      #   {Telnyx::Models::SpeechToTextTranscribeParams} for more details.
+      #
+      #   @param input_format [Symbol, Telnyx::Models::SpeechToTextTranscribeParams::InputFormat] The format of input audio stream.
+      #
+      #   @param transcription_engine [Symbol, Telnyx::Models::SpeechToTextTranscribeParams::TranscriptionEngine] The transcription engine to use for processing the audio stream.
+      #
+      #   @param endpointing [Integer] Silence duration (in milliseconds) that triggers end-of-speech detection. When s
+      #
+      #   @param interim_results [Boolean] Whether to receive interim transcription results.
+      #
+      #   @param keyterm [String] A key term to boost in the transcription. The engine will be more likely to reco
+      #
+      #   @param keywords [String] Comma-separated list of keywords to boost in the transcription. The engine will
+      #
+      #   @param language [String] The language spoken in the audio stream.
+      #
+      #   @param model [Symbol, Telnyx::Models::SpeechToTextTranscribeParams::Model] The specific model to use within the selected transcription engine.
+      #
+      #   @param redact [String] Enable redaction of sensitive information (e.g., PCI data, SSN) from transcripti
+      #
+      #   @param request_options [Telnyx::RequestOptions, Hash{Symbol=>Object}]
+
+      # The format of input audio stream.
+      module InputFormat
+        extend Telnyx::Internal::Type::Enum
+
+        MP3 = :mp3
+        WAV = :wav
+
+        # @!method self.values
+        #   @return [Array<Symbol>]
+      end
+
+      # The transcription engine to use for processing the audio stream.
+      module TranscriptionEngine
+        extend Telnyx::Internal::Type::Enum
+
+        AZURE = :Azure
+        DEEPGRAM = :Deepgram
+        GOOGLE = :Google
+        TELNYX = :Telnyx
+
+        # @!method self.values
+        #   @return [Array<Symbol>]
+      end
+
+      # The specific model to use within the selected transcription engine.
+      module Model
+        extend Telnyx::Internal::Type::Enum
+
+        FAST = :fast
+        DEEPGRAM_NOVA_2 = :"deepgram/nova-2"
+        DEEPGRAM_NOVA_3 = :"deepgram/nova-3"
+        LATEST_LONG = :latest_long
+        LATEST_SHORT = :latest_short
+        COMMAND_AND_SEARCH = :command_and_search
+        PHONE_CALL = :phone_call
+        VIDEO = :video
+        DEFAULT = :default
+        MEDICAL_CONVERSATION = :medical_conversation
+        MEDICAL_DICTATION = :medical_dictation
+        OPENAI_WHISPER_TINY = :"openai/whisper-tiny"
+        OPENAI_WHISPER_LARGE_V3_TURBO = :"openai/whisper-large-v3-turbo"
+
+        # @!method self.values
+        #   @return [Array<Symbol>]
+      end
+    end
+  end
+end

data/lib/telnyx/models/text_to_speech_stream_params.rb

@@ -7,8 +7,106 @@ module Telnyx
       extend Telnyx::Internal::Type::RequestParameters::Converter
       include Telnyx::Internal::Type::RequestParameters
 
-      # @!method initialize(request_options: {})
+      # @!attribute audio_format
+      #   Audio output format override. Supported for Telnyx `Natural`/`NaturalHD` models
+      #   only. Accepted values: `pcm`, `wav`.
+      #
+      #   @return [Symbol, Telnyx::Models::TextToSpeechStreamParams::AudioFormat, nil]
+      optional :audio_format, enum: -> { Telnyx::TextToSpeechStreamParams::AudioFormat }
+
+      # @!attribute disable_cache
+      #   When `true`, bypass the audio cache and generate fresh audio.
+      #
+      #   @return [Boolean, nil]
+      optional :disable_cache, Telnyx::Internal::Type::Boolean
+
+      # @!attribute model_id
+      #   Model identifier for the chosen provider. Examples: `Natural`, `NaturalHD`
+      #   (Telnyx); `Polly.Generative` (AWS).
+      #
+      #   @return [String, nil]
+      optional :model_id, String
+
+      # @!attribute provider
+      #   TTS provider. Defaults to `telnyx` if not specified. Ignored when `voice` is
+      #   provided.
+      #
+      #   @return [Symbol, Telnyx::Models::TextToSpeechStreamParams::Provider, nil]
+      optional :provider, enum: -> { Telnyx::TextToSpeechStreamParams::Provider }
+
+      # @!attribute socket_id
+      #   Client-provided socket identifier for tracking. If not provided, one is
+      #   generated server-side.
+      #
+      #   @return [String, nil]
+      optional :socket_id, String
+
+      # @!attribute voice
+      #   Voice identifier in the format `provider.model_id.voice_id` or
+      #   `provider.voice_id` (e.g. `telnyx.NaturalHD.Telnyx_Alloy` or
+      #   `azure.en-US-AvaMultilingualNeural`). When provided, the `provider`, `model_id`,
+      #   and `voice_id` are extracted automatically. Takes precedence over individual
+      #   `provider`/`model_id`/`voice_id` parameters.
+      #
+      #   @return [String, nil]
+      optional :voice, String
+
+      # @!attribute voice_id
+      #   Voice identifier for the chosen provider.
+      #
+      #   @return [String, nil]
+      optional :voice_id, String
+
+      # @!method initialize(audio_format: nil, disable_cache: nil, model_id: nil, provider: nil, socket_id: nil, voice: nil, voice_id: nil, request_options: {})
+      #   Some parameter documentations has been truncated, see
+      #   {Telnyx::Models::TextToSpeechStreamParams} for more details.
+      #
+      #   @param audio_format [Symbol, Telnyx::Models::TextToSpeechStreamParams::AudioFormat] Audio output format override. Supported for Telnyx `Natural`/`NaturalHD` models
+      #
+      #   @param disable_cache [Boolean] When `true`, bypass the audio cache and generate fresh audio.
+      #
+      #   @param model_id [String] Model identifier for the chosen provider. Examples: `Natural`, `NaturalHD` (Teln
+      #
+      #   @param provider [Symbol, Telnyx::Models::TextToSpeechStreamParams::Provider] TTS provider. Defaults to `telnyx` if not specified. Ignored when `voice` is pro
+      #
+      #   @param socket_id [String] Client-provided socket identifier for tracking. If not provided, one is generate
+      #
+      #   @param voice [String] Voice identifier in the format `provider.model_id.voice_id` or `provider.voice_i
+      #
+      #   @param voice_id [String] Voice identifier for the chosen provider.
+      #
       #   @param request_options [Telnyx::RequestOptions, Hash{Symbol=>Object}]
+
+      # Audio output format override. Supported for Telnyx `Natural`/`NaturalHD` models
+      # only. Accepted values: `pcm`, `wav`.
+      module AudioFormat
+        extend Telnyx::Internal::Type::Enum
+
+        PCM = :pcm
+        WAV = :wav
+
+        # @!method self.values
+        #   @return [Array<Symbol>]
+      end
+
+      # TTS provider. Defaults to `telnyx` if not specified. Ignored when `voice` is
+      # provided.
+      module Provider
+        extend Telnyx::Internal::Type::Enum
+
+        AWS = :aws
+        TELNYX = :telnyx
+        AZURE = :azure
+        ELEVENLABS = :elevenlabs
+        MINIMAX = :minimax
+        MURFAI = :murfai
+        RIME = :rime
+        RESEMBLE = :resemble
+        INWORLD = :inworld
+
+        # @!method self.values
+        #   @return [Array<Symbol>]
+      end
     end
   end
 end

data/lib/telnyx/models.rb

@@ -1453,6 +1453,8 @@ module Telnyx
 
   SoundModifications = Telnyx::Models::SoundModifications
 
+  SpeechToTextTranscribeParams = Telnyx::Models::SpeechToTextTranscribeParams
+
   Storage = Telnyx::Models::Storage
 
   StorageListMigrationSourceCoverageParams = Telnyx::Models::StorageListMigrationSourceCoverageParams

data/lib/telnyx/resources/calls/actions.rb

@@ -526,6 +526,40 @@ module Telnyx
           )
         end
 
+        # Some parameter documentations has been truncated, see
+        # {Telnyx::Models::Calls::ActionJoinAIAssistantParams} for more details.
+        #
+        # Add a participant to an existing AI assistant conversation. Use this command to
+        # bring an additional call leg into a running AI conversation.
+        #
+        # @overload join_ai_assistant(call_control_id, conversation_id:, participant:, client_state: nil, command_id: nil, request_options: {})
+        #
+        # @param call_control_id [String] Unique identifier and token for controlling the call
+        #
+        # @param conversation_id [String] The ID of the AI assistant conversation to join.
+        #
+        # @param participant [Telnyx::Models::Calls::ActionJoinAIAssistantParams::Participant]
+        #
+        # @param client_state [String] Use this field to add state to every subsequent webhook. It must be a valid Base
+        #
+        # @param command_id [String] Use this field to avoid duplicate commands. Telnyx will ignore any command with
+        #
+        # @param request_options [Telnyx::RequestOptions, Hash{Symbol=>Object}, nil]
+        #
+        # @return [Telnyx::Models::Calls::ActionJoinAIAssistantResponse]
+        #
+        # @see Telnyx::Models::Calls::ActionJoinAIAssistantParams
+        def join_ai_assistant(call_control_id, params)
+          parsed, options = Telnyx::Calls::ActionJoinAIAssistantParams.dump_request(params)
+          @client.request(
+            method: :post,
+            path: ["calls/%1$s/actions/ai_assistant_join", call_control_id],
+            body: parsed,
+            model: Telnyx::Models::Calls::ActionJoinAIAssistantResponse,
+            options: options
+          )
+        end
+
         # Some parameter documentations has been truncated, see
         # {Telnyx::Models::Calls::ActionLeaveQueueParams} for more details.
         #

data/lib/telnyx/resources/speech_to_text.rb

@@ -0,0 +1,71 @@
+# frozen_string_literal: true
+
+module Telnyx
+  module Resources
+    # Speech to text command operations
+    class SpeechToText
+      # Some parameter documentations has been truncated, see
+      # {Telnyx::Models::SpeechToTextTranscribeParams} for more details.
+      #
+      # Open a WebSocket connection to stream audio and receive transcriptions in
+      # real-time. Authentication is provided via the standard
+      # `Authorization: Bearer <API_KEY>` header.
+      #
+      # Supported engines: `Azure`, `Deepgram`, `Google`, `Telnyx`.
+      #
+      # **Connection flow:**
+      #
+      # 1. Open WebSocket with query parameters specifying engine, input format, and
+      #    language.
+      # 2. Send binary audio frames (mp3/wav format).
+      # 3. Receive JSON transcript frames with `transcript`, `is_final`, and
+      #    `confidence` fields.
+      # 4. Close connection when done.
+      #
+      # @overload transcribe(input_format:, transcription_engine:, endpointing: nil, interim_results: nil, keyterm: nil, keywords: nil, language: nil, model: nil, redact: nil, request_options: {})
+      #
+      # @param input_format [Symbol, Telnyx::Models::SpeechToTextTranscribeParams::InputFormat] The format of input audio stream.
+      #
+      # @param transcription_engine [Symbol, Telnyx::Models::SpeechToTextTranscribeParams::TranscriptionEngine] The transcription engine to use for processing the audio stream.
+      #
+      # @param endpointing [Integer] Silence duration (in milliseconds) that triggers end-of-speech detection. When s
+      #
+      # @param interim_results [Boolean] Whether to receive interim transcription results.
+      #
+      # @param keyterm [String] A key term to boost in the transcription. The engine will be more likely to reco
+      #
+      # @param keywords [String] Comma-separated list of keywords to boost in the transcription. The engine will
+      #
+      # @param language [String] The language spoken in the audio stream.
+      #
+      # @param model [Symbol, Telnyx::Models::SpeechToTextTranscribeParams::Model] The specific model to use within the selected transcription engine.
+      #
+      # @param redact [String] Enable redaction of sensitive information (e.g., PCI data, SSN) from transcripti
+      #
+      # @param request_options [Telnyx::RequestOptions, Hash{Symbol=>Object}, nil]
+      #
+      # @return [nil]
+      #
+      # @see Telnyx::Models::SpeechToTextTranscribeParams
+      def transcribe(params)
+        parsed, options = Telnyx::SpeechToTextTranscribeParams.dump_request(params)
+        query = Telnyx::Internal::Util.encode_query_params(parsed)
+        @client.request(
+          method: :get,
+          path: "speech-to-text/transcription",
+          query: query,
+          headers: {"content-type" => "application/octet-stream"},
+          model: NilClass,
+          options: options
+        )
+      end
+
+      # @api private
+      #
+      # @param client [Telnyx::Client]
+      def initialize(client:)
+        @client = client
+      end
+    end
+  end
+end

data/lib/telnyx/resources/text_to_speech.rb

@@ -101,6 +101,63 @@ module Telnyx
         )
       end
 
+      # Some parameter documentations has been truncated, see
+      # {Telnyx::Models::TextToSpeechStreamParams} for more details.
+      #
+      # Open a WebSocket connection to stream text and receive synthesized audio in real
+      # time. Authentication is provided via the standard
+      # `Authorization: Bearer <API_KEY>` header. Send JSON frames with text to
+      # synthesize; receive JSON frames containing base64-encoded audio chunks.
+      #
+      # Supported providers: `aws`, `telnyx`, `azure`, `murfai`, `minimax`, `rime`,
+      # `resemble`, `elevenlabs`, `inworld`.
+      #
+      # **Connection flow:**
+      #
+      # 1. Open WebSocket with query parameters specifying provider, voice, and model.
+      # 2. Send an initial handshake message `{"text": " "}` (single space) with
+      #    optional `voice_settings` to initialize the session.
+      # 3. Send text messages as `{"text": "Hello world"}`.
+      # 4. Receive audio chunks as JSON frames with base64-encoded audio.
+      # 5. A final frame with `isFinal: true` indicates the end of audio for the current
+      #    text.
+      #
+      # To interrupt and restart synthesis mid-stream, send `{"force": true}` — the
+      # current worker is stopped and a new one is started.
+      #
+      # @overload stream(audio_format: nil, disable_cache: nil, model_id: nil, provider: nil, socket_id: nil, voice: nil, voice_id: nil, request_options: {})
+      #
+      # @param audio_format [Symbol, Telnyx::Models::TextToSpeechStreamParams::AudioFormat] Audio output format override. Supported for Telnyx `Natural`/`NaturalHD` models
+      #
+      # @param disable_cache [Boolean] When `true`, bypass the audio cache and generate fresh audio.
+      #
+      # @param model_id [String] Model identifier for the chosen provider. Examples: `Natural`, `NaturalHD` (Teln
+      #
+      # @param provider [Symbol, Telnyx::Models::TextToSpeechStreamParams::Provider] TTS provider. Defaults to `telnyx` if not specified. Ignored when `voice` is pro
+      #
+      # @param socket_id [String] Client-provided socket identifier for tracking. If not provided, one is generate
+      #
+      # @param voice [String] Voice identifier in the format `provider.model_id.voice_id` or `provider.voice_i
+      #
+      # @param voice_id [String] Voice identifier for the chosen provider.
+      #
+      # @param request_options [Telnyx::RequestOptions, Hash{Symbol=>Object}, nil]
+      #
+      # @return [nil]
+      #
+      # @see Telnyx::Models::TextToSpeechStreamParams
+      def stream(params = {})
+        parsed, options = Telnyx::TextToSpeechStreamParams.dump_request(params)
+        query = Telnyx::Internal::Util.encode_query_params(parsed)
+        @client.request(
+          method: :get,
+          path: "text-to-speech/speech",
+          query: query,
+          model: NilClass,
+          options: options
+        )
+      end
+
       # @api private
       #
       # @param client [Telnyx::Client]

data/lib/telnyx/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Telnyx
-  VERSION = "5.55.0"
+  VERSION = "5.56.0"
 end

data/lib/telnyx.rb

@@ -534,6 +534,8 @@ require_relative "telnyx/models/calls/action_gather_using_speak_params"
 require_relative "telnyx/models/calls/action_gather_using_speak_response"
 require_relative "telnyx/models/calls/action_hangup_params"
 require_relative "telnyx/models/calls/action_hangup_response"
+require_relative "telnyx/models/calls/action_join_ai_assistant_params"
+require_relative "telnyx/models/calls/action_join_ai_assistant_response"
 require_relative "telnyx/models/calls/action_leave_queue_params"
 require_relative "telnyx/models/calls/action_leave_queue_response"
 require_relative "telnyx/models/calls/action_pause_recording_params"
@@ -1949,6 +1951,7 @@ require_relative "telnyx/models/siprec_connector_retrieve_response"
 require_relative "telnyx/models/siprec_connector_update_params"
 require_relative "telnyx/models/siprec_connector_update_response"
 require_relative "telnyx/models/sound_modifications"
+require_relative "telnyx/models/speech_to_text_transcribe_params"
 require_relative "telnyx/models/storage/bucket_create_presigned_url_params"
 require_relative "telnyx/models/storage/bucket_create_presigned_url_response"
 require_relative "telnyx/models/storage/buckets/ssl_certificate"
@@ -1985,9 +1988,7 @@ require_relative "telnyx/models/stream_bidirectional_codec"
 require_relative "telnyx/models/stream_bidirectional_mode"
 require_relative "telnyx/models/stream_bidirectional_sampling_rate"
 require_relative "telnyx/models/stream_bidirectional_target_legs"
-require_relative "telnyx/models/stream_client_event"
 require_relative "telnyx/models/stream_codec"
-require_relative "telnyx/models/stream_server_event"
 require_relative "telnyx/models/sub_number_order"
 require_relative "telnyx/models/sub_number_order_cancel_params"
 require_relative "telnyx/models/sub_number_order_cancel_response"
@@ -2541,6 +2542,7 @@ require_relative "telnyx/resources/sim_card_orders"
 require_relative "telnyx/resources/sim_cards"
 require_relative "telnyx/resources/sim_cards/actions"
 require_relative "telnyx/resources/siprec_connectors"
+require_relative "telnyx/resources/speech_to_text"
 require_relative "telnyx/resources/storage"
 require_relative "telnyx/resources/storage/buckets"
 require_relative "telnyx/resources/storage/buckets/ssl_certificate"