retell-sdk 6.2.6 → 6.2.8

package/src/resources/call.ts

@@ -177,7 +177,8 @@ export class Call extends APIResource {
   /**
    * Take over an in-progress call from the AI agent. The agent stops responding and
    * the specified live-listen participant is allowed to speak directly to the
-   * caller. The call must be in ONGOING status.
+   * caller. The call must be in ONGOING status. Calls cannot be taken over while a
+   * PCI session is active.
    *
    * @example
    * ```ts
@@ -7122,7 +7123,9 @@ export namespace CallCreatePhoneCallParams {
   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;
 
@@ -7137,7 +7140,7 @@ export namespace CallCreatePhoneCallParams {
     /**
      * 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.
      */
@@ -7147,7 +7150,9 @@ export namespace CallCreatePhoneCallParams {
   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 {
       /**
@@ -7400,10 +7405,7 @@ export namespace CallCreatePhoneCallParams {
       /**
        * 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'
@@ -7469,7 +7471,6 @@ export namespace CallCreatePhoneCallParams {
         | 'ur-IN'
         | 'yue-CN'
         | 'uk-UA'
-        | 'multi'
         | Array<
             | 'en-US'
             | 'en-IN'
@@ -7603,6 +7604,7 @@ export namespace CallCreatePhoneCallParams {
         | 'gemini-3.6-flash'
         | 'gemini-3.7-flash'
         | 'gemini-3.8-flash'
+        | 'gemini-4-argon'
         | null;
 
       /**
@@ -8740,6 +8742,26 @@ export namespace CallCreatePhoneCallParams {
          */
         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).
@@ -8816,6 +8838,33 @@ export namespace CallCreatePhoneCallParams {
             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 {
@@ -9438,7 +9487,8 @@ export namespace CallCreatePhoneCallParams {
           | '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
@@ -9449,6 +9499,13 @@ export namespace CallCreatePhoneCallParams {
          * 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 {
@@ -9473,7 +9530,7 @@ export namespace CallCreatePhoneCallParams {
     /**
      * 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.
      */
@@ -9537,6 +9594,7 @@ export namespace CallCreatePhoneCallParams {
         | 'gemini-3.6-flash'
         | 'gemini-3.7-flash'
         | 'gemini-3.8-flash'
+        | 'gemini-4-argon'
         | null;
 
       /**
@@ -9554,6 +9612,14 @@ export namespace CallCreatePhoneCallParams {
        */
       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.
@@ -9656,7 +9722,9 @@ export namespace CallCreateWebCallParams {
   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;
 
@@ -9671,7 +9739,7 @@ export namespace CallCreateWebCallParams {
     /**
      * 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.
      */
@@ -9681,7 +9749,9 @@ export namespace CallCreateWebCallParams {
   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 {
       /**
@@ -9934,10 +10004,7 @@ export namespace CallCreateWebCallParams {
       /**
        * 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'
@@ -10003,7 +10070,6 @@ export namespace CallCreateWebCallParams {
         | 'ur-IN'
         | 'yue-CN'
         | 'uk-UA'
-        | 'multi'
         | Array<
             | 'en-US'
             | 'en-IN'
@@ -10137,6 +10203,7 @@ export namespace CallCreateWebCallParams {
         | 'gemini-3.6-flash'
         | 'gemini-3.7-flash'
         | 'gemini-3.8-flash'
+        | 'gemini-4-argon'
         | null;
 
       /**
@@ -11274,6 +11341,26 @@ export namespace CallCreateWebCallParams {
          */
         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).
@@ -11350,6 +11437,33 @@ export namespace CallCreateWebCallParams {
             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 {
@@ -11972,7 +12086,8 @@ export namespace CallCreateWebCallParams {
           | '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
@@ -11983,6 +12098,13 @@ export namespace CallCreateWebCallParams {
          * 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 {
@@ -12007,7 +12129,7 @@ export namespace CallCreateWebCallParams {
     /**
      * 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.
      */
@@ -12071,6 +12193,7 @@ export namespace CallCreateWebCallParams {
         | 'gemini-3.6-flash'
         | 'gemini-3.7-flash'
         | 'gemini-3.8-flash'
+        | 'gemini-4-argon'
         | null;
 
       /**
@@ -12088,6 +12211,14 @@ export namespace CallCreateWebCallParams {
        */
       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.
@@ -12190,7 +12321,9 @@ export namespace CallRegisterPhoneCallParams {
   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;
 
@@ -12205,7 +12338,7 @@ export namespace CallRegisterPhoneCallParams {
     /**
      * 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.
      */
@@ -12215,7 +12348,9 @@ export namespace CallRegisterPhoneCallParams {
   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 {
       /**
@@ -12468,10 +12603,7 @@ export namespace CallRegisterPhoneCallParams {
       /**
        * 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'
@@ -12537,7 +12669,6 @@ export namespace CallRegisterPhoneCallParams {
         | 'ur-IN'
         | 'yue-CN'
         | 'uk-UA'
-        | 'multi'
         | Array<
             | 'en-US'
             | 'en-IN'
@@ -12671,6 +12802,7 @@ export namespace CallRegisterPhoneCallParams {
         | 'gemini-3.6-flash'
         | 'gemini-3.7-flash'
         | 'gemini-3.8-flash'
+        | 'gemini-4-argon'
         | null;
 
       /**
@@ -13808,6 +13940,26 @@ export namespace CallRegisterPhoneCallParams {
          */
         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).
@@ -13884,6 +14036,33 @@ export namespace CallRegisterPhoneCallParams {
             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 {
@@ -14506,7 +14685,8 @@ export namespace CallRegisterPhoneCallParams {
           | '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
@@ -14517,6 +14697,13 @@ export namespace CallRegisterPhoneCallParams {
          * 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 {
@@ -14541,7 +14728,7 @@ export namespace CallRegisterPhoneCallParams {
     /**
      * 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.
      */
@@ -14605,6 +14792,7 @@ export namespace CallRegisterPhoneCallParams {
         | 'gemini-3.6-flash'
         | 'gemini-3.7-flash'
         | 'gemini-3.8-flash'
+        | 'gemini-4-argon'
         | null;
 
       /**
@@ -14622,6 +14810,14 @@ export namespace CallRegisterPhoneCallParams {
        */
       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.