retell-sdk 4.60.0 → 4.62.0

package/src/resources/llm.ts

@@ -196,18 +196,14 @@ export interface LlmResponse {
    * Select the underlying text LLM. If not set, would default to gpt-4.1.
    */
   model?:
-    | 'gpt-5'
-    | 'gpt-5-mini'
-    | 'gpt-5-nano'
-    | 'gpt-4o'
-    | 'gpt-4o-mini'
     | 'gpt-4.1'
     | 'gpt-4.1-mini'
     | 'gpt-4.1-nano'
-    | 'claude-3.7-sonnet'
-    | 'claude-3.5-haiku'
-    | 'gemini-2.0-flash'
-    | 'gemini-2.0-flash-lite'
+    | 'gpt-5'
+    | 'gpt-5-mini'
+    | 'gpt-5-nano'
+    | 'claude-4.5-sonnet'
+    | 'claude-4.5-haiku'
     | 'gemini-2.5-flash'
     | 'gemini-2.5-flash-lite'
     | null;
@@ -297,7 +293,8 @@ export namespace LlmResponse {
 
     transfer_option:
       | TransferCallTool.TransferOptionColdTransfer
-      | TransferCallTool.TransferOptionWarmTransfer;
+      | TransferCallTool.TransferOptionWarmTransfer
+      | TransferCallTool.TransferOptionAgenticWarmTransfer;
 
     type: 'transfer_call';
 
@@ -479,6 +476,105 @@ export namespace LlmResponse {
         type?: 'static_message';
       }
     }
+
+    export interface TransferOptionAgenticWarmTransfer {
+      /**
+       * Configuration for agentic warm transfer. Required for agentic warm transfer.
+       */
+      agentic_transfer_config: TransferOptionAgenticWarmTransfer.AgenticTransferConfig;
+
+      /**
+       * The type of the transfer.
+       */
+      type: 'agentic_warm_transfer';
+
+      /**
+       * Whether to play an audio cue when bridging the call. Defaults to true.
+       */
+      enable_bridge_audio_cue?: boolean;
+
+      /**
+       * The music to play while the caller is being transferred.
+       */
+      on_hold_music?: 'none' | 'relaxing_sound' | 'uplifting_beats' | 'ringtone';
+
+      /**
+       * If set, when transfer is successful, will say the handoff message to both the
+       * transferee and the agent receiving the transfer. Can leave either a static
+       * message or a dynamic one based on prompt. Set to null to disable warm handoff.
+       */
+      public_handoff_option?:
+        | TransferOptionAgenticWarmTransfer.WarmTransferPrompt
+        | TransferOptionAgenticWarmTransfer.WarmTransferStaticMessage;
+
+      /**
+       * If set to true, will show transferee (the user, not the AI agent) as caller when
+       * transferring, requires the telephony side to support caller id override. Retell
+       * Twilio numbers support this option.
+       */
+      show_transferee_as_caller?: boolean;
+    }
+
+    export namespace TransferOptionAgenticWarmTransfer {
+      /**
+       * Configuration for agentic warm transfer. Required for agentic warm transfer.
+       */
+      export interface AgenticTransferConfig {
+        /**
+         * The action to take when the transfer agent times out without making a decision.
+         * Defaults to cancel_transfer.
+         */
+        action_on_timeout?: 'bridge_transfer' | 'cancel_transfer';
+
+        /**
+         * The agent that will mediate the transfer decision.
+         */
+        transfer_agent?: AgenticTransferConfig.TransferAgent;
+
+        /**
+         * The maximum time to wait for the transfer agent to make a decision, in
+         * milliseconds. Defaults to 30000 (30 seconds).
+         */
+        transfer_timeout_ms?: number;
+      }
+
+      export namespace AgenticTransferConfig {
+        /**
+         * The agent that will mediate the transfer decision.
+         */
+        export interface TransferAgent {
+          /**
+           * The agent ID of the transfer agent. This agent must have isTransferAgent set to
+           * true and should use bridge_transfer and cancel_transfer tools (for Retell LLM)
+           * or BridgeTransferNode and CancelTransferNode (for Conversation Flow).
+           */
+          agent_id: string;
+
+          /**
+           * The version of the transfer agent to use.
+           */
+          agent_version: number;
+        }
+      }
+
+      export interface WarmTransferPrompt {
+        /**
+         * The prompt to be used for warm handoff. Can contain dynamic variables.
+         */
+        prompt?: string;
+
+        type?: 'prompt';
+      }
+
+      export interface WarmTransferStaticMessage {
+        /**
+         * The static message to be used for warm handoff. Can contain dynamic variables.
+         */
+        message?: string;
+
+        type?: 'static_message';
+      }
+    }
   }
 
   export interface CheckAvailabilityCalTool {
@@ -1103,7 +1199,8 @@ export namespace LlmResponse {
 
       transfer_option:
         | TransferCallTool.TransferOptionColdTransfer
-        | TransferCallTool.TransferOptionWarmTransfer;
+        | TransferCallTool.TransferOptionWarmTransfer
+        | TransferCallTool.TransferOptionAgenticWarmTransfer;
 
       type: 'transfer_call';
 
@@ -1285,6 +1382,105 @@ export namespace LlmResponse {
           type?: 'static_message';
         }
       }
+
+      export interface TransferOptionAgenticWarmTransfer {
+        /**
+         * Configuration for agentic warm transfer. Required for agentic warm transfer.
+         */
+        agentic_transfer_config: TransferOptionAgenticWarmTransfer.AgenticTransferConfig;
+
+        /**
+         * The type of the transfer.
+         */
+        type: 'agentic_warm_transfer';
+
+        /**
+         * Whether to play an audio cue when bridging the call. Defaults to true.
+         */
+        enable_bridge_audio_cue?: boolean;
+
+        /**
+         * The music to play while the caller is being transferred.
+         */
+        on_hold_music?: 'none' | 'relaxing_sound' | 'uplifting_beats' | 'ringtone';
+
+        /**
+         * If set, when transfer is successful, will say the handoff message to both the
+         * transferee and the agent receiving the transfer. Can leave either a static
+         * message or a dynamic one based on prompt. Set to null to disable warm handoff.
+         */
+        public_handoff_option?:
+          | TransferOptionAgenticWarmTransfer.WarmTransferPrompt
+          | TransferOptionAgenticWarmTransfer.WarmTransferStaticMessage;
+
+        /**
+         * If set to true, will show transferee (the user, not the AI agent) as caller when
+         * transferring, requires the telephony side to support caller id override. Retell
+         * Twilio numbers support this option.
+         */
+        show_transferee_as_caller?: boolean;
+      }
+
+      export namespace TransferOptionAgenticWarmTransfer {
+        /**
+         * Configuration for agentic warm transfer. Required for agentic warm transfer.
+         */
+        export interface AgenticTransferConfig {
+          /**
+           * The action to take when the transfer agent times out without making a decision.
+           * Defaults to cancel_transfer.
+           */
+          action_on_timeout?: 'bridge_transfer' | 'cancel_transfer';
+
+          /**
+           * The agent that will mediate the transfer decision.
+           */
+          transfer_agent?: AgenticTransferConfig.TransferAgent;
+
+          /**
+           * The maximum time to wait for the transfer agent to make a decision, in
+           * milliseconds. Defaults to 30000 (30 seconds).
+           */
+          transfer_timeout_ms?: number;
+        }
+
+        export namespace AgenticTransferConfig {
+          /**
+           * The agent that will mediate the transfer decision.
+           */
+          export interface TransferAgent {
+            /**
+             * The agent ID of the transfer agent. This agent must have isTransferAgent set to
+             * true and should use bridge_transfer and cancel_transfer tools (for Retell LLM)
+             * or BridgeTransferNode and CancelTransferNode (for Conversation Flow).
+             */
+            agent_id: string;
+
+            /**
+             * The version of the transfer agent to use.
+             */
+            agent_version: number;
+          }
+        }
+
+        export interface WarmTransferPrompt {
+          /**
+           * The prompt to be used for warm handoff. Can contain dynamic variables.
+           */
+          prompt?: string;
+
+          type?: 'prompt';
+        }
+
+        export interface WarmTransferStaticMessage {
+          /**
+           * The static message to be used for warm handoff. Can contain dynamic variables.
+           */
+          message?: string;
+
+          type?: 'static_message';
+        }
+      }
     }
 
     export interface CheckAvailabilityCalTool {
@@ -1815,18 +2011,14 @@ export interface LlmCreateParams {
    * Select the underlying text LLM. If not set, would default to gpt-4.1.
    */
   model?:
-    | 'gpt-5'
-    | 'gpt-5-mini'
-    | 'gpt-5-nano'
-    | 'gpt-4o'
-    | 'gpt-4o-mini'
     | 'gpt-4.1'
     | 'gpt-4.1-mini'
     | 'gpt-4.1-nano'
-    | 'claude-3.7-sonnet'
-    | 'claude-3.5-haiku'
-    | 'gemini-2.0-flash'
-    | 'gemini-2.0-flash-lite'
+    | 'gpt-5'
+    | 'gpt-5-mini'
+    | 'gpt-5-nano'
+    | 'claude-4.5-sonnet'
+    | 'claude-4.5-haiku'
     | 'gemini-2.5-flash'
     | 'gemini-2.5-flash-lite'
     | null;
@@ -1916,7 +2108,8 @@ export namespace LlmCreateParams {
 
     transfer_option:
       | TransferCallTool.TransferOptionColdTransfer
-      | TransferCallTool.TransferOptionWarmTransfer;
+      | TransferCallTool.TransferOptionWarmTransfer
+      | TransferCallTool.TransferOptionAgenticWarmTransfer;
 
     type: 'transfer_call';
 
@@ -2098,6 +2291,105 @@ export namespace LlmCreateParams {
         type?: 'static_message';
       }
     }
+
+    export interface TransferOptionAgenticWarmTransfer {
+      /**
+       * Configuration for agentic warm transfer. Required for agentic warm transfer.
+       */
+      agentic_transfer_config: TransferOptionAgenticWarmTransfer.AgenticTransferConfig;
+
+      /**
+       * The type of the transfer.
+       */
+      type: 'agentic_warm_transfer';
+
+      /**
+       * Whether to play an audio cue when bridging the call. Defaults to true.
+       */
+      enable_bridge_audio_cue?: boolean;
+
+      /**
+       * The music to play while the caller is being transferred.
+       */
+      on_hold_music?: 'none' | 'relaxing_sound' | 'uplifting_beats' | 'ringtone';
+
+      /**
+       * If set, when transfer is successful, will say the handoff message to both the
+       * transferee and the agent receiving the transfer. Can leave either a static
+       * message or a dynamic one based on prompt. Set to null to disable warm handoff.
+       */
+      public_handoff_option?:
+        | TransferOptionAgenticWarmTransfer.WarmTransferPrompt
+        | TransferOptionAgenticWarmTransfer.WarmTransferStaticMessage;
+
+      /**
+       * If set to true, will show transferee (the user, not the AI agent) as caller when
+       * transferring, requires the telephony side to support caller id override. Retell
+       * Twilio numbers support this option.
+       */
+      show_transferee_as_caller?: boolean;
+    }
+
+    export namespace TransferOptionAgenticWarmTransfer {
+      /**
+       * Configuration for agentic warm transfer. Required for agentic warm transfer.
+       */
+      export interface AgenticTransferConfig {
+        /**
+         * The action to take when the transfer agent times out without making a decision.
+         * Defaults to cancel_transfer.
+         */
+        action_on_timeout?: 'bridge_transfer' | 'cancel_transfer';
+
+        /**
+         * The agent that will mediate the transfer decision.
+         */
+        transfer_agent?: AgenticTransferConfig.TransferAgent;
+
+        /**
+         * The maximum time to wait for the transfer agent to make a decision, in
+         * milliseconds. Defaults to 30000 (30 seconds).
+         */
+        transfer_timeout_ms?: number;
+      }
+
+      export namespace AgenticTransferConfig {
+        /**
+         * The agent that will mediate the transfer decision.
+         */
+        export interface TransferAgent {
+          /**
+           * The agent ID of the transfer agent. This agent must have isTransferAgent set to
+           * true and should use bridge_transfer and cancel_transfer tools (for Retell LLM)
+           * or BridgeTransferNode and CancelTransferNode (for Conversation Flow).
+           */
+          agent_id: string;
+
+          /**
+           * The version of the transfer agent to use.
+           */
+          agent_version: number;
+        }
+      }
+
+      export interface WarmTransferPrompt {
+        /**
+         * The prompt to be used for warm handoff. Can contain dynamic variables.
+         */
+        prompt?: string;
+
+        type?: 'prompt';
+      }
+
+      export interface WarmTransferStaticMessage {
+        /**
+         * The static message to be used for warm handoff. Can contain dynamic variables.
+         */
+        message?: string;
+
+        type?: 'static_message';
+      }
+    }
   }
 
   export interface CheckAvailabilityCalTool {
@@ -2722,7 +3014,8 @@ export namespace LlmCreateParams {
 
       transfer_option:
         | TransferCallTool.TransferOptionColdTransfer
-        | TransferCallTool.TransferOptionWarmTransfer;
+        | TransferCallTool.TransferOptionWarmTransfer
+        | TransferCallTool.TransferOptionAgenticWarmTransfer;
 
       type: 'transfer_call';
 
@@ -2904,6 +3197,105 @@ export namespace LlmCreateParams {
           type?: 'static_message';
         }
       }
+
+      export interface TransferOptionAgenticWarmTransfer {
+        /**
+         * Configuration for agentic warm transfer. Required for agentic warm transfer.
+         */
+        agentic_transfer_config: TransferOptionAgenticWarmTransfer.AgenticTransferConfig;
+
+        /**
+         * The type of the transfer.
+         */
+        type: 'agentic_warm_transfer';
+
+        /**
+         * Whether to play an audio cue when bridging the call. Defaults to true.
+         */
+        enable_bridge_audio_cue?: boolean;
+
+        /**
+         * The music to play while the caller is being transferred.
+         */
+        on_hold_music?: 'none' | 'relaxing_sound' | 'uplifting_beats' | 'ringtone';
+
+        /**
+         * If set, when transfer is successful, will say the handoff message to both the
+         * transferee and the agent receiving the transfer. Can leave either a static
+         * message or a dynamic one based on prompt. Set to null to disable warm handoff.
+         */
+        public_handoff_option?:
+          | TransferOptionAgenticWarmTransfer.WarmTransferPrompt
+          | TransferOptionAgenticWarmTransfer.WarmTransferStaticMessage;
+
+        /**
+         * If set to true, will show transferee (the user, not the AI agent) as caller when
+         * transferring, requires the telephony side to support caller id override. Retell
+         * Twilio numbers support this option.
+         */
+        show_transferee_as_caller?: boolean;
+      }
+
+      export namespace TransferOptionAgenticWarmTransfer {
+        /**
+         * Configuration for agentic warm transfer. Required for agentic warm transfer.
+         */
+        export interface AgenticTransferConfig {
+          /**
+           * The action to take when the transfer agent times out without making a decision.
+           * Defaults to cancel_transfer.
+           */
+          action_on_timeout?: 'bridge_transfer' | 'cancel_transfer';
+
+          /**
+           * The agent that will mediate the transfer decision.
+           */
+          transfer_agent?: AgenticTransferConfig.TransferAgent;
+
+          /**
+           * The maximum time to wait for the transfer agent to make a decision, in
+           * milliseconds. Defaults to 30000 (30 seconds).
+           */
+          transfer_timeout_ms?: number;
+        }
+
+        export namespace AgenticTransferConfig {
+          /**
+           * The agent that will mediate the transfer decision.
+           */
+          export interface TransferAgent {
+            /**
+             * The agent ID of the transfer agent. This agent must have isTransferAgent set to
+             * true and should use bridge_transfer and cancel_transfer tools (for Retell LLM)
+             * or BridgeTransferNode and CancelTransferNode (for Conversation Flow).
+             */
+            agent_id: string;
+
+            /**
+             * The version of the transfer agent to use.
+             */
+            agent_version: number;
+          }
+        }
+
+        export interface WarmTransferPrompt {
+          /**
+           * The prompt to be used for warm handoff. Can contain dynamic variables.
+           */
+          prompt?: string;
+
+          type?: 'prompt';
+        }
+
+        export interface WarmTransferStaticMessage {
+          /**
+           * The static message to be used for warm handoff. Can contain dynamic variables.
+           */
+          message?: string;
+
+          type?: 'static_message';
+        }
+      }
     }
 
     export interface CheckAvailabilityCalTool {
@@ -3449,18 +3841,14 @@ export interface LlmUpdateParams {
    * gpt-4.1.
    */
   model?:
-    | 'gpt-5'
-    | 'gpt-5-mini'
-    | 'gpt-5-nano'
-    | 'gpt-4o'
-    | 'gpt-4o-mini'
     | 'gpt-4.1'
     | 'gpt-4.1-mini'
     | 'gpt-4.1-nano'
-    | 'claude-3.7-sonnet'
-    | 'claude-3.5-haiku'
-    | 'gemini-2.0-flash'
-    | 'gemini-2.0-flash-lite'
+    | 'gpt-5'
+    | 'gpt-5-mini'
+    | 'gpt-5-nano'
+    | 'claude-4.5-sonnet'
+    | 'claude-4.5-haiku'
     | 'gemini-2.5-flash'
     | 'gemini-2.5-flash-lite'
     | null;
@@ -3550,7 +3938,8 @@ export namespace LlmUpdateParams {
 
     transfer_option:
       | TransferCallTool.TransferOptionColdTransfer
-      | TransferCallTool.TransferOptionWarmTransfer;
+      | TransferCallTool.TransferOptionWarmTransfer
+      | TransferCallTool.TransferOptionAgenticWarmTransfer;
 
     type: 'transfer_call';
 
@@ -3732,6 +4121,105 @@ export namespace LlmUpdateParams {
         type?: 'static_message';
       }
     }
+
+    export interface TransferOptionAgenticWarmTransfer {
+      /**
+       * Configuration for agentic warm transfer. Required for agentic warm transfer.
+       */
+      agentic_transfer_config: TransferOptionAgenticWarmTransfer.AgenticTransferConfig;
+
+      /**
+       * The type of the transfer.
+       */
+      type: 'agentic_warm_transfer';
+
+      /**
+       * Whether to play an audio cue when bridging the call. Defaults to true.
+       */
+      enable_bridge_audio_cue?: boolean;
+
+      /**
+       * The music to play while the caller is being transferred.
+       */
+      on_hold_music?: 'none' | 'relaxing_sound' | 'uplifting_beats' | 'ringtone';
+
+      /**
+       * If set, when transfer is successful, will say the handoff message to both the
+       * transferee and the agent receiving the transfer. Can leave either a static
+       * message or a dynamic one based on prompt. Set to null to disable warm handoff.
+       */
+      public_handoff_option?:
+        | TransferOptionAgenticWarmTransfer.WarmTransferPrompt
+        | TransferOptionAgenticWarmTransfer.WarmTransferStaticMessage;
+
+      /**
+       * If set to true, will show transferee (the user, not the AI agent) as caller when
+       * transferring, requires the telephony side to support caller id override. Retell
+       * Twilio numbers support this option.
+       */
+      show_transferee_as_caller?: boolean;
+    }
+
+    export namespace TransferOptionAgenticWarmTransfer {
+      /**
+       * Configuration for agentic warm transfer. Required for agentic warm transfer.
+       */
+      export interface AgenticTransferConfig {
+        /**
+         * The action to take when the transfer agent times out without making a decision.
+         * Defaults to cancel_transfer.
+         */
+        action_on_timeout?: 'bridge_transfer' | 'cancel_transfer';
+
+        /**
+         * The agent that will mediate the transfer decision.
+         */
+        transfer_agent?: AgenticTransferConfig.TransferAgent;
+
+        /**
+         * The maximum time to wait for the transfer agent to make a decision, in
+         * milliseconds. Defaults to 30000 (30 seconds).
+         */
+        transfer_timeout_ms?: number;
+      }
+
+      export namespace AgenticTransferConfig {
+        /**
+         * The agent that will mediate the transfer decision.
+         */
+        export interface TransferAgent {
+          /**
+           * The agent ID of the transfer agent. This agent must have isTransferAgent set to
+           * true and should use bridge_transfer and cancel_transfer tools (for Retell LLM)
+           * or BridgeTransferNode and CancelTransferNode (for Conversation Flow).
+           */
+          agent_id: string;
+
+          /**
+           * The version of the transfer agent to use.
+           */
+          agent_version: number;
+        }
+      }
+
+      export interface WarmTransferPrompt {
+        /**
+         * The prompt to be used for warm handoff. Can contain dynamic variables.
+         */
+        prompt?: string;
+
+        type?: 'prompt';
+      }
+
+      export interface WarmTransferStaticMessage {
+        /**
+         * The static message to be used for warm handoff. Can contain dynamic variables.
+         */
+        message?: string;
+
+        type?: 'static_message';
+      }
+    }
   }
 
   export interface CheckAvailabilityCalTool {
@@ -4356,7 +4844,8 @@ export namespace LlmUpdateParams {
 
       transfer_option:
         | TransferCallTool.TransferOptionColdTransfer
-        | TransferCallTool.TransferOptionWarmTransfer;
+        | TransferCallTool.TransferOptionWarmTransfer
+        | TransferCallTool.TransferOptionAgenticWarmTransfer;
 
       type: 'transfer_call';
 
@@ -4538,6 +5027,105 @@ export namespace LlmUpdateParams {
           type?: 'static_message';
         }
       }
+
+      export interface TransferOptionAgenticWarmTransfer {
+        /**
+         * Configuration for agentic warm transfer. Required for agentic warm transfer.
+         */
+        agentic_transfer_config: TransferOptionAgenticWarmTransfer.AgenticTransferConfig;
+
+        /**
+         * The type of the transfer.
+         */
+        type: 'agentic_warm_transfer';
+
+        /**
+         * Whether to play an audio cue when bridging the call. Defaults to true.
+         */
+        enable_bridge_audio_cue?: boolean;
+
+        /**
+         * The music to play while the caller is being transferred.
+         */
+        on_hold_music?: 'none' | 'relaxing_sound' | 'uplifting_beats' | 'ringtone';
+
+        /**
+         * If set, when transfer is successful, will say the handoff message to both the
+         * transferee and the agent receiving the transfer. Can leave either a static
+         * message or a dynamic one based on prompt. Set to null to disable warm handoff.
+         */
+        public_handoff_option?:
+          | TransferOptionAgenticWarmTransfer.WarmTransferPrompt
+          | TransferOptionAgenticWarmTransfer.WarmTransferStaticMessage;
+
+        /**
+         * If set to true, will show transferee (the user, not the AI agent) as caller when
+         * transferring, requires the telephony side to support caller id override. Retell
+         * Twilio numbers support this option.
+         */
+        show_transferee_as_caller?: boolean;
+      }
+
+      export namespace TransferOptionAgenticWarmTransfer {
+        /**
+         * Configuration for agentic warm transfer. Required for agentic warm transfer.
+         */
+        export interface AgenticTransferConfig {
+          /**
+           * The action to take when the transfer agent times out without making a decision.
+           * Defaults to cancel_transfer.
+           */
+          action_on_timeout?: 'bridge_transfer' | 'cancel_transfer';
+
+          /**
+           * The agent that will mediate the transfer decision.
+           */
+          transfer_agent?: AgenticTransferConfig.TransferAgent;
+
+          /**
+           * The maximum time to wait for the transfer agent to make a decision, in
+           * milliseconds. Defaults to 30000 (30 seconds).
+           */
+          transfer_timeout_ms?: number;
+        }
+
+        export namespace AgenticTransferConfig {
+          /**
+           * The agent that will mediate the transfer decision.
+           */
+          export interface TransferAgent {
+            /**
+             * The agent ID of the transfer agent. This agent must have isTransferAgent set to
+             * true and should use bridge_transfer and cancel_transfer tools (for Retell LLM)
+             * or BridgeTransferNode and CancelTransferNode (for Conversation Flow).
+             */
+            agent_id: string;
+
+            /**
+             * The version of the transfer agent to use.
+             */
+            agent_version: number;
+          }
+        }
+
+        export interface WarmTransferPrompt {
+          /**
+           * The prompt to be used for warm handoff. Can contain dynamic variables.
+           */
+          prompt?: string;
+
+          type?: 'prompt';
+        }
+
+        export interface WarmTransferStaticMessage {
+          /**
+           * The static message to be used for warm handoff. Can contain dynamic variables.
+           */
+          message?: string;
+
+          type?: 'static_message';
+        }
+      }
     }
 
     export interface CheckAvailabilityCalTool {