retell-sdk 5.35.0 → 5.37.0

package/src/resources/call.ts

@@ -199,6 +199,17 @@ export interface PhoneCallResponse {
    */
   agent_name?: string;
 
+  /**
+   * Tag pointing at the agent version used for this call, captured at call creation
+   * time and frozen thereafter (unaffected by later tag reassignments). Populated
+   * whether the caller dispatched by tag, numeric version, "latest", or
+   * "latest_published" — when the caller specified a tag, that tag wins; otherwise
+   * the most-recently- assigned tag on the resolved version is used. Absent when no
+   * tag points at the resolved version (or for calls created before this field was
+   * introduced).
+   */
+  agent_tag?: string | null;
+
   /**
    * Post call analysis that includes information such as sentiment, status, summary,
    * and custom defined data to extract. Available after call ends. Subscribe to
@@ -1390,6 +1401,17 @@ export interface WebCallResponse {
    */
   agent_name?: string;
 
+  /**
+   * Tag pointing at the agent version used for this call, captured at call creation
+   * time and frozen thereafter (unaffected by later tag reassignments). Populated
+   * whether the caller dispatched by tag, numeric version, "latest", or
+   * "latest_published" — when the caller specified a tag, that tag wins; otherwise
+   * the most-recently- assigned tag on the resolved version is used. Absent when no
+   * tag points at the resolved version (or for calls created before this field was
+   * introduced).
+   */
+  agent_tag?: string | null;
+
   /**
    * Post call analysis that includes information such as sentiment, status, summary,
    * and custom defined data to extract. Available after call ends. Subscribe to
@@ -2585,6 +2607,17 @@ export namespace CallListResponse {
      */
     agent_name?: string;
 
+    /**
+     * Tag pointing at the agent version used for this call, captured at call creation
+     * time and frozen thereafter (unaffected by later tag reassignments). Populated
+     * whether the caller dispatched by tag, numeric version, "latest", or
+     * "latest_published" — when the caller specified a tag, that tag wins; otherwise
+     * the most-recently- assigned tag on the resolved version is used. Absent when no
+     * tag points at the resolved version (or for calls created before this field was
+     * introduced).
+     */
+    agent_tag?: string | null;
+
     /**
      * Post call analysis that includes information such as sentiment, status, summary,
      * and custom defined data to extract. Available after call ends. Subscribe to
@@ -3299,6 +3332,17 @@ export namespace CallListResponse {
      */
     agent_name?: string;
 
+    /**
+     * Tag pointing at the agent version used for this call, captured at call creation
+     * time and frozen thereafter (unaffected by later tag reassignments). Populated
+     * whether the caller dispatched by tag, numeric version, "latest", or
+     * "latest_published" — when the caller specified a tag, that tag wins; otherwise
+     * the most-recently- assigned tag on the resolved version is used. Absent when no
+     * tag points at the resolved version (or for calls created before this field was
+     * introduced).
+     */
+    agent_tag?: string | null;
+
     /**
      * Post call analysis that includes information such as sentiment, status, summary,
      * and custom defined data to extract. Available after call ends. Subscribe to
@@ -4241,12 +4285,45 @@ export namespace CallCreatePhoneCallParams {
        */
       enable_dynamic_voice_speed?: boolean;
 
+      /**
+       * Master toggle for expressive mode. When true, the agent may add expressive voice
+       * tags to the audio it generates. Only applicable for platform voices. If unset,
+       * defaults to false.
+       */
+      enable_expressive_mode?: boolean;
+
       /**
        * If users stay silent for a period after agent speech, end the call. The minimum
        * value allowed is 10,000 ms (10 s). By default, this is set to 600000 (10 min).
        */
       end_call_after_silence_ms?: number;
 
+      /**
+       * The expressive voice tags Retell pre-teaches the model to use when
+       * enable_expressive_mode is true. Custom tags defined in the system prompt are
+       * still allowed. If empty, the agent follows general expressive guidance without a
+       * fixed tag set.
+       */
+      expressive_emotion_tags?: Array<
+        | 'empathetic'
+        | 'excited'
+        | 'happy'
+        | 'curious'
+        | 'surprised'
+        | 'sigh'
+        | 'clear throat'
+        | 'pause'
+        | 'long pause'
+        | 'emphasis'
+      >;
+
+      /**
+       * Custom expressive voice guidance to use instead of the default Retell expressive
+       * prompt when enable_expressive_mode is true. If omitted or blank, the default
+       * expressive prompt will be used.
+       */
+      expressive_mode_prompt?: string | null;
+
       /**
        * When TTS provider for the selected voice is experiencing outages, we would use
        * fallback voices listed here for the agent. Voice id and the fallback voice ids
@@ -4553,6 +4630,11 @@ export namespace CallCreatePhoneCallParams {
        */
       version_description?: string | null;
 
+      /**
+       * Optional title of the agent version. Used for your own reference.
+       */
+      version_title?: string | null;
+
       /**
        * If set, determines the vocabulary set to use for transcription. This setting
        * only applies for English agents, for non English agent, this setting is a no-op.
@@ -4611,21 +4693,6 @@ export namespace CallCreatePhoneCallParams {
        */
       voice_temperature?: number;
 
-      /**
-       * Configures when to stop running voicemail detection, as it becomes unlikely to
-       * hit voicemail after a couple minutes, and keep running it will only have
-       * negative impact. The minimum value allowed is 5,000 ms (5 s), and maximum value
-       * allowed is 180,000 (3 minutes). By default, this is set to 30,000 (30 s).
-       */
-      voicemail_detection_timeout_ms?: number;
-
-      /**
-       * The message to be played when the call enters a voicemail. Note that this
-       * feature is only available for phone calls. If you want to hangup after hitting
-       * voicemail, set this to empty string.
-       */
-      voicemail_message?: string;
-
       /**
        * If this option is set, the call will try to detect voicemail in the first 3
        * minutes of the call. Actions defined (hangup, or leave a message) will be
@@ -4697,14 +4764,14 @@ export namespace CallCreatePhoneCallParams {
       export interface CustomSttConfig {
         /**
          * Endpointing timeout in milliseconds. Minimum is 100 for Azure, 10 for Deepgram,
-         * 500 for Soniox
+         * 500 for Soniox, 100 for AssemblyAI.
          */
         endpointing_ms: number;
 
         /**
          * ASR provider name.
          */
-        provider: 'azure' | 'deepgram' | 'soniox';
+        provider: 'azure' | 'deepgram' | 'soniox' | 'assemblyai';
       }
 
       /**
@@ -4745,6 +4812,13 @@ export namespace CallCreatePhoneCallParams {
          */
         ai_disclosure?: boolean;
 
+        /**
+         * Enables Conversational Personality. When true, the agent uses the Conversational
+         * Personality handbook preset, skips Professional Rep Personality during prompt
+         * assembly, and enables internal colloquial rewrite behavior.
+         */
+        conversational_personality?: boolean;
+
         /**
          * Professional call center rep baseline.
          */
@@ -5600,12 +5674,45 @@ export namespace CallRegisterPhoneCallParams {
        */
       enable_dynamic_voice_speed?: boolean;
 
+      /**
+       * Master toggle for expressive mode. When true, the agent may add expressive voice
+       * tags to the audio it generates. Only applicable for platform voices. If unset,
+       * defaults to false.
+       */
+      enable_expressive_mode?: boolean;
+
       /**
        * If users stay silent for a period after agent speech, end the call. The minimum
        * value allowed is 10,000 ms (10 s). By default, this is set to 600000 (10 min).
        */
       end_call_after_silence_ms?: number;
 
+      /**
+       * The expressive voice tags Retell pre-teaches the model to use when
+       * enable_expressive_mode is true. Custom tags defined in the system prompt are
+       * still allowed. If empty, the agent follows general expressive guidance without a
+       * fixed tag set.
+       */
+      expressive_emotion_tags?: Array<
+        | 'empathetic'
+        | 'excited'
+        | 'happy'
+        | 'curious'
+        | 'surprised'
+        | 'sigh'
+        | 'clear throat'
+        | 'pause'
+        | 'long pause'
+        | 'emphasis'
+      >;
+
+      /**
+       * Custom expressive voice guidance to use instead of the default Retell expressive
+       * prompt when enable_expressive_mode is true. If omitted or blank, the default
+       * expressive prompt will be used.
+       */
+      expressive_mode_prompt?: string | null;
+
       /**
        * When TTS provider for the selected voice is experiencing outages, we would use
        * fallback voices listed here for the agent. Voice id and the fallback voice ids
@@ -5912,6 +6019,11 @@ export namespace CallRegisterPhoneCallParams {
        */
       version_description?: string | null;
 
+      /**
+       * Optional title of the agent version. Used for your own reference.
+       */
+      version_title?: string | null;
+
       /**
        * If set, determines the vocabulary set to use for transcription. This setting
        * only applies for English agents, for non English agent, this setting is a no-op.
@@ -5970,21 +6082,6 @@ export namespace CallRegisterPhoneCallParams {
        */
       voice_temperature?: number;
 
-      /**
-       * Configures when to stop running voicemail detection, as it becomes unlikely to
-       * hit voicemail after a couple minutes, and keep running it will only have
-       * negative impact. The minimum value allowed is 5,000 ms (5 s), and maximum value
-       * allowed is 180,000 (3 minutes). By default, this is set to 30,000 (30 s).
-       */
-      voicemail_detection_timeout_ms?: number;
-
-      /**
-       * The message to be played when the call enters a voicemail. Note that this
-       * feature is only available for phone calls. If you want to hangup after hitting
-       * voicemail, set this to empty string.
-       */
-      voicemail_message?: string;
-
       /**
        * If this option is set, the call will try to detect voicemail in the first 3
        * minutes of the call. Actions defined (hangup, or leave a message) will be
@@ -6056,14 +6153,14 @@ export namespace CallRegisterPhoneCallParams {
       export interface CustomSttConfig {
         /**
          * Endpointing timeout in milliseconds. Minimum is 100 for Azure, 10 for Deepgram,
-         * 500 for Soniox
+         * 500 for Soniox, 100 for AssemblyAI.
          */
         endpointing_ms: number;
 
         /**
          * ASR provider name.
          */
-        provider: 'azure' | 'deepgram' | 'soniox';
+        provider: 'azure' | 'deepgram' | 'soniox' | 'assemblyai';
       }
 
       /**
@@ -6104,6 +6201,13 @@ export namespace CallRegisterPhoneCallParams {
          */
         ai_disclosure?: boolean;
 
+        /**
+         * Enables Conversational Personality. When true, the agent uses the Conversational
+         * Personality handbook preset, skips Professional Rep Personality during prompt
+         * assembly, and enables internal colloquial rewrite behavior.
+         */
+        conversational_personality?: boolean;
+
         /**
          * Professional call center rep baseline.
          */
@@ -6959,12 +7063,45 @@ export namespace CallCreateWebCallParams {
        */
       enable_dynamic_voice_speed?: boolean;
 
+      /**
+       * Master toggle for expressive mode. When true, the agent may add expressive voice
+       * tags to the audio it generates. Only applicable for platform voices. If unset,
+       * defaults to false.
+       */
+      enable_expressive_mode?: boolean;
+
       /**
        * If users stay silent for a period after agent speech, end the call. The minimum
        * value allowed is 10,000 ms (10 s). By default, this is set to 600000 (10 min).
        */
       end_call_after_silence_ms?: number;
 
+      /**
+       * The expressive voice tags Retell pre-teaches the model to use when
+       * enable_expressive_mode is true. Custom tags defined in the system prompt are
+       * still allowed. If empty, the agent follows general expressive guidance without a
+       * fixed tag set.
+       */
+      expressive_emotion_tags?: Array<
+        | 'empathetic'
+        | 'excited'
+        | 'happy'
+        | 'curious'
+        | 'surprised'
+        | 'sigh'
+        | 'clear throat'
+        | 'pause'
+        | 'long pause'
+        | 'emphasis'
+      >;
+
+      /**
+       * Custom expressive voice guidance to use instead of the default Retell expressive
+       * prompt when enable_expressive_mode is true. If omitted or blank, the default
+       * expressive prompt will be used.
+       */
+      expressive_mode_prompt?: string | null;
+
       /**
        * When TTS provider for the selected voice is experiencing outages, we would use
        * fallback voices listed here for the agent. Voice id and the fallback voice ids
@@ -7271,6 +7408,11 @@ export namespace CallCreateWebCallParams {
        */
       version_description?: string | null;
 
+      /**
+       * Optional title of the agent version. Used for your own reference.
+       */
+      version_title?: string | null;
+
       /**
        * If set, determines the vocabulary set to use for transcription. This setting
        * only applies for English agents, for non English agent, this setting is a no-op.
@@ -7329,21 +7471,6 @@ export namespace CallCreateWebCallParams {
        */
       voice_temperature?: number;
 
-      /**
-       * Configures when to stop running voicemail detection, as it becomes unlikely to
-       * hit voicemail after a couple minutes, and keep running it will only have
-       * negative impact. The minimum value allowed is 5,000 ms (5 s), and maximum value
-       * allowed is 180,000 (3 minutes). By default, this is set to 30,000 (30 s).
-       */
-      voicemail_detection_timeout_ms?: number;
-
-      /**
-       * The message to be played when the call enters a voicemail. Note that this
-       * feature is only available for phone calls. If you want to hangup after hitting
-       * voicemail, set this to empty string.
-       */
-      voicemail_message?: string;
-
       /**
        * If this option is set, the call will try to detect voicemail in the first 3
        * minutes of the call. Actions defined (hangup, or leave a message) will be
@@ -7415,14 +7542,14 @@ export namespace CallCreateWebCallParams {
       export interface CustomSttConfig {
         /**
          * Endpointing timeout in milliseconds. Minimum is 100 for Azure, 10 for Deepgram,
-         * 500 for Soniox
+         * 500 for Soniox, 100 for AssemblyAI.
          */
         endpointing_ms: number;
 
         /**
          * ASR provider name.
          */
-        provider: 'azure' | 'deepgram' | 'soniox';
+        provider: 'azure' | 'deepgram' | 'soniox' | 'assemblyai';
       }
 
       /**
@@ -7463,6 +7590,13 @@ export namespace CallCreateWebCallParams {
          */
         ai_disclosure?: boolean;
 
+        /**
+         * Enables Conversational Personality. When true, the agent uses the Conversational
+         * Personality handbook preset, skips Professional Rep Personality during prompt
+         * assembly, and enables internal colloquial rewrite behavior.
+         */
+        conversational_personality?: boolean;
+
         /**
          * Professional call center rep baseline.
          */
@@ -8849,19 +8983,24 @@ export namespace CallListParams {
 
     export interface ToolCall {
       /**
-       * The tool call name to filter on.
+       * Filter by tool call latency in milliseconds.
        */
-      name: string;
+      latency_ms?: ToolCall.NumberFilter | ToolCall.RangeFilter;
 
       /**
-       * Filter by tool call latency in milliseconds.
+       * The tool call name to filter on.
        */
-      latency_ms?: ToolCall.NumberFilter | ToolCall.RangeFilter;
+      name?: string;
 
       /**
        * Filter by tool call success status.
        */
       success?: ToolCall.Success;
+
+      /**
+       * The tool call type to filter on.
+       */
+      type?: string;
     }
 
     export namespace ToolCall {

package/src/resources/chat-agent.ts

@@ -46,10 +46,7 @@ export class ChatAgent extends APIResource {
   /**
    * List all chat agents
    *
-   * @example
-   * ```ts
-   * const chatAgentResponses = await client.chatAgent.list();
-   * ```
+   * @deprecated
    */
   list(
     query: ChatAgentListParams | null | undefined = {},
@@ -475,6 +472,11 @@ export interface ChatAgentResponse {
    */
   version?: number;
 
+  /**
+   * Optional title of the chat agent version. Used for your own reference.
+   */
+  version_title?: string | null;
+
   /**
    * Which webhook events this agent should receive. If not set, defaults to
    * chat_started, chat_ended, chat_analyzed.
@@ -1074,6 +1076,11 @@ export interface ChatAgentCreateParams {
    */
   timezone?: string | null;
 
+  /**
+   * Optional title of the chat agent version. Used for your own reference.
+   */
+  version_title?: string | null;
+
   /**
    * Which webhook events this agent should receive. If not set, defaults to
    * chat_started, chat_ended, chat_analyzed.
@@ -1710,6 +1717,12 @@ export interface ChatAgentUpdateParams {
    */
   timezone?: string | null;
 
+  /**
+   * Body param: Optional title of the chat agent version. Used for your own
+   * reference.
+   */
+  version_title?: string | null;
+
   /**
    * Body param: Which webhook events this agent should receive. If not set, defaults
    * to chat_started, chat_ended, chat_analyzed.
@@ -2033,6 +2046,11 @@ export interface ChatAgentPublishParams {
   version: number;
 
   version_description?: string;
+
+  /**
+   * Optional title of the agent version. Used for your own reference.
+   */
+  version_title?: string;
 }
 
 export interface ChatAgentCreateVersionParams {