retell-sdk 6.2.6 → 6.2.8

package/src/resources/agent.ts

@@ -495,6 +495,11 @@ export interface AgentResponse {
    */
   is_published?: boolean;
 
+  /**
+   * Whether the agent is a transfer agent used for agentic warm transfer.
+   */
+  is_transfer_agent?: boolean;
+
   /**
    * If this option is set, the call will try to detect IVR in the first 3 minutes of
    * the call. Actions defined will be applied when the IVR is detected. Set this to
@@ -505,10 +510,7 @@ export interface AgentResponse {
   /**
    * Specifies what language(s) the agent will operate in. Accepts either a single
    * locale (e.g. `en-US`) or an array of locales for multilingual agents (e.g.
-   * `["en-US","es-ES"]`). The scalar value `multi` is deprecated but still accepted
-   * as a scalar, and is stored and returned as the ten locales it used to mean. It
-   * must not appear inside the array form. Send an explicit locale array instead. If
-   * unset, defaults to `en-US`.
+   * `["en-US","es-ES"]`). If unset, defaults to `en-US`.
    */
   language?:
     | 'en-US'
@@ -574,7 +576,6 @@ export interface AgentResponse {
     | 'ur-IN'
     | 'yue-CN'
     | 'uk-UA'
-    | 'multi'
     | Array<
         | 'en-US'
         | 'en-IN'
@@ -708,6 +709,7 @@ export interface AgentResponse {
     | 'gemini-3.6-flash'
     | 'gemini-3.7-flash'
     | 'gemini-3.8-flash'
+    | 'gemini-4-argon'
     | null;
 
   /**
@@ -1875,6 +1877,23 @@ export namespace AgentResponse {
      */
     execution_message_type?: 'prompt' | 'static_text';
 
+    /**
+     * SMS destination number configuration. If omitted, the message is sent to the
+     * customer number on the call.
+     */
+    sms_destination?: SendSMSTool.DestinationCustomerNumber | SendSMSTool.DestinationPhoneNumber | unknown;
+
+    /**
+     * SMS sender number configuration. If omitted, the message is sent from the
+     * agent's phone number.
+     */
+    sms_sender?: SendSMSTool.SenderCurrentNumber | SendSMSTool.SenderRetellLongCode | unknown;
+
+    /**
+     * Whether the agent should speak after the SMS tool finishes execution.
+     */
+    speak_after_execution?: boolean;
+
     /**
      * If true, the agent will speak a short line before sending the SMS. If omitted,
      * defaults to true (same as end_call / transfer_call tools).
@@ -1951,6 +1970,33 @@ export namespace AgentResponse {
         right?: string;
       }
     }
+
+    export interface DestinationCustomerNumber {
+      type: 'customer_number';
+    }
+
+    export interface DestinationPhoneNumber {
+      /**
+       * Destination phone number in E.164 format.
+       */
+      phone_number: string;
+
+      type: 'phone_number';
+
+      /**
+       * If true, skip E.164 validation for this phone number (same semantics as
+       * transfer_call ignore_e164_validation).
+       */
+      ignore_e164_validation?: boolean;
+    }
+
+    export interface SenderCurrentNumber {
+      type: 'current_number';
+    }
+
+    export interface SenderRetellLongCode {
+      type: 'retell_long_code';
+    }
   }
 
   export interface AppTool {
@@ -2466,6 +2512,11 @@ export namespace AgentListResponse {
      * update or creation if no updates available.
      */
     user_modified_timestamp: number;
+
+    /**
+     * Whether the agent is a transfer agent used for agentic warm transfer.
+     */
+    is_transfer_agent?: boolean;
   }
 
   export namespace Item {
@@ -2786,6 +2837,14 @@ export interface AgentCreateParams {
    */
   interruption_sensitivity?: number;
 
+  /**
+   * Whether to create the agent as a transfer agent for agentic warm transfer. You
+   * can only set this field when creating the agent. The response engine must also
+   * be configured for transfer use with is_transfer_llm or is_transfer_cf. Custom
+   * LLM agents cannot be transfer agents.
+   */
+  is_transfer_agent?: boolean;
+
   /**
    * If this option is set, the call will try to detect IVR in the first 3 minutes of
    * the call. Actions defined will be applied when the IVR is detected. Set this to
@@ -2796,10 +2855,7 @@ export interface AgentCreateParams {
   /**
    * Specifies what language(s) the agent will operate in. Accepts either a single
    * locale (e.g. `en-US`) or an array of locales for multilingual agents (e.g.
-   * `["en-US","es-ES"]`). The scalar value `multi` is deprecated but still accepted
-   * as a scalar, and is stored and returned as the ten locales it used to mean. It
-   * must not appear inside the array form. Send an explicit locale array instead. If
-   * unset, defaults to `en-US`.
+   * `["en-US","es-ES"]`). If unset, defaults to `en-US`.
    */
   language?:
     | 'en-US'
@@ -2865,7 +2921,6 @@ export interface AgentCreateParams {
     | 'ur-IN'
     | 'yue-CN'
     | 'uk-UA'
-    | 'multi'
     | Array<
         | 'en-US'
         | 'en-IN'
@@ -2999,6 +3054,7 @@ export interface AgentCreateParams {
     | 'gemini-3.6-flash'
     | 'gemini-3.7-flash'
     | 'gemini-3.8-flash'
+    | 'gemini-4-argon'
     | null;
 
   /**
@@ -4171,6 +4227,23 @@ export namespace AgentCreateParams {
      */
     execution_message_type?: 'prompt' | 'static_text';
 
+    /**
+     * SMS destination number configuration. If omitted, the message is sent to the
+     * customer number on the call.
+     */
+    sms_destination?: SendSMSTool.DestinationCustomerNumber | SendSMSTool.DestinationPhoneNumber | unknown;
+
+    /**
+     * SMS sender number configuration. If omitted, the message is sent from the
+     * agent's phone number.
+     */
+    sms_sender?: SendSMSTool.SenderCurrentNumber | SendSMSTool.SenderRetellLongCode | unknown;
+
+    /**
+     * Whether the agent should speak after the SMS tool finishes execution.
+     */
+    speak_after_execution?: boolean;
+
     /**
      * If true, the agent will speak a short line before sending the SMS. If omitted,
      * defaults to true (same as end_call / transfer_call tools).
@@ -4247,6 +4320,33 @@ export namespace AgentCreateParams {
         right?: string;
       }
     }
+
+    export interface DestinationCustomerNumber {
+      type: 'customer_number';
+    }
+
+    export interface DestinationPhoneNumber {
+      /**
+       * Destination phone number in E.164 format.
+       */
+      phone_number: string;
+
+      type: 'phone_number';
+
+      /**
+       * If true, skip E.164 validation for this phone number (same semantics as
+       * transfer_call ignore_e164_validation).
+       */
+      ignore_e164_validation?: boolean;
+    }
+
+    export interface SenderCurrentNumber {
+      type: 'current_number';
+    }
+
+    export interface SenderRetellLongCode {
+      type: 'retell_long_code';
+    }
   }
 
   export interface AppTool {
@@ -4993,10 +5093,7 @@ export interface AgentUpdateParams {
   /**
    * Body param: Specifies what language(s) the agent will operate in. Accepts either
    * a single locale (e.g. `en-US`) or an array of locales for multilingual agents
-   * (e.g. `["en-US","es-ES"]`). The scalar value `multi` is deprecated but still
-   * accepted as a scalar, and is stored and returned as the ten locales it used to
-   * mean. It must not appear inside the array form. Send an explicit locale array
-   * instead. If unset, defaults to `en-US`.
+   * (e.g. `["en-US","es-ES"]`). If unset, defaults to `en-US`.
    */
   language?:
     | 'en-US'
@@ -5062,7 +5159,6 @@ export interface AgentUpdateParams {
     | 'ur-IN'
     | 'yue-CN'
     | 'uk-UA'
-    | 'multi'
     | Array<
         | 'en-US'
         | 'en-IN'
@@ -5196,6 +5292,7 @@ export interface AgentUpdateParams {
     | 'gemini-3.6-flash'
     | 'gemini-3.7-flash'
     | 'gemini-3.8-flash'
+    | 'gemini-4-argon'
     | null;
 
   /**
@@ -6344,6 +6441,23 @@ export namespace AgentUpdateParams {
      */
     execution_message_type?: 'prompt' | 'static_text';
 
+    /**
+     * SMS destination number configuration. If omitted, the message is sent to the
+     * customer number on the call.
+     */
+    sms_destination?: SendSMSTool.DestinationCustomerNumber | SendSMSTool.DestinationPhoneNumber | unknown;
+
+    /**
+     * SMS sender number configuration. If omitted, the message is sent from the
+     * agent's phone number.
+     */
+    sms_sender?: SendSMSTool.SenderCurrentNumber | SendSMSTool.SenderRetellLongCode | unknown;
+
+    /**
+     * Whether the agent should speak after the SMS tool finishes execution.
+     */
+    speak_after_execution?: boolean;
+
     /**
      * If true, the agent will speak a short line before sending the SMS. If omitted,
      * defaults to true (same as end_call / transfer_call tools).
@@ -6420,6 +6534,33 @@ export namespace AgentUpdateParams {
         right?: string;
       }
     }
+
+    export interface DestinationCustomerNumber {
+      type: 'customer_number';
+    }
+
+    export interface DestinationPhoneNumber {
+      /**
+       * Destination phone number in E.164 format.
+       */
+      phone_number: string;
+
+      type: 'phone_number';
+
+      /**
+       * If true, skip E.164 validation for this phone number (same semantics as
+       * transfer_call ignore_e164_validation).
+       */
+      ignore_e164_validation?: boolean;
+    }
+
+    export interface SenderCurrentNumber {
+      type: 'current_number';
+    }
+
+    export interface SenderRetellLongCode {
+      type: 'retell_long_code';
+    }
   }
 
   export interface AppTool {
@@ -6973,6 +7114,11 @@ export namespace AgentListParams {
   export interface FilterCriteria {
     channel?: FilterCriteria.Channel;
 
+    /**
+     * Filter by whether the agent is a transfer agent.
+     */
+    is_transfer_agent?: FilterCriteria.IsTransferAgent;
+
     /**
      * Case-insensitive substring search over agent name, plus substring search over
      * agent id.
@@ -6991,6 +7137,17 @@ export namespace AgentListParams {
 
       value: 'voice' | 'chat';
     }
+
+    /**
+     * Filter by whether the agent is a transfer agent.
+     */
+    export interface IsTransferAgent {
+      op: 'eq';
+
+      type: 'boolean';
+
+      value: boolean;
+    }
   }
 }
 

package/src/resources/batch-call.ts

@@ -199,7 +199,9 @@ export namespace BatchCallCreateBatchCallParams {
     export interface AgentOverride {
       /**
        * Override agent configuration settings. Any properties specified here will
-       * override the base agent configuration for this call.
+       * override the base agent configuration for this call. If a Retell LLM or
+       * Conversation Flow response engine is specified without a version, it uses the
+       * latest version.
        */
       agent?: AgentOverride.Agent;
 
@@ -214,7 +216,7 @@ export namespace BatchCallCreateBatchCallParams {
       /**
        * Override Retell LLM configuration settings. Only applicable when using Retell
        * LLM as the response engine. Supported attributes - model, s2s_model,
-       * model_temperature, model_high_priority, tool_call_strict_mode,
+       * model_temperature, model_high_priority, model_ultrafast, tool_call_strict_mode,
        * knowledge_base_ids, kb_config, start_speaker, begin_after_user_silence_ms,
        * begin_message.
        */
@@ -224,7 +226,9 @@ export namespace BatchCallCreateBatchCallParams {
     export namespace AgentOverride {
       /**
        * Override agent configuration settings. Any properties specified here will
-       * override the base agent configuration for this call.
+       * override the base agent configuration for this call. If a Retell LLM or
+       * Conversation Flow response engine is specified without a version, it uses the
+       * latest version.
        */
       export interface Agent {
         /**
@@ -477,10 +481,7 @@ export namespace BatchCallCreateBatchCallParams {
         /**
          * Specifies what language(s) the agent will operate in. Accepts either a single
          * locale (e.g. `en-US`) or an array of locales for multilingual agents (e.g.
-         * `["en-US","es-ES"]`). The scalar value `multi` is deprecated but still accepted
-         * as a scalar, and is stored and returned as the ten locales it used to mean. It
-         * must not appear inside the array form. Send an explicit locale array instead. If
-         * unset, defaults to `en-US`.
+         * `["en-US","es-ES"]`). If unset, defaults to `en-US`.
          */
         language?:
           | 'en-US'
@@ -546,7 +547,6 @@ export namespace BatchCallCreateBatchCallParams {
           | 'ur-IN'
           | 'yue-CN'
           | 'uk-UA'
-          | 'multi'
           | Array<
               | 'en-US'
               | 'en-IN'
@@ -680,6 +680,7 @@ export namespace BatchCallCreateBatchCallParams {
           | 'gemini-3.6-flash'
           | 'gemini-3.7-flash'
           | 'gemini-3.8-flash'
+          | 'gemini-4-argon'
           | null;
 
         /**
@@ -1817,6 +1818,26 @@ export namespace BatchCallCreateBatchCallParams {
            */
           execution_message_type?: 'prompt' | 'static_text';
 
+          /**
+           * SMS destination number configuration. If omitted, the message is sent to the
+           * customer number on the call.
+           */
+          sms_destination?:
+            | SendSMSTool.DestinationCustomerNumber
+            | SendSMSTool.DestinationPhoneNumber
+            | unknown;
+
+          /**
+           * SMS sender number configuration. If omitted, the message is sent from the
+           * agent's phone number.
+           */
+          sms_sender?: SendSMSTool.SenderCurrentNumber | SendSMSTool.SenderRetellLongCode | unknown;
+
+          /**
+           * Whether the agent should speak after the SMS tool finishes execution.
+           */
+          speak_after_execution?: boolean;
+
           /**
            * If true, the agent will speak a short line before sending the SMS. If omitted,
            * defaults to true (same as end_call / transfer_call tools).
@@ -1893,6 +1914,33 @@ export namespace BatchCallCreateBatchCallParams {
               right?: string;
             }
           }
+
+          export interface DestinationCustomerNumber {
+            type: 'customer_number';
+          }
+
+          export interface DestinationPhoneNumber {
+            /**
+             * Destination phone number in E.164 format.
+             */
+            phone_number: string;
+
+            type: 'phone_number';
+
+            /**
+             * If true, skip E.164 validation for this phone number (same semantics as
+             * transfer_call ignore_e164_validation).
+             */
+            ignore_e164_validation?: boolean;
+          }
+
+          export interface SenderCurrentNumber {
+            type: 'current_number';
+          }
+
+          export interface SenderRetellLongCode {
+            type: 'retell_long_code';
+          }
         }
 
         export interface AppTool {
@@ -2515,7 +2563,8 @@ export namespace BatchCallCreateBatchCallParams {
             | 'gemini-3.5-flash-lite'
             | 'gemini-3.6-flash'
             | 'gemini-3.7-flash'
-            | 'gemini-3.8-flash';
+            | 'gemini-3.8-flash'
+            | 'gemini-4-argon';
 
           /**
            * Type of model choice
@@ -2526,6 +2575,13 @@ export namespace BatchCallCreateBatchCallParams {
            * Whether to use high priority pool with more dedicated resource, default false
            */
           high_priority?: boolean;
+
+          /**
+           * Whether to use the ultrafast tier for much faster response generation, default
+           * false. Only supported by gpt-6.1-sol on voice agents; ignored otherwise. Takes
+           * precedence over high_priority.
+           */
+          ultrafast?: boolean;
         }
 
         export interface ModelChoiceS2S {
@@ -2550,7 +2606,7 @@ export namespace BatchCallCreateBatchCallParams {
       /**
        * Override Retell LLM configuration settings. Only applicable when using Retell
        * LLM as the response engine. Supported attributes - model, s2s_model,
-       * model_temperature, model_high_priority, tool_call_strict_mode,
+       * model_temperature, model_high_priority, model_ultrafast, tool_call_strict_mode,
        * knowledge_base_ids, kb_config, start_speaker, begin_after_user_silence_ms,
        * begin_message.
        */
@@ -2614,6 +2670,7 @@ export namespace BatchCallCreateBatchCallParams {
           | 'gemini-3.6-flash'
           | 'gemini-3.7-flash'
           | 'gemini-3.8-flash'
+          | 'gemini-4-argon'
           | null;
 
         /**
@@ -2631,6 +2688,14 @@ export namespace BatchCallCreateBatchCallParams {
          */
         model_temperature?: number;
 
+        /**
+         * If set to true, will use the ultrafast tier for much faster response generation,
+         * default to false. Only supported by gpt-6.1-sol on voice agents; ignored
+         * otherwise. Takes precedence over model_high_priority. This feature comes with a
+         * higher cost.
+         */
+        model_ultrafast?: boolean | null;
+
         /**
          * Select the underlying speech to speech model. Can only set this or model, not
          * both.