retell-sdk 5.36.0 → 5.38.0

package/src/resources/agent.ts

@@ -47,10 +47,7 @@ export class Agent extends APIResource {
   /**
    * List all agents
    *
-   * @example
-   * ```ts
-   * const agentResponses = await client.agent.list();
-   * ```
+   * @deprecated
    */
   list(
     query: AgentListParams | null | undefined = {},
@@ -251,26 +248,6 @@ export interface AgentResponse {
    */
   ambient_sound_volume?: number;
 
-  /**
-   * Prompt to determine whether the post call or chat analysis should mark the
-   * interaction as successful. Set to null to use the default prompt.
-   */
-  analysis_successful_prompt?: string | null;
-
-  /**
-   * Prompt to guide how the post call or chat analysis summary should be generated.
-   * When unset, the default system prompt is used. Set to null to use the default
-   * prompt.
-   */
-  analysis_summary_prompt?: string | null;
-
-  /**
-   * Prompt to guide how the post call or chat analysis should evaluate user
-   * sentiment. When unset, the default system prompt is used. Set to null to use the
-   * default prompt.
-   */
-  analysis_user_sentiment_prompt?: string | null;
-
   /**
    * Tags assigned to this agent version. Preferred tag is listed first.
    */
@@ -373,12 +350,45 @@ export interface AgentResponse {
    */
   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
@@ -680,6 +690,11 @@ export interface AgentResponse {
    */
   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.
@@ -732,21 +747,6 @@ export interface AgentResponse {
    */
   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
@@ -864,14 +864,14 @@ export namespace AgentResponse {
   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';
   }
 
   /**
@@ -912,6 +912,13 @@ export namespace AgentResponse {
      */
     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.
      */
@@ -1335,26 +1342,6 @@ export interface AgentCreateParams {
    */
   ambient_sound_volume?: number;
 
-  /**
-   * Prompt to determine whether the post call or chat analysis should mark the
-   * interaction as successful. Set to null to use the default prompt.
-   */
-  analysis_successful_prompt?: string | null;
-
-  /**
-   * Prompt to guide how the post call or chat analysis summary should be generated.
-   * When unset, the default system prompt is used. Set to null to use the default
-   * prompt.
-   */
-  analysis_summary_prompt?: string | null;
-
-  /**
-   * Prompt to guide how the post call or chat analysis should evaluate user
-   * sentiment. When unset, the default system prompt is used. Set to null to use the
-   * default prompt.
-   */
-  analysis_user_sentiment_prompt?: string | null;
-
   /**
    * Only applicable when enable_backchannel is true. Controls how often the agent
    * would backchannel when a backchannel is possible. Value ranging from [0,1].
@@ -1447,12 +1434,45 @@ export interface AgentCreateParams {
    */
   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
@@ -1749,6 +1769,11 @@ export interface AgentCreateParams {
    */
   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.
@@ -1801,21 +1826,6 @@ export interface AgentCreateParams {
    */
   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
@@ -1933,14 +1943,14 @@ export namespace AgentCreateParams {
   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';
   }
 
   /**
@@ -1981,6 +1991,13 @@ export namespace AgentCreateParams {
      */
     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.
      */
@@ -2423,26 +2440,6 @@ export interface AgentUpdateParams {
    */
   ambient_sound_volume?: number;
 
-  /**
-   * Body param: Prompt to determine whether the post call or chat analysis should
-   * mark the interaction as successful. Set to null to use the default prompt.
-   */
-  analysis_successful_prompt?: string | null;
-
-  /**
-   * Body param: Prompt to guide how the post call or chat analysis summary should be
-   * generated. When unset, the default system prompt is used. Set to null to use the
-   * default prompt.
-   */
-  analysis_summary_prompt?: string | null;
-
-  /**
-   * Body param: Prompt to guide how the post call or chat analysis should evaluate
-   * user sentiment. When unset, the default system prompt is used. Set to null to
-   * use the default prompt.
-   */
-  analysis_user_sentiment_prompt?: string | null;
-
   /**
    * Body param: Only applicable when enable_backchannel is true. Controls how often
    * the agent would backchannel when a backchannel is possible. Value ranging from
@@ -2537,6 +2534,13 @@ export interface AgentUpdateParams {
    */
   enable_dynamic_voice_speed?: boolean;
 
+  /**
+   * Body param: 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;
+
   /**
    * Body param: 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
@@ -2544,6 +2548,32 @@ export interface AgentUpdateParams {
    */
   end_call_after_silence_ms?: number;
 
+  /**
+   * Body param: 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'
+  >;
+
+  /**
+   * Body param: 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;
+
   /**
    * Body param: 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
@@ -2856,6 +2886,11 @@ export interface AgentUpdateParams {
    */
   version_description?: string | null;
 
+  /**
+   * Body param: Optional title of the agent version. Used for your own reference.
+   */
+  version_title?: string | null;
+
   /**
    * Body param: If set, determines the vocabulary set to use for transcription. This
    * setting only applies for English agents, for non English agent, this setting is
@@ -2916,21 +2951,6 @@ export interface AgentUpdateParams {
    */
   voice_temperature?: number;
 
-  /**
-   * Body param: 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;
-
-  /**
-   * Body param: 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;
-
   /**
    * Body param: 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
@@ -3002,14 +3022,14 @@ export namespace AgentUpdateParams {
   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';
   }
 
   /**
@@ -3050,6 +3070,13 @@ export namespace AgentUpdateParams {
      */
     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.
      */
@@ -3447,6 +3474,11 @@ export interface AgentPublishParams {
   version: number;
 
   version_description?: string;
+
+  /**
+   * Optional title of the agent version. Used for your own reference.
+   */
+  version_title?: string;
 }
 
 export interface AgentCreateVersionParams {

package/src/resources/batch-call.ts

@@ -280,26 +280,6 @@ export namespace BatchCallCreateBatchCallParams {
          */
         ambient_sound_volume?: number;
 
-        /**
-         * Prompt to determine whether the post call or chat analysis should mark the
-         * interaction as successful. Set to null to use the default prompt.
-         */
-        analysis_successful_prompt?: string | null;
-
-        /**
-         * Prompt to guide how the post call or chat analysis summary should be generated.
-         * When unset, the default system prompt is used. Set to null to use the default
-         * prompt.
-         */
-        analysis_summary_prompt?: string | null;
-
-        /**
-         * Prompt to guide how the post call or chat analysis should evaluate user
-         * sentiment. When unset, the default system prompt is used. Set to null to use the
-         * default prompt.
-         */
-        analysis_user_sentiment_prompt?: string | null;
-
         /**
          * Only applicable when enable_backchannel is true. Controls how often the agent
          * would backchannel when a backchannel is possible. Value ranging from [0,1].
@@ -392,12 +372,45 @@ export namespace BatchCallCreateBatchCallParams {
          */
         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
@@ -704,6 +717,11 @@ export namespace BatchCallCreateBatchCallParams {
          */
         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.
@@ -762,21 +780,6 @@ export namespace BatchCallCreateBatchCallParams {
          */
         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
@@ -848,14 +851,14 @@ export namespace BatchCallCreateBatchCallParams {
         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';
         }
 
         /**
@@ -896,6 +899,13 @@ export namespace BatchCallCreateBatchCallParams {
            */
           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.
            */