telnyx 5.43.0 → 5.44.0

package/src/resources/text-to-speech.ts

@@ -6,6 +6,19 @@ import { buildHeaders } from '../internal/headers';
 import { RequestOptions } from '../internal/request-options';
 
 export class TextToSpeech extends APIResource {
+  /**
+   * Converts the provided text to speech using the specified voice and returns audio
+   * data
+   */
+  generateSpeech(body: TextToSpeechGenerateSpeechParams, options?: RequestOptions): APIPromise<Response> {
+    return this._client.post('/text-to-speech/speech', {
+      body,
+      ...options,
+      headers: buildHeaders([{ Accept: 'audio/mpeg' }, options?.headers]),
+      __binaryResponse: true,
+    });
+  }
+
   /**
    * Returns a list of voices that can be used with the text to speech commands.
    */
@@ -15,39 +28,6 @@ export class TextToSpeech extends APIResource {
   ): APIPromise<TextToSpeechListVoicesResponse> {
     return this._client.get('/text-to-speech/voices', { query, ...options });
   }
-
-  /**
-   * 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`.
-   *
-   * **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.
-   */
-  stream(
-    query: TextToSpeechStreamParams | null | undefined = {},
-    options?: RequestOptions,
-  ): APIPromise<void> {
-    return this._client.get('/text-to-speech/speech', {
-      query,
-      ...options,
-      headers: buildHeaders([{ Accept: '*/*' }, options?.headers]),
-    });
-  }
 }
 
 export interface TextToSpeechListVoicesResponse {
@@ -74,67 +54,44 @@ export namespace TextToSpeechListVoicesResponse {
   }
 }
 
-export interface TextToSpeechListVoicesParams {
+export interface TextToSpeechGenerateSpeechParams {
   /**
-   * Reference to your ElevenLabs API key stored in the Telnyx Portal
+   * The text to convert to speech
    */
-  elevenlabs_api_key_ref?: string;
+  text: string;
 
   /**
-   * Filter voices by provider
+   * The voice ID in the format Provider.ModelId.VoiceId.
+   *
+   * Examples:
+   *
+   * - AWS.Polly.Joanna-Neural
+   * - Azure.en-US-AvaMultilingualNeural
+   * - ElevenLabs.eleven_multilingual_v2.Rachel
+   * - Telnyx.KokoroTTS.af
+   *
+   * Use the `GET /text-to-speech/voices` endpoint to get a complete list of
+   * available voices.
    */
-  provider?: 'aws' | 'azure' | 'elevenlabs' | 'telnyx';
+  voice: string;
 }
 
-export interface TextToSpeechStreamParams {
-  /**
-   * Audio output format override. Supported for Telnyx `Natural`/`NaturalHD` models
-   * only. Accepted values: `pcm`, `wav`.
-   */
-  audio_format?: 'pcm' | 'wav';
-
-  /**
-   * When `true`, bypass the audio cache and generate fresh audio.
-   */
-  disable_cache?: boolean;
-
-  /**
-   * Model identifier for the chosen provider. Examples: `Natural`, `NaturalHD`
-   * (Telnyx); `Polly.Generative` (AWS).
-   */
-  model_id?: string;
-
-  /**
-   * TTS provider. Defaults to `telnyx` if not specified. Ignored when `voice` is
-   * provided.
-   */
-  provider?: 'aws' | 'telnyx' | 'azure' | 'elevenlabs' | 'minimax' | 'murfai' | 'rime' | 'resemble';
-
-  /**
-   * Client-provided socket identifier for tracking. If not provided, one is
-   * generated server-side.
-   */
-  socket_id?: string;
-
+export interface TextToSpeechListVoicesParams {
   /**
-   * 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.
+   * Reference to your ElevenLabs API key stored in the Telnyx Portal
    */
-  voice?: string;
+  elevenlabs_api_key_ref?: string;
 
   /**
-   * Voice identifier for the chosen provider.
+   * Filter voices by provider
    */
-  voice_id?: string;
+  provider?: 'aws' | 'azure' | 'elevenlabs' | 'telnyx';
 }
 
 export declare namespace TextToSpeech {
   export {
     type TextToSpeechListVoicesResponse as TextToSpeechListVoicesResponse,
+    type TextToSpeechGenerateSpeechParams as TextToSpeechGenerateSpeechParams,
     type TextToSpeechListVoicesParams as TextToSpeechListVoicesParams,
-    type TextToSpeechStreamParams as TextToSpeechStreamParams,
   };
 }

package/src/version.ts

@@ -1 +1 @@
-export const VERSION = '5.43.0'; // x-release-please-version
+export const VERSION = '5.44.0'; // x-release-please-version

package/version.d.mts

@@ -1,2 +1,2 @@
-export declare const VERSION = "5.43.0";
+export declare const VERSION = "5.44.0";
 //# sourceMappingURL=version.d.mts.map

package/version.d.ts

@@ -1,2 +1,2 @@
-export declare const VERSION = "5.43.0";
+export declare const VERSION = "5.44.0";
 //# sourceMappingURL=version.d.ts.map

package/version.js

@@ -1,5 +1,5 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.VERSION = void 0;
-exports.VERSION = '5.43.0'; // x-release-please-version
+exports.VERSION = '5.44.0'; // x-release-please-version
 //# sourceMappingURL=version.js.map

package/version.mjs

@@ -1,2 +1,2 @@
-export const VERSION = '5.43.0'; // x-release-please-version
+export const VERSION = '5.44.0'; // x-release-please-version
 //# sourceMappingURL=version.mjs.map