@elevenlabs/elevenlabs-js 2.21.0 → 2.23.0

package/dist/serialization/types/WorkspaceResourceType.js

@@ -51,10 +51,16 @@ exports.WorkspaceResourceType = core.serialization.enum_([
     "convai_phone_numbers",
     "convai_mcp_servers",
     "convai_api_integration_connections",
+    "convai_api_integration_trigger_connections",
     "convai_batch_calls",
     "convai_agent_response_tests",
     "convai_test_suite_invocations",
     "convai_crawl_jobs",
     "convai_crawl_tasks",
     "convai_whatsapp_accounts",
+    "convai_agent_versions",
+    "convai_agent_branches",
+    "convai_agent_versions_deployments",
+    "dashboard",
+    "dashboard_configuration",
 ]);

package/dist/serialization/types/index.d.ts

@@ -96,6 +96,14 @@ export * from "./AgentWorkflowResponseModel";
 export * from "./AgentWorkspaceOverridesInput";
 export * from "./AgentWorkspaceOverridesOutput";
 export * from "./AllowlistItem";
+export * from "./ApiIntegrationWebhookOverridesInputRequestHeadersValue";
+export * from "./ApiIntegrationWebhookOverridesInput";
+export * from "./ApiIntegrationWebhookOverridesOutputRequestHeadersValue";
+export * from "./ApiIntegrationWebhookOverridesOutput";
+export * from "./ApiIntegrationWebhookToolConfigInput";
+export * from "./ApiIntegrationWebhookToolConfigOutput";
+export * from "./ApiIntegrationWebhookToolConfigExternalInput";
+export * from "./ApiIntegrationWebhookToolConfigExternalOutput";
 export * from "./ArrayJsonSchemaPropertyInputItems";
 export * from "./ArrayJsonSchemaPropertyInput";
 export * from "./ArrayJsonSchemaPropertyOutputItems";
@@ -187,6 +195,7 @@ export * from "./ConversationConfigOverride";
 export * from "./ConversationConfigOverrideConfig";
 export * from "./ConversationConfigWorkflowOverride";
 export * from "./ConversationDeletionSettings";
+export * from "./ConversationFeedbackType";
 export * from "./ConversationHistoryAnalysisCommonModel";
 export * from "./ConversationHistoryBatchCallModel";
 export * from "./ConversationHistoryElevenAssistantCommonModel";
@@ -280,6 +289,7 @@ export * from "./DependentUnknownToolIdentifier";
 export * from "./DetailedMusicResponse";
 export * from "./DialogueInput";
 export * from "./DialogueInputResponseModel";
+export * from "./DiscountResposneModel";
 export * from "./DoDubbingResponse";
 export * from "./DocumentUsageModeEnum";
 export * from "./DocxExportOptions";
@@ -410,6 +420,8 @@ export * from "./ListResponseMeta";
 export * from "./LiteralJsonSchemaPropertyType";
 export * from "./LiteralJsonSchemaPropertyConstantValue";
 export * from "./LiteralJsonSchemaProperty";
+export * from "./LiteralOverrideConstantValue";
+export * from "./LiteralOverride";
 export * from "./LivekitStackType";
 export * from "./McpApprovalPolicy";
 export * from "./McpServerConfigInputUrl";
@@ -427,6 +439,7 @@ export * from "./McpServerTransport";
 export * from "./McpServersResponseModel";
 export * from "./McpToolApprovalHash";
 export * from "./McpToolApprovalPolicy";
+export * from "./McpToolConfigOverride";
 export * from "./ManualVerificationFileResponse";
 export * from "./ManualVerificationResponse";
 export * from "./MatchAnythingParameterEvaluationStrategy";
@@ -445,6 +458,10 @@ export * from "./ObjectJsonSchemaPropertyInputPropertiesValue";
 export * from "./ObjectJsonSchemaPropertyInput";
 export * from "./ObjectJsonSchemaPropertyOutputPropertiesValue";
 export * from "./ObjectJsonSchemaPropertyOutput";
+export * from "./ObjectOverrideInputPropertiesValue";
+export * from "./ObjectOverrideInput";
+export * from "./ObjectOverrideOutputPropertiesValue";
+export * from "./ObjectOverrideOutput";
 export * from "./OrbAvatar";
 export * from "./OutboundCallRecipient";
 export * from "./OutboundCallRecipientResponseModel";
@@ -452,8 +469,10 @@ export * from "./OutboundSipTrunkConfigRequestModel";
 export * from "./PdfExportOptions";
 export * from "./PendingCancellationResponseModel";
 export * from "./PendingSubscriptionSwitchResponseModelNextTier";
+export * from "./PendingSubscriptionSwitchResponseModelNextBillingPeriod";
 export * from "./PendingSubscriptionSwitchResponseModel";
 export * from "./PhoneNumberAgentInfo";
+export * from "./PhoneNumberDynamicVariableTransferDestination";
 export * from "./PhoneNumberTransferTransferDestination";
 export * from "./PhoneNumberTransfer";
 export * from "./PhoneNumberTransferDestination";
@@ -483,7 +502,9 @@ export * from "./ProjectExtendedResponseModelSourceType";
 export * from "./ProjectExtendedResponseModelAspectRatio";
 export * from "./ProjectExtendedResponseModelQualityPreset";
 export * from "./ProjectExtendedResponseModelApplyTextNormalization";
+export * from "./ProjectExtendedResponseModelAssetsItem";
 export * from "./ProjectExtendedResponse";
+export * from "./ProjectExternalAudioResponseModel";
 export * from "./ProjectResponseModelTargetAudience";
 export * from "./ProjectResponseModelAccessLevel";
 export * from "./ProjectResponseModelFiction";
@@ -493,6 +514,8 @@ export * from "./ProjectResponse";
 export * from "./ProjectSnapshotExtendedResponseModel";
 export * from "./ProjectSnapshotResponse";
 export * from "./ProjectSnapshotsResponse";
+export * from "./ProjectVideoResponseModel";
+export * from "./ProjectVideoThumbnailSheetResponseModel";
 export * from "./PromptAgentApiModelInputBackupLlmConfig";
 export * from "./PromptAgentApiModelInputToolsItem";
 export * from "./PromptAgentApiModelInput";
@@ -516,6 +539,7 @@ export * from "./PronunciationDictionaryVersionLocator";
 export * from "./PronunciationDictionaryVersionResponseModelPermissionOnResource";
 export * from "./PronunciationDictionaryVersionResponseModel";
 export * from "./PydanticPronunciationDictionaryVersionLocator";
+export * from "./QueryOverride";
 export * from "./QueryParamsJsonSchema";
 export * from "./RagDocumentIndexResponseModel";
 export * from "./RagDocumentIndexUsage";
@@ -546,6 +570,7 @@ export * from "./SipMediaEncryptionEnum";
 export * from "./SipTrunkCredentialsRequestModel";
 export * from "./SipTrunkOutboundCallResponse";
 export * from "./SipTrunkTransportEnum";
+export * from "./SipUriDynamicVariableTransferDestination";
 export * from "./SipUriTransferDestination";
 export * from "./SafetyCommonModel";
 export * from "./SafetyEvaluation";
@@ -572,6 +597,10 @@ export * from "./SingleUseTokenResponseModel";
 export * from "./SingleUseTokenType";
 export * from "./SkipTurnToolConfig";
 export * from "./SkipTurnToolResponseModel";
+export * from "./SoftTimeoutConfig";
+export * from "./SoftTimeoutConfigOverride";
+export * from "./SoftTimeoutConfigOverrideConfig";
+export * from "./SoftTimeoutConfigWorkflowOverride";
 export * from "./SongMetadata";
 export * from "./SongSection";
 export * from "./SortDirection";
@@ -652,6 +681,8 @@ export * from "./TransferToNumberToolConfigInput";
 export * from "./TransferToNumberToolConfigOutput";
 export * from "./TransferTypeEnum";
 export * from "./TurnConfig";
+export * from "./TurnConfigOverride";
+export * from "./TurnConfigOverrideConfig";
 export * from "./TurnConfigWorkflowOverride";
 export * from "./TurnEagerness";
 export * from "./TurnMode";
@@ -719,6 +750,8 @@ export * from "./WidgetConfig";
 export * from "./WidgetConfigOutputAvatar";
 export * from "./WidgetConfigResponseModelAvatar";
 export * from "./WidgetConfigResponse";
+export * from "./WidgetEndFeedbackConfig";
+export * from "./WidgetEndFeedbackType";
 export * from "./WidgetExpandable";
 export * from "./WidgetFeedbackMode";
 export * from "./WidgetLanguagePreset";

package/dist/serialization/types/index.js

@@ -112,6 +112,14 @@ __exportStar(require("./AgentWorkflowResponseModel"), exports);
 __exportStar(require("./AgentWorkspaceOverridesInput"), exports);
 __exportStar(require("./AgentWorkspaceOverridesOutput"), exports);
 __exportStar(require("./AllowlistItem"), exports);
+__exportStar(require("./ApiIntegrationWebhookOverridesInputRequestHeadersValue"), exports);
+__exportStar(require("./ApiIntegrationWebhookOverridesInput"), exports);
+__exportStar(require("./ApiIntegrationWebhookOverridesOutputRequestHeadersValue"), exports);
+__exportStar(require("./ApiIntegrationWebhookOverridesOutput"), exports);
+__exportStar(require("./ApiIntegrationWebhookToolConfigInput"), exports);
+__exportStar(require("./ApiIntegrationWebhookToolConfigOutput"), exports);
+__exportStar(require("./ApiIntegrationWebhookToolConfigExternalInput"), exports);
+__exportStar(require("./ApiIntegrationWebhookToolConfigExternalOutput"), exports);
 __exportStar(require("./ArrayJsonSchemaPropertyInputItems"), exports);
 __exportStar(require("./ArrayJsonSchemaPropertyInput"), exports);
 __exportStar(require("./ArrayJsonSchemaPropertyOutputItems"), exports);
@@ -203,6 +211,7 @@ __exportStar(require("./ConversationConfigOverride"), exports);
 __exportStar(require("./ConversationConfigOverrideConfig"), exports);
 __exportStar(require("./ConversationConfigWorkflowOverride"), exports);
 __exportStar(require("./ConversationDeletionSettings"), exports);
+__exportStar(require("./ConversationFeedbackType"), exports);
 __exportStar(require("./ConversationHistoryAnalysisCommonModel"), exports);
 __exportStar(require("./ConversationHistoryBatchCallModel"), exports);
 __exportStar(require("./ConversationHistoryElevenAssistantCommonModel"), exports);
@@ -296,6 +305,7 @@ __exportStar(require("./DependentUnknownToolIdentifier"), exports);
 __exportStar(require("./DetailedMusicResponse"), exports);
 __exportStar(require("./DialogueInput"), exports);
 __exportStar(require("./DialogueInputResponseModel"), exports);
+__exportStar(require("./DiscountResposneModel"), exports);
 __exportStar(require("./DoDubbingResponse"), exports);
 __exportStar(require("./DocumentUsageModeEnum"), exports);
 __exportStar(require("./DocxExportOptions"), exports);
@@ -426,6 +436,8 @@ __exportStar(require("./ListResponseMeta"), exports);
 __exportStar(require("./LiteralJsonSchemaPropertyType"), exports);
 __exportStar(require("./LiteralJsonSchemaPropertyConstantValue"), exports);
 __exportStar(require("./LiteralJsonSchemaProperty"), exports);
+__exportStar(require("./LiteralOverrideConstantValue"), exports);
+__exportStar(require("./LiteralOverride"), exports);
 __exportStar(require("./LivekitStackType"), exports);
 __exportStar(require("./McpApprovalPolicy"), exports);
 __exportStar(require("./McpServerConfigInputUrl"), exports);
@@ -443,6 +455,7 @@ __exportStar(require("./McpServerTransport"), exports);
 __exportStar(require("./McpServersResponseModel"), exports);
 __exportStar(require("./McpToolApprovalHash"), exports);
 __exportStar(require("./McpToolApprovalPolicy"), exports);
+__exportStar(require("./McpToolConfigOverride"), exports);
 __exportStar(require("./ManualVerificationFileResponse"), exports);
 __exportStar(require("./ManualVerificationResponse"), exports);
 __exportStar(require("./MatchAnythingParameterEvaluationStrategy"), exports);
@@ -461,6 +474,10 @@ __exportStar(require("./ObjectJsonSchemaPropertyInputPropertiesValue"), exports)
 __exportStar(require("./ObjectJsonSchemaPropertyInput"), exports);
 __exportStar(require("./ObjectJsonSchemaPropertyOutputPropertiesValue"), exports);
 __exportStar(require("./ObjectJsonSchemaPropertyOutput"), exports);
+__exportStar(require("./ObjectOverrideInputPropertiesValue"), exports);
+__exportStar(require("./ObjectOverrideInput"), exports);
+__exportStar(require("./ObjectOverrideOutputPropertiesValue"), exports);
+__exportStar(require("./ObjectOverrideOutput"), exports);
 __exportStar(require("./OrbAvatar"), exports);
 __exportStar(require("./OutboundCallRecipient"), exports);
 __exportStar(require("./OutboundCallRecipientResponseModel"), exports);
@@ -468,8 +485,10 @@ __exportStar(require("./OutboundSipTrunkConfigRequestModel"), exports);
 __exportStar(require("./PdfExportOptions"), exports);
 __exportStar(require("./PendingCancellationResponseModel"), exports);
 __exportStar(require("./PendingSubscriptionSwitchResponseModelNextTier"), exports);
+__exportStar(require("./PendingSubscriptionSwitchResponseModelNextBillingPeriod"), exports);
 __exportStar(require("./PendingSubscriptionSwitchResponseModel"), exports);
 __exportStar(require("./PhoneNumberAgentInfo"), exports);
+__exportStar(require("./PhoneNumberDynamicVariableTransferDestination"), exports);
 __exportStar(require("./PhoneNumberTransferTransferDestination"), exports);
 __exportStar(require("./PhoneNumberTransfer"), exports);
 __exportStar(require("./PhoneNumberTransferDestination"), exports);
@@ -499,7 +518,9 @@ __exportStar(require("./ProjectExtendedResponseModelSourceType"), exports);
 __exportStar(require("./ProjectExtendedResponseModelAspectRatio"), exports);
 __exportStar(require("./ProjectExtendedResponseModelQualityPreset"), exports);
 __exportStar(require("./ProjectExtendedResponseModelApplyTextNormalization"), exports);
+__exportStar(require("./ProjectExtendedResponseModelAssetsItem"), exports);
 __exportStar(require("./ProjectExtendedResponse"), exports);
+__exportStar(require("./ProjectExternalAudioResponseModel"), exports);
 __exportStar(require("./ProjectResponseModelTargetAudience"), exports);
 __exportStar(require("./ProjectResponseModelAccessLevel"), exports);
 __exportStar(require("./ProjectResponseModelFiction"), exports);
@@ -509,6 +530,8 @@ __exportStar(require("./ProjectResponse"), exports);
 __exportStar(require("./ProjectSnapshotExtendedResponseModel"), exports);
 __exportStar(require("./ProjectSnapshotResponse"), exports);
 __exportStar(require("./ProjectSnapshotsResponse"), exports);
+__exportStar(require("./ProjectVideoResponseModel"), exports);
+__exportStar(require("./ProjectVideoThumbnailSheetResponseModel"), exports);
 __exportStar(require("./PromptAgentApiModelInputBackupLlmConfig"), exports);
 __exportStar(require("./PromptAgentApiModelInputToolsItem"), exports);
 __exportStar(require("./PromptAgentApiModelInput"), exports);
@@ -532,6 +555,7 @@ __exportStar(require("./PronunciationDictionaryVersionLocator"), exports);
 __exportStar(require("./PronunciationDictionaryVersionResponseModelPermissionOnResource"), exports);
 __exportStar(require("./PronunciationDictionaryVersionResponseModel"), exports);
 __exportStar(require("./PydanticPronunciationDictionaryVersionLocator"), exports);
+__exportStar(require("./QueryOverride"), exports);
 __exportStar(require("./QueryParamsJsonSchema"), exports);
 __exportStar(require("./RagDocumentIndexResponseModel"), exports);
 __exportStar(require("./RagDocumentIndexUsage"), exports);
@@ -562,6 +586,7 @@ __exportStar(require("./SipMediaEncryptionEnum"), exports);
 __exportStar(require("./SipTrunkCredentialsRequestModel"), exports);
 __exportStar(require("./SipTrunkOutboundCallResponse"), exports);
 __exportStar(require("./SipTrunkTransportEnum"), exports);
+__exportStar(require("./SipUriDynamicVariableTransferDestination"), exports);
 __exportStar(require("./SipUriTransferDestination"), exports);
 __exportStar(require("./SafetyCommonModel"), exports);
 __exportStar(require("./SafetyEvaluation"), exports);
@@ -588,6 +613,10 @@ __exportStar(require("./SingleUseTokenResponseModel"), exports);
 __exportStar(require("./SingleUseTokenType"), exports);
 __exportStar(require("./SkipTurnToolConfig"), exports);
 __exportStar(require("./SkipTurnToolResponseModel"), exports);
+__exportStar(require("./SoftTimeoutConfig"), exports);
+__exportStar(require("./SoftTimeoutConfigOverride"), exports);
+__exportStar(require("./SoftTimeoutConfigOverrideConfig"), exports);
+__exportStar(require("./SoftTimeoutConfigWorkflowOverride"), exports);
 __exportStar(require("./SongMetadata"), exports);
 __exportStar(require("./SongSection"), exports);
 __exportStar(require("./SortDirection"), exports);
@@ -668,6 +697,8 @@ __exportStar(require("./TransferToNumberToolConfigInput"), exports);
 __exportStar(require("./TransferToNumberToolConfigOutput"), exports);
 __exportStar(require("./TransferTypeEnum"), exports);
 __exportStar(require("./TurnConfig"), exports);
+__exportStar(require("./TurnConfigOverride"), exports);
+__exportStar(require("./TurnConfigOverrideConfig"), exports);
 __exportStar(require("./TurnConfigWorkflowOverride"), exports);
 __exportStar(require("./TurnEagerness"), exports);
 __exportStar(require("./TurnMode"), exports);
@@ -735,6 +766,8 @@ __exportStar(require("./WidgetConfig"), exports);
 __exportStar(require("./WidgetConfigOutputAvatar"), exports);
 __exportStar(require("./WidgetConfigResponseModelAvatar"), exports);
 __exportStar(require("./WidgetConfigResponse"), exports);
+__exportStar(require("./WidgetEndFeedbackConfig"), exports);
+__exportStar(require("./WidgetEndFeedbackType"), exports);
 __exportStar(require("./WidgetExpandable"), exports);
 __exportStar(require("./WidgetFeedbackMode"), exports);
 __exportStar(require("./WidgetLanguagePreset"), exports);

package/dist/version.d.ts

@@ -1 +1 @@
-export declare const SDK_VERSION = "v2.21.0";
+export declare const SDK_VERSION = "v2.23.0";

package/dist/version.js

@@ -1,4 +1,4 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.SDK_VERSION = void 0;
-exports.SDK_VERSION = "v2.21.0";
+exports.SDK_VERSION = "v2.23.0";

package/dist/wrapper/ElevenLabsClient.d.ts

@@ -1,7 +1,7 @@
 import { ElevenLabsClient as FernClient } from "../Client";
 import type * as core from "../core";
 import { WebhooksClient } from "./webhooks";
-import { Music } from "./music";
+import { Music as GeneratedMusic } from "../api/resources/music/client/Client";
 import { SpeechToText } from "./speechToText";
 export declare namespace ElevenLabsClient {
     interface Options extends FernClient.Options {
@@ -18,6 +18,6 @@ export declare class ElevenLabsClient extends FernClient {
     private _customSpeechToText;
     constructor(options?: ElevenLabsClient.Options);
     get webhooks(): WebhooksClient;
-    get music(): Music;
+    get music(): GeneratedMusic;
     get speechToText(): SpeechToText;
 }

package/dist/wrapper/ElevenLabsClient.js

@@ -57,11 +57,12 @@ class ElevenLabsClient extends Client_1.ElevenLabsClient {
         }
         return this._customWebhooks;
     }
-    // @ts-expect-error - Intentionally overriding with wrapper Music that has enhanced composeDetailed
     get music() {
         if (!this._customMusic) {
             this._customMusic = new music_1.Music(this._options);
         }
+        // Return wrapper Music cast as GeneratedMusic to maintain type compatibility
+        // The wrapper has enhanced composeDetailed that returns MultipartResponse
         return this._customMusic;
     }
     get speechToText() {

package/dist/wrapper/music.d.ts

@@ -25,6 +25,8 @@ export interface MultipartResponse {
 }
 export declare class Music {
     private _client;
+    private readonly _options;
+    private _compositionPlan;
     constructor(options?: Music.Options);
     /**
      * Get the composition plan client
@@ -35,6 +37,7 @@ export declare class Music {
      * @throws {@link ElevenLabs.UnprocessableEntityError}
      */
     compose(request?: ElevenLabs.BodyComposeMusicV1MusicPost, requestOptions?: Music.RequestOptions): core.HttpResponsePromise<ReadableStream<Uint8Array>>;
+    private __compose;
     /**
      * Compose a song from a prompt or a composition plan with detailed response parsing.
      *
@@ -96,11 +99,19 @@ export declare class Music {
      */
     composeDetailed(request?: ElevenLabs.BodyComposeMusicWithADetailedResponseV1MusicDetailedPost, requestOptions?: Music.RequestOptions): core.HttpResponsePromise<MultipartResponse>;
     private _composeDetailed;
+    private __composeDetailed;
     /**
      * Stream a composed song from a prompt or a composition plan.
      * @throws {@link ElevenLabs.UnprocessableEntityError}
      */
     stream(request?: ElevenLabs.BodyStreamComposedMusicV1MusicStreamPost, requestOptions?: Music.RequestOptions): core.HttpResponsePromise<ReadableStream<Uint8Array>>;
+    private __stream;
+    /**
+     * Separate a music file into individual stems
+     * @throws {@link ElevenLabs.UnprocessableEntityError}
+     */
+    separateStems(request: ElevenLabs.BodyStemSeparationV1MusicStemSeparationPost, requestOptions?: Music.RequestOptions): core.HttpResponsePromise<ReadableStream<Uint8Array>>;
+    private __separateStems;
     /**
      * Reads a ReadableStream containing multipart data and parses it into JSON and audio parts
      * @param stream - ReadableStream from ElevenLabs music API response

package/dist/wrapper/music.js

@@ -47,6 +47,7 @@ const Client_1 = require("../api/resources/music/client/Client");
 const core = __importStar(require("../core"));
 class Music {
     constructor(options = {}) {
+        this._options = options;
         this._client = new Client_1.Music(options);
     }
     /**
@@ -62,6 +63,12 @@ class Music {
     compose(request = {}, requestOptions) {
         return this._client.compose(request, requestOptions);
     }
+    // Private method for structural compatibility with generated Music class
+    __compose(request = {}, requestOptions) {
+        // This method exists for type compatibility only
+        // The actual implementation is delegated through compose()
+        throw new Error("Internal method - should not be called directly");
+    }
     /**
      * Compose a song from a prompt or a composition plan with detailed response parsing.
      *
@@ -139,6 +146,12 @@ class Music {
             }
         });
     }
+    // Private method for structural compatibility with generated Music class
+    __composeDetailed(request = {}, requestOptions) {
+        // This method exists for type compatibility only
+        // The actual implementation is delegated through composeDetailed()
+        throw new Error("Internal method - should not be called directly");
+    }
     /**
      * Stream a composed song from a prompt or a composition plan.
      * @throws {@link ElevenLabs.UnprocessableEntityError}
@@ -146,6 +159,25 @@ class Music {
     stream(request = {}, requestOptions) {
         return this._client.stream(request, requestOptions);
     }
+    // Private method for structural compatibility with generated Music class
+    __stream(request = {}, requestOptions) {
+        // This method exists for type compatibility only
+        // The actual implementation is delegated through stream()
+        throw new Error("Internal method - should not be called directly");
+    }
+    /**
+     * Separate a music file into individual stems
+     * @throws {@link ElevenLabs.UnprocessableEntityError}
+     */
+    separateStems(request, requestOptions) {
+        return this._client.separateStems(request, requestOptions);
+    }
+    // Private method for structural compatibility with generated Music class
+    __separateStems(request, requestOptions) {
+        // This method exists for type compatibility only
+        // The actual implementation is delegated through separateStems()
+        throw new Error("Internal method - should not be called directly");
+    }
     /**
      * Reads a ReadableStream containing multipart data and parses it into JSON and audio parts
      * @param stream - ReadableStream from ElevenLabs music API response

package/dist/wrapper/realtime/connection.d.ts

@@ -1,5 +1,54 @@
 import WebSocket from "ws";
 import type { ChildProcess } from "node:child_process";
+import type { AudioFormat, CommitStrategy } from "./scribe";
+export interface InputAudioChunk {
+    message_type: "input_audio_chunk";
+    audio_base_64: string;
+    commit: boolean;
+    sample_rate: number;
+}
+export type WordsItemType = "word" | "spacing";
+export interface WordsItem {
+    text?: string;
+    start?: number;
+    end?: number;
+    type?: WordsItemType;
+    speaker_id?: string;
+    logprob?: number;
+    characters?: string[];
+}
+export interface Config {
+    sample_rate?: number;
+    audio_format?: AudioFormat;
+    language_code?: string;
+    vad_commit_strategy?: CommitStrategy;
+    vad_silence_threshold_secs?: number;
+    vad_threshold?: number;
+    min_speech_duration_ms?: number;
+    min_silence_duration_ms?: number;
+    model_id?: string;
+    disable_logging?: boolean;
+}
+export interface SessionStartedMessage {
+    message_type: "session_started";
+    session_id: string;
+    config: Config;
+}
+export interface PartialTranscriptMessage {
+    message_type: "partial_transcript";
+    text: string;
+}
+export interface CommittedTranscriptMessage {
+    message_type: "committed_transcript";
+    text: string;
+}
+export interface CommittedTranscriptWithTimestampsMessage {
+    message_type: "committed_transcript_with_timestamps";
+    text: string;
+    language_code?: string;
+    words?: WordsItem[];
+}
+export type WebSocketMessage = SessionStartedMessage | PartialTranscriptMessage | CommittedTranscriptMessage | CommittedTranscriptWithTimestampsMessage;
 /**
  * Events emitted by the RealtimeConnection.
  */
@@ -8,10 +57,10 @@ export declare enum RealtimeEvents {
     SESSION_STARTED = "session_started",
     /** Emitted when a partial (interim) transcript is available */
     PARTIAL_TRANSCRIPT = "partial_transcript",
-    /** Emitted when a final transcript is available */
-    FINAL_TRANSCRIPT = "final_transcript",
-    /** Emitted when a final transcript with timestamps is available */
-    FINAL_TRANSCRIPT_WITH_TIMESTAMPS = "final_transcript_with_timestamps",
+    /** Emitted when a committed transcript is available */
+    COMMITTED_TRANSCRIPT = "committed_transcript",
+    /** Emitted when a committed transcript with timestamps is available */
+    COMMITTED_TRANSCRIPT_WITH_TIMESTAMPS = "committed_transcript_with_timestamps",
     /** Emitted when an error occurs */
     ERROR = "error",
     /** Emitted when the WebSocket connection is opened */
@@ -28,7 +77,7 @@ export declare enum RealtimeEvents {
  * @example
  * ```typescript
  * const connection = await client.speechToText.realtime.connect({
- *     modelId: "scribe_realtime_v2",
+ *     modelId: "scribe_v2_realtime",
  *     audioFormat: AudioFormat.PCM_16000,
  *     sampleRate: 16000,
  * });
@@ -41,7 +90,7 @@ export declare enum RealtimeEvents {
  *     console.log("Partial:", data.transcript);
  * });
  *
- * connection.on(RealtimeEvents.FINAL_TRANSCRIPT, (data) => {
+ * connection.on(RealtimeEvents.COMMITTED_TRANSCRIPT, (data) => {
  *     console.log("Final:", data.transcript);
  *     connection.close();
  * });
@@ -85,7 +134,7 @@ export declare class RealtimeConnection {
      *     console.log("Partial:", data.transcript);
      * });
      *
-     * connection.on(RealtimeEvents.FINAL_TRANSCRIPT, (data) => {
+     * connection.on(RealtimeEvents.COMMITTED_TRANSCRIPT, (data) => {
      *     console.log("Final:", data.transcript);
      * });
      * ```
@@ -137,8 +186,8 @@ export declare class RealtimeConnection {
         sampleRate?: number;
     }): void;
     /**
-     * Commits the transcription, signaling that all audio has been sent.
-     * This finalizes the transcription and triggers a FINAL_TRANSCRIPT event.
+     * Commits the segment, triggering a COMMITTED_TRANSCRIPT event and clearing the buffer.
+     * It's recommend to commit often when using CommitStrategy.MANUAL to keep latency low.
      *
      * @throws {Error} If the WebSocket connection is not open
      *
@@ -168,7 +217,7 @@ export declare class RealtimeConnection {
      *
      * @example
      * ```typescript
-     * connection.on(RealtimeEvents.FINAL_TRANSCRIPT, (data) => {
+     * connection.on(RealtimeEvents.COMMITTED_TRANSCRIPT, (data) => {
      *     console.log("Final:", data.transcript);
      *     connection.close();
      * });

package/dist/wrapper/realtime/connection.js

@@ -15,10 +15,10 @@ var RealtimeEvents;
     RealtimeEvents["SESSION_STARTED"] = "session_started";
     /** Emitted when a partial (interim) transcript is available */
     RealtimeEvents["PARTIAL_TRANSCRIPT"] = "partial_transcript";
-    /** Emitted when a final transcript is available */
-    RealtimeEvents["FINAL_TRANSCRIPT"] = "final_transcript";
-    /** Emitted when a final transcript with timestamps is available */
-    RealtimeEvents["FINAL_TRANSCRIPT_WITH_TIMESTAMPS"] = "final_transcript_with_timestamps";
+    /** Emitted when a committed transcript is available */
+    RealtimeEvents["COMMITTED_TRANSCRIPT"] = "committed_transcript";
+    /** Emitted when a committed transcript with timestamps is available */
+    RealtimeEvents["COMMITTED_TRANSCRIPT_WITH_TIMESTAMPS"] = "committed_transcript_with_timestamps";
     /** Emitted when an error occurs */
     RealtimeEvents["ERROR"] = "error";
     /** Emitted when the WebSocket connection is opened */
@@ -35,7 +35,7 @@ var RealtimeEvents;
  * @example
  * ```typescript
  * const connection = await client.speechToText.realtime.connect({
- *     modelId: "scribe_realtime_v2",
+ *     modelId: "scribe_v2_realtime",
  *     audioFormat: AudioFormat.PCM_16000,
  *     sampleRate: 16000,
  * });
@@ -48,7 +48,7 @@ var RealtimeEvents;
  *     console.log("Partial:", data.transcript);
  * });
  *
- * connection.on(RealtimeEvents.FINAL_TRANSCRIPT, (data) => {
+ * connection.on(RealtimeEvents.COMMITTED_TRANSCRIPT, (data) => {
  *     console.log("Final:", data.transcript);
  *     connection.close();
  * });
@@ -93,11 +93,11 @@ class RealtimeConnection {
                 case "partial_transcript":
                     this.eventEmitter.emit(RealtimeEvents.PARTIAL_TRANSCRIPT, data);
                     break;
-                case "final_transcript":
-                    this.eventEmitter.emit(RealtimeEvents.FINAL_TRANSCRIPT, data);
+                case "committed_transcript":
+                    this.eventEmitter.emit(RealtimeEvents.COMMITTED_TRANSCRIPT, data);
                     break;
-                case "final_transcript_with_timestamps":
-                    this.eventEmitter.emit(RealtimeEvents.FINAL_TRANSCRIPT_WITH_TIMESTAMPS, data);
+                case "committed_transcript_with_timestamps":
+                    this.eventEmitter.emit(RealtimeEvents.COMMITTED_TRANSCRIPT_WITH_TIMESTAMPS, data);
                     break;
             }
         });
@@ -132,7 +132,7 @@ class RealtimeConnection {
      *     console.log("Partial:", data.transcript);
      * });
      *
-     * connection.on(RealtimeEvents.FINAL_TRANSCRIPT, (data) => {
+     * connection.on(RealtimeEvents.COMMITTED_TRANSCRIPT, (data) => {
      *     console.log("Final:", data.transcript);
      * });
      * ```
@@ -196,8 +196,8 @@ class RealtimeConnection {
         this.websocket.send(JSON.stringify(message));
     }
     /**
-     * Commits the transcription, signaling that all audio has been sent.
-     * This finalizes the transcription and triggers a FINAL_TRANSCRIPT event.
+     * Commits the segment, triggering a COMMITTED_TRANSCRIPT event and clearing the buffer.
+     * It's recommend to commit often when using CommitStrategy.MANUAL to keep latency low.
      *
      * @throws {Error} If the WebSocket connection is not open
      *
@@ -238,7 +238,7 @@ class RealtimeConnection {
      *
      * @example
      * ```typescript
-     * connection.on(RealtimeEvents.FINAL_TRANSCRIPT, (data) => {
+     * connection.on(RealtimeEvents.COMMITTED_TRANSCRIPT, (data) => {
      *     console.log("Final:", data.transcript);
      *     connection.close();
      * });

package/dist/wrapper/realtime/index.d.ts

@@ -1,2 +1,2 @@
-export { RealtimeConnection, RealtimeEvents } from "./connection";
+export { RealtimeConnection, RealtimeEvents, type Config, type InputAudioChunk, type WordsItem, type WordsItemType, type CommittedTranscriptMessage, type CommittedTranscriptWithTimestampsMessage, type PartialTranscriptMessage, type SessionStartedMessage } from "./connection";
 export { ScribeRealtime, AudioFormat, CommitStrategy, type AudioOptions, type UrlOptions } from "./scribe";

package/dist/wrapper/realtime/scribe.d.ts

@@ -94,14 +94,14 @@ export declare class ScribeRealtime {
      * ```typescript
      * // Manual audio streaming
      * const connection = await client.speechToText.realtime.connect({
-     *     modelId: "scribe_realtime_v2",
+     *     modelId: "scribe_v2_realtime",
      *     audioFormat: AudioFormat.PCM_16000,
      *     sampleRate: 16000,
      * });
      *
      * // Automatic URL streaming (requires ffmpeg)
      * const connection = await client.speechToText.realtime.connect({
-     *     modelId: "scribe_realtime_v2",
+     *     modelId: "scribe_v2_realtime",
      *     url: "https://example.com/stream.mp3",
      * });
      * ```