@elevenlabs/elevenlabs-js 2.0.1 → 2.2.0

package/.mock/asyncapi.yml

@@ -147,7 +147,7 @@ channels:
       contexts, flush them, or close them independently. A `close_socket` message can be used to terminate
       the entire connection gracefully.
 
-      For more information on how to use this API for conversational agents see the [conversational agents guide](/docs/best-practices/conversational-agents).
+      For more information on best practices for how to use this API, please see the [multi context websocket guide](/docs/cookbooks/multi-context-web-socket).
 
     bindings:
       ws:
@@ -581,14 +581,14 @@ components:
       type: object
       description: Identifies a specific pronunciation dictionary to use
       properties:
-        dictionary_id:
+        pronunciation_dictionary_id:
           type: string
           description: The unique identifier of the pronunciation dictionary
         version_id:
           type: string
           description: The version identifier of the pronunciation dictionary
       required:
-        - dictionary_id
+        - pronunciation_dictionary_id
         - version_id
 
     WebsocketTTSClientMessageMulti:
@@ -599,9 +599,9 @@ components:
           type: string
           nullable: true
           description: |
-            Text to be synthesized. 
-            For the first message establishing a new context (identified by `context_id`, or a default context if `context_id` is absent), this should be a single space character (' '). 
-            For subsequent messages to an active context, this is the text to synthesize. 
+            Text to be synthesized.
+            For the first message establishing a new context (identified by `context_id`, or a default context if `context_id` is absent), this should be a single space character (' ').
+            For subsequent messages to an active context, this is the text to synthesize.
             This field can be null or an empty string if the message is primarily for control (e.g., using `flush`, `close_context`, or `close_socket`).
         voice_settings:
           $ref: '#/components/schemas/RealtimeVoiceSettings'
@@ -624,18 +624,18 @@ components:
           items:
             $ref: '#/components/schemas/PronunciationDictionaryLocator'
           description: Optional list of pronunciation dictionary locators. Can only be provided in the first message for a given context_id.
-        context_id:
+        contextId:
           type: string
           nullable: true
           description: An identifier for the text-to-speech context. Allows managing multiple independent audio generation streams over a single WebSocket connection. If omitted, a default context is used.
         close_context:
           type: boolean
           default: false
-          description: If true, closes the specified `context_id`. No further audio will be generated for this context. The `text` field is ignored.
+          description: If true, closes the specified `contextId`. No further audio will be generated for this context. The `text` field is ignored.
         close_socket:
           type: boolean
           default: false
-          description: If true, flushes all contexts and closes the entire WebSocket connection. The `text` and `context_id` fields are ignored.
+          description: If true, flushes all contexts and closes the entire WebSocket connection. The `text` and `contextId` fields are ignored.
 
     WebsocketTTSServerMessageMulti:
       type: object
@@ -762,9 +762,9 @@ components:
         alignment:
           $ref: '#/components/schemas/Alignment'
           nullable: true
-        context_id:
+        contextId:
           type: string
-          description: The context_id for which this audio is.
+          description: The contextId for which this audio is.
 
     FinalOutputMulti:
       type: object