retell-sdk 4.66.0 → 5.1.0

package/src/resources/agent.ts

@@ -1,8 +1,10 @@
 // File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
 
-import { APIResource } from '../resource';
-import { isRequestOptions } from '../core';
-import * as Core from '../core';
+import { APIResource } from '../core/resource';
+import { APIPromise } from '../core/api-promise';
+import { buildHeaders } from '../internal/headers';
+import { RequestOptions } from '../internal/request-options';
+import { path } from '../internal/utils/path';
 
 export class Agent extends APIResource {
   /**
@@ -19,7 +21,7 @@ export class Agent extends APIResource {
    * });
    * ```
    */
-  create(body: AgentCreateParams, options?: Core.RequestOptions): Core.APIPromise<AgentResponse> {
+  create(body: AgentCreateParams, options?: RequestOptions): APIPromise<AgentResponse> {
     return this._client.post('/create-agent', { body, ...options });
   }
 
@@ -34,20 +36,11 @@ export class Agent extends APIResource {
    * ```
    */
   retrieve(
-    agentId: string,
-    query?: AgentRetrieveParams,
-    options?: Core.RequestOptions,
-  ): Core.APIPromise<AgentResponse>;
-  retrieve(agentId: string, options?: Core.RequestOptions): Core.APIPromise<AgentResponse>;
-  retrieve(
-    agentId: string,
-    query: AgentRetrieveParams | Core.RequestOptions = {},
-    options?: Core.RequestOptions,
-  ): Core.APIPromise<AgentResponse> {
-    if (isRequestOptions(query)) {
-      return this.retrieve(agentId, {}, query);
-    }
-    return this._client.get(`/get-agent/${agentId}`, { query, ...options });
+    agentID: string,
+    query: AgentRetrieveParams | null | undefined = {},
+    options?: RequestOptions,
+  ): APIPromise<AgentResponse> {
+    return this._client.get(path`/get-agent/${agentID}`, { query, ...options });
   }
 
   /**
@@ -61,13 +54,9 @@ export class Agent extends APIResource {
    * );
    * ```
    */
-  update(
-    agentId: string,
-    params: AgentUpdateParams,
-    options?: Core.RequestOptions,
-  ): Core.APIPromise<AgentResponse> {
+  update(agentID: string, params: AgentUpdateParams, options?: RequestOptions): APIPromise<AgentResponse> {
     const { version, ...body } = params;
-    return this._client.patch(`/update-agent/${agentId}`, { query: { version }, body, ...options });
+    return this._client.patch(path`/update-agent/${agentID}`, { query: { version }, body, ...options });
   }
 
   /**
@@ -78,15 +67,10 @@ export class Agent extends APIResource {
    * const agentResponses = await client.agent.list();
    * ```
    */
-  list(query?: AgentListParams, options?: Core.RequestOptions): Core.APIPromise<AgentListResponse>;
-  list(options?: Core.RequestOptions): Core.APIPromise<AgentListResponse>;
   list(
-    query: AgentListParams | Core.RequestOptions = {},
-    options?: Core.RequestOptions,
-  ): Core.APIPromise<AgentListResponse> {
-    if (isRequestOptions(query)) {
-      return this.list({}, query);
-    }
+    query: AgentListParams | null | undefined = {},
+    options?: RequestOptions,
+  ): APIPromise<AgentListResponse> {
     return this._client.get('/list-agents', { query, ...options });
   }
 
@@ -100,10 +84,10 @@ export class Agent extends APIResource {
    * );
    * ```
    */
-  delete(agentId: string, options?: Core.RequestOptions): Core.APIPromise<void> {
-    return this._client.delete(`/delete-agent/${agentId}`, {
+  delete(agentID: string, options?: RequestOptions): APIPromise<void> {
+    return this._client.delete(path`/delete-agent/${agentID}`, {
       ...options,
-      headers: { Accept: '*/*', ...options?.headers },
+      headers: buildHeaders([{ Accept: '*/*' }, options?.headers]),
     });
   }
 
@@ -117,8 +101,8 @@ export class Agent extends APIResource {
    * );
    * ```
    */
-  getVersions(agentId: string, options?: Core.RequestOptions): Core.APIPromise<AgentGetVersionsResponse> {
-    return this._client.get(`/get-agent-versions/${agentId}`, options);
+  getVersions(agentID: string, options?: RequestOptions): APIPromise<AgentGetVersionsResponse> {
+    return this._client.get(path`/get-agent-versions/${agentID}`, options);
   }
 
   /**
@@ -132,10 +116,10 @@ export class Agent extends APIResource {
    * );
    * ```
    */
-  publish(agentId: string, options?: Core.RequestOptions): Core.APIPromise<void> {
-    return this._client.post(`/publish-agent/${agentId}`, {
+  publish(agentID: string, options?: RequestOptions): APIPromise<void> {
+    return this._client.post(path`/publish-agent/${agentID}`, {
       ...options,
-      headers: { Accept: '*/*', ...options?.headers },
+      headers: buildHeaders([{ Accept: '*/*' }, options?.headers]),
     });
   }
 }
@@ -162,6 +146,11 @@ export interface AgentResponse {
     | AgentResponse.ResponseEngineCustomLm
     | AgentResponse.ResponseEngineConversationFlow;
 
+  /**
+   * Version of the agent.
+   */
+  version: number;
+
   /**
    * Unique voice id used for the agent. Find list of available voices and their
    * preview in Dashboard.
@@ -185,24 +174,18 @@ export interface AgentResponse {
    *
    * - `coffee-shop`: Coffee shop ambience with people chatting in background.
    *   [Listen to Ambience](https://retell-utils-public.s3.us-west-2.amazonaws.com/coffee-shop.wav)
-   *
    * - `convention-hall`: Convention hall ambience, with some echo and people
    *   chatting in background.
    *   [Listen to Ambience](https://retell-utils-public.s3.us-west-2.amazonaws.com/convention-hall.wav)
-   *
    * - `summer-outdoor`: Summer outdoor ambience with cicada chirping.
    *   [Listen to Ambience](https://retell-utils-public.s3.us-west-2.amazonaws.com/summer-outdoor.wav)
-   *
    * - `mountain-outdoor`: Mountain outdoor ambience with birds singing.
    *   [Listen to Ambience](https://retell-utils-public.s3.us-west-2.amazonaws.com/mountain-outdoor.wav)
-   *
    * - `static-noise`: Constant static noise.
    *   [Listen to Ambience](https://retell-utils-public.s3.us-west-2.amazonaws.com/static-noise.wav)
-   *
    * - `call-center`: Call center work noise.
    *   [Listen to Ambience](https://retell-utils-public.s3.us-west-2.amazonaws.com/call-center.wav)
-   *
-   * Set to `null` to remove ambient sound from this agent.
+   *   Set to `null` to remove ambient sound from this agent.
    */
   ambient_sound?:
     | 'coffee-shop'
@@ -266,6 +249,11 @@ export interface AgentResponse {
    */
   boosted_keywords?: Array<string> | null;
 
+  /**
+   * Custom STT configuration. Only used when stt_mode is set to custom.
+   */
+  custom_stt_config?: AgentResponse.CustomSttConfig;
+
   /**
    * Granular setting to manage how Retell stores sensitive data (transcripts,
    * recordings, logs, etc.). This replaces the deprecated
@@ -280,9 +268,10 @@ export interface AgentResponse {
   data_storage_setting?: 'everything' | 'everything_except_pii' | 'basic_attributes_only';
 
   /**
-   * If set, determines what denoising mode to use. Default to noise-cancellation.
+   * If set, determines what denoising mode to use. Use "no-denoise" to bypass all
+   * audio denoising. Default to noise-cancellation.
    */
-  denoising_mode?: 'noise-cancellation' | 'noise-and-background-speech-cancellation';
+  denoising_mode?: 'no-denoise' | 'noise-cancellation' | 'noise-and-background-speech-cancellation';
 
   /**
    * Controls whether the agent would backchannel (agent interjects the speaker with
@@ -292,6 +281,18 @@ export interface AgentResponse {
    */
   enable_backchannel?: boolean;
 
+  /**
+   * If set to true, will enable dynamic voice speed adjustment based on the user's
+   * speech rate and conversation context. If unset, default value false will apply.
+   */
+  enable_dynamic_voice_speed?: boolean;
+
+  /**
+   * If set to true, will detect whether the call enters a voicemail. Note that this
+   * feature is only available for phone calls.
+   */
+  enable_voicemail_detection?: 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).
@@ -307,6 +308,12 @@ export interface AgentResponse {
    */
   fallback_voice_ids?: Array<string> | null;
 
+  /**
+   * Configuration for guardrail checks to detect and prevent prohibited topics in
+   * agent output and user input.
+   */
+  guardrail_config?: AgentResponse.GuardrailConfig;
+
   /**
    * Controls how sensitive the agent is to user interruptions. Value ranging from
    * [0,1]. Lower value means it will take longer / more words for user to interrupt
@@ -316,11 +323,24 @@ export interface AgentResponse {
    */
   interruption_sensitivity?: number;
 
+  /**
+   * Whether the agent is public. When set to true, the agent is available for public
+   * agent preview link.
+   */
+  is_public?: boolean | null;
+
   /**
    * Whether the agent is published.
    */
   is_published?: 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
+   * null to disable IVR detection.
+   */
+  ivr_option?: AgentResponse.IvrOption | null;
+
   /**
    * Specifies what language (and dialect) the speech recognition will operate in.
    * For instance, selecting `en-GB` optimizes speech recognition for British
@@ -363,6 +383,9 @@ export interface AgentResponse {
     | 'no-NO'
     | 'sk-SK'
     | 'sv-SE'
+    | 'lt-LT'
+    | 'lv-LV'
+    | 'cs-CZ'
     | 'ms-MY'
     | 'af-ZA'
     | 'ar-SA'
@@ -440,12 +463,15 @@ export interface AgentResponse {
     | 'gpt-4.1-mini'
     | 'gpt-4.1-nano'
     | 'gpt-5'
+    | 'gpt-5.1'
+    | 'gpt-5.2'
     | 'gpt-5-mini'
     | 'gpt-5-nano'
     | 'claude-4.5-sonnet'
     | 'claude-4.5-haiku'
     | 'gemini-2.5-flash'
     | 'gemini-2.5-flash-lite'
+    | 'gemini-3.0-flash'
     | null;
 
   /**
@@ -493,16 +519,17 @@ export interface AgentResponse {
 
   /**
    * If set, determines whether speech to text should focus on latency or accuracy.
-   * Default to fast mode.
+   * Default to fast mode. When set to custom, custom_stt_config must be provided.
    */
-  stt_mode?: 'fast' | 'accurate';
+  stt_mode?: 'fast' | 'accurate' | 'custom';
 
   user_dtmf_options?: AgentResponse.UserDtmfOptions | null;
 
   /**
-   * Version of the agent.
+   * Optional description of the agent version. Used for your own reference and
+   * documentation.
    */
-  version?: number;
+  version_description?: string | null;
 
   /**
    * If set, determines the vocabulary set to use for transcription. This setting
@@ -512,10 +539,15 @@ export interface AgentResponse {
   vocab_specialization?: 'general' | 'medical';
 
   /**
-   * Optionally set the voice model used for the selected voice. Currently only
-   * elevenlab voices have voice model selections. Set to null to remove voice model
-   * selection, and default ones will apply. Check out the dashboard for details on
-   * each voice model.
+   * Controls the emotional tone of the agent's voice. Currently supported for
+   * Cartesia and Minimax TTS providers. If unset, no emotion will be used.
+   */
+  voice_emotion?: 'calm' | 'sympathetic' | 'happy' | 'sad' | 'angry' | 'fearful' | 'surprised' | null;
+
+  /**
+   * Select the voice model used for the selected voice. Each provider has a set of
+   * available voice models. Set to null to remove voice model selection, and default
+   * ones will apply. Check out dashboard for more details of each voice model.
    */
   voice_model?:
     | 'eleven_turbo_v2'
@@ -523,8 +555,14 @@ export interface AgentResponse {
     | 'eleven_turbo_v2_5'
     | 'eleven_flash_v2_5'
     | 'eleven_multilingual_v2'
+    | 'sonic-2'
+    | 'sonic-3'
+    | 'sonic-3-latest'
+    | 'sonic-turbo'
     | 'tts-1'
     | 'gpt-4o-mini-tts'
+    | 'speech-02-turbo'
+    | 'speech-2.8-turbo'
     | null;
 
   /**
@@ -542,6 +580,21 @@ 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
@@ -557,6 +610,21 @@ export interface AgentResponse {
    */
   volume?: number;
 
+  /**
+   * Which webhook events this agent should receive. If not set, defaults to
+   * call_started, call_ended, call_analyzed.
+   */
+  webhook_events?: Array<
+    | 'call_started'
+    | 'call_ended'
+    | 'call_analyzed'
+    | 'transcript_updated'
+    | 'transfer_started'
+    | 'transfer_bridged'
+    | 'transfer_cancelled'
+    | 'transfer_ended'
+  > | null;
+
   /**
    * The timeout for the webhook in milliseconds. If not set, default value of 10000
    * will apply.
@@ -619,6 +687,65 @@ export namespace AgentResponse {
     version?: number | null;
   }
 
+  /**
+   * Custom STT configuration. Only used when stt_mode is set to custom.
+   */
+  export interface CustomSttConfig {
+    /**
+     * Endpointing timeout in milliseconds. Minimum is 100 for azure, 10 for deepgram.
+     */
+    endpointing_ms: number;
+
+    /**
+     * The STT provider to use.
+     */
+    provider: 'azure' | 'deepgram';
+  }
+
+  /**
+   * Configuration for guardrail checks to detect and prevent prohibited topics in
+   * agent output and user input.
+   */
+  export interface GuardrailConfig {
+    /**
+     * Selected prohibited user topic categories to check. When user messages contain
+     * these topics, the agent will respond with a placeholder message instead of
+     * processing the request.
+     */
+    input_topics?: Array<'platform_integrity_jailbreaking'> | null;
+
+    /**
+     * Selected prohibited agent topic categories to check. When agent messages contain
+     * these topics, they will be replaced with a placeholder message.
+     */
+    output_topics?: Array<
+      | 'harassment'
+      | 'self_harm'
+      | 'sexual_exploitation'
+      | 'violence'
+      | 'defense_and_national_security'
+      | 'illicit_and_harmful_activity'
+      | 'gambling'
+      | 'regulated_professional_advice'
+      | 'child_safety_and_exploitation'
+    > | null;
+  }
+
+  /**
+   * 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
+   * null to disable IVR detection.
+   */
+  export interface IvrOption {
+    action: IvrOption.Action;
+  }
+
+  export namespace IvrOption {
+    export interface Action {
+      type: 'hangup';
+    }
+  }
+
   /**
    * Configuration for PII scrubbing from transcripts and recordings.
    */
@@ -640,6 +767,7 @@ export namespace AgentResponse {
       | 'pin'
       | 'medical_id'
       | 'date_of_birth'
+      | 'customer_account_number'
     >;
 
     /**
@@ -753,7 +881,7 @@ export namespace AgentResponse {
 
     /**
      * A single key that signals the end of DTMF input. Acceptable values include any
-     * digit (0–9), the pound/hash symbol (#), or the asterisk (\*).
+     * digit (0-9), the pound/hash symbol (#), or the asterisk (\*).
      */
     termination_key?: string | null;
 
@@ -774,7 +902,8 @@ export namespace AgentResponse {
     action:
       | VoicemailOption.VoicemailActionPrompt
       | VoicemailOption.VoicemailActionStaticText
-      | VoicemailOption.VoicemailActionHangup;
+      | VoicemailOption.VoicemailActionHangup
+      | VoicemailOption.VoicemailActionBridgeTransfer;
   }
 
   export namespace VoicemailOption {
@@ -800,6 +929,10 @@ export namespace AgentResponse {
     export interface VoicemailActionHangup {
       type: 'hangup';
     }
+
+    export interface VoicemailActionBridgeTransfer {
+      type: 'bridge_transfer';
+    }
   }
 }
 
@@ -841,24 +974,18 @@ export interface AgentCreateParams {
    *
    * - `coffee-shop`: Coffee shop ambience with people chatting in background.
    *   [Listen to Ambience](https://retell-utils-public.s3.us-west-2.amazonaws.com/coffee-shop.wav)
-   *
    * - `convention-hall`: Convention hall ambience, with some echo and people
    *   chatting in background.
    *   [Listen to Ambience](https://retell-utils-public.s3.us-west-2.amazonaws.com/convention-hall.wav)
-   *
    * - `summer-outdoor`: Summer outdoor ambience with cicada chirping.
    *   [Listen to Ambience](https://retell-utils-public.s3.us-west-2.amazonaws.com/summer-outdoor.wav)
-   *
    * - `mountain-outdoor`: Mountain outdoor ambience with birds singing.
    *   [Listen to Ambience](https://retell-utils-public.s3.us-west-2.amazonaws.com/mountain-outdoor.wav)
-   *
    * - `static-noise`: Constant static noise.
    *   [Listen to Ambience](https://retell-utils-public.s3.us-west-2.amazonaws.com/static-noise.wav)
-   *
    * - `call-center`: Call center work noise.
    *   [Listen to Ambience](https://retell-utils-public.s3.us-west-2.amazonaws.com/call-center.wav)
-   *
-   * Set to `null` to remove ambient sound from this agent.
+   *   Set to `null` to remove ambient sound from this agent.
    */
   ambient_sound?:
     | 'coffee-shop'
@@ -922,6 +1049,11 @@ export interface AgentCreateParams {
    */
   boosted_keywords?: Array<string> | null;
 
+  /**
+   * Custom STT configuration. Only used when stt_mode is set to custom.
+   */
+  custom_stt_config?: AgentCreateParams.CustomSttConfig;
+
   /**
    * Granular setting to manage how Retell stores sensitive data (transcripts,
    * recordings, logs, etc.). This replaces the deprecated
@@ -936,9 +1068,10 @@ export interface AgentCreateParams {
   data_storage_setting?: 'everything' | 'everything_except_pii' | 'basic_attributes_only';
 
   /**
-   * If set, determines what denoising mode to use. Default to noise-cancellation.
+   * If set, determines what denoising mode to use. Use "no-denoise" to bypass all
+   * audio denoising. Default to noise-cancellation.
    */
-  denoising_mode?: 'noise-cancellation' | 'noise-and-background-speech-cancellation';
+  denoising_mode?: 'no-denoise' | 'noise-cancellation' | 'noise-and-background-speech-cancellation';
 
   /**
    * Controls whether the agent would backchannel (agent interjects the speaker with
@@ -948,6 +1081,18 @@ export interface AgentCreateParams {
    */
   enable_backchannel?: boolean;
 
+  /**
+   * If set to true, will enable dynamic voice speed adjustment based on the user's
+   * speech rate and conversation context. If unset, default value false will apply.
+   */
+  enable_dynamic_voice_speed?: boolean;
+
+  /**
+   * If set to true, will detect whether the call enters a voicemail. Note that this
+   * feature is only available for phone calls.
+   */
+  enable_voicemail_detection?: 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).
@@ -963,6 +1108,12 @@ export interface AgentCreateParams {
    */
   fallback_voice_ids?: Array<string> | null;
 
+  /**
+   * Configuration for guardrail checks to detect and prevent prohibited topics in
+   * agent output and user input.
+   */
+  guardrail_config?: AgentCreateParams.GuardrailConfig;
+
   /**
    * Controls how sensitive the agent is to user interruptions. Value ranging from
    * [0,1]. Lower value means it will take longer / more words for user to interrupt
@@ -972,6 +1123,19 @@ export interface AgentCreateParams {
    */
   interruption_sensitivity?: number;
 
+  /**
+   * Whether the agent is public. When set to true, the agent is available for public
+   * agent preview link.
+   */
+  is_public?: boolean | null;
+
+  /**
+   * 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
+   * null to disable IVR detection.
+   */
+  ivr_option?: AgentCreateParams.IvrOption | null;
+
   /**
    * Specifies what language (and dialect) the speech recognition will operate in.
    * For instance, selecting `en-GB` optimizes speech recognition for British
@@ -1014,6 +1178,9 @@ export interface AgentCreateParams {
     | 'no-NO'
     | 'sk-SK'
     | 'sv-SE'
+    | 'lt-LT'
+    | 'lv-LV'
+    | 'cs-CZ'
     | 'ms-MY'
     | 'af-ZA'
     | 'ar-SA'
@@ -1091,12 +1258,15 @@ export interface AgentCreateParams {
     | 'gpt-4.1-mini'
     | 'gpt-4.1-nano'
     | 'gpt-5'
+    | 'gpt-5.1'
+    | 'gpt-5.2'
     | 'gpt-5-mini'
     | 'gpt-5-nano'
     | 'claude-4.5-sonnet'
     | 'claude-4.5-haiku'
     | 'gemini-2.5-flash'
     | 'gemini-2.5-flash-lite'
+    | 'gemini-3.0-flash'
     | null;
 
   /**
@@ -1144,12 +1314,18 @@ export interface AgentCreateParams {
 
   /**
    * If set, determines whether speech to text should focus on latency or accuracy.
-   * Default to fast mode.
+   * Default to fast mode. When set to custom, custom_stt_config must be provided.
    */
-  stt_mode?: 'fast' | 'accurate';
+  stt_mode?: 'fast' | 'accurate' | 'custom';
 
   user_dtmf_options?: AgentCreateParams.UserDtmfOptions | null;
 
+  /**
+   * Optional description of the agent version. Used for your own reference and
+   * documentation.
+   */
+  version_description?: 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.
@@ -1158,10 +1334,15 @@ export interface AgentCreateParams {
   vocab_specialization?: 'general' | 'medical';
 
   /**
-   * Optionally set the voice model used for the selected voice. Currently only
-   * elevenlab voices have voice model selections. Set to null to remove voice model
-   * selection, and default ones will apply. Check out the dashboard for details on
-   * each voice model.
+   * Controls the emotional tone of the agent's voice. Currently supported for
+   * Cartesia and Minimax TTS providers. If unset, no emotion will be used.
+   */
+  voice_emotion?: 'calm' | 'sympathetic' | 'happy' | 'sad' | 'angry' | 'fearful' | 'surprised' | null;
+
+  /**
+   * Select the voice model used for the selected voice. Each provider has a set of
+   * available voice models. Set to null to remove voice model selection, and default
+   * ones will apply. Check out dashboard for more details of each voice model.
    */
   voice_model?:
     | 'eleven_turbo_v2'
@@ -1169,8 +1350,14 @@ export interface AgentCreateParams {
     | 'eleven_turbo_v2_5'
     | 'eleven_flash_v2_5'
     | 'eleven_multilingual_v2'
+    | 'sonic-2'
+    | 'sonic-3'
+    | 'sonic-3-latest'
+    | 'sonic-turbo'
     | 'tts-1'
     | 'gpt-4o-mini-tts'
+    | 'speech-02-turbo'
+    | 'speech-2.8-turbo'
     | null;
 
   /**
@@ -1188,6 +1375,21 @@ 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
@@ -1203,6 +1405,21 @@ export interface AgentCreateParams {
    */
   volume?: number;
 
+  /**
+   * Which webhook events this agent should receive. If not set, defaults to
+   * call_started, call_ended, call_analyzed.
+   */
+  webhook_events?: Array<
+    | 'call_started'
+    | 'call_ended'
+    | 'call_analyzed'
+    | 'transcript_updated'
+    | 'transfer_started'
+    | 'transfer_bridged'
+    | 'transfer_cancelled'
+    | 'transfer_ended'
+  > | null;
+
   /**
    * The timeout for the webhook in milliseconds. If not set, default value of 10000
    * will apply.
@@ -1265,6 +1482,65 @@ export namespace AgentCreateParams {
     version?: number | null;
   }
 
+  /**
+   * Custom STT configuration. Only used when stt_mode is set to custom.
+   */
+  export interface CustomSttConfig {
+    /**
+     * Endpointing timeout in milliseconds. Minimum is 100 for azure, 10 for deepgram.
+     */
+    endpointing_ms: number;
+
+    /**
+     * The STT provider to use.
+     */
+    provider: 'azure' | 'deepgram';
+  }
+
+  /**
+   * Configuration for guardrail checks to detect and prevent prohibited topics in
+   * agent output and user input.
+   */
+  export interface GuardrailConfig {
+    /**
+     * Selected prohibited user topic categories to check. When user messages contain
+     * these topics, the agent will respond with a placeholder message instead of
+     * processing the request.
+     */
+    input_topics?: Array<'platform_integrity_jailbreaking'> | null;
+
+    /**
+     * Selected prohibited agent topic categories to check. When agent messages contain
+     * these topics, they will be replaced with a placeholder message.
+     */
+    output_topics?: Array<
+      | 'harassment'
+      | 'self_harm'
+      | 'sexual_exploitation'
+      | 'violence'
+      | 'defense_and_national_security'
+      | 'illicit_and_harmful_activity'
+      | 'gambling'
+      | 'regulated_professional_advice'
+      | 'child_safety_and_exploitation'
+    > | null;
+  }
+
+  /**
+   * 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
+   * null to disable IVR detection.
+   */
+  export interface IvrOption {
+    action: IvrOption.Action;
+  }
+
+  export namespace IvrOption {
+    export interface Action {
+      type: 'hangup';
+    }
+  }
+
   /**
    * Configuration for PII scrubbing from transcripts and recordings.
    */
@@ -1286,6 +1562,7 @@ export namespace AgentCreateParams {
       | 'pin'
       | 'medical_id'
       | 'date_of_birth'
+      | 'customer_account_number'
     >;
 
     /**
@@ -1399,7 +1676,7 @@ export namespace AgentCreateParams {
 
     /**
      * A single key that signals the end of DTMF input. Acceptable values include any
-     * digit (0–9), the pound/hash symbol (#), or the asterisk (\*).
+     * digit (0-9), the pound/hash symbol (#), or the asterisk (\*).
      */
     termination_key?: string | null;
 
@@ -1420,7 +1697,8 @@ export namespace AgentCreateParams {
     action:
       | VoicemailOption.VoicemailActionPrompt
       | VoicemailOption.VoicemailActionStaticText
-      | VoicemailOption.VoicemailActionHangup;
+      | VoicemailOption.VoicemailActionHangup
+      | VoicemailOption.VoicemailActionBridgeTransfer;
   }
 
   export namespace VoicemailOption {
@@ -1446,6 +1724,10 @@ export namespace AgentCreateParams {
     export interface VoicemailActionHangup {
       type: 'hangup';
     }
+
+    export interface VoicemailActionBridgeTransfer {
+      type: 'bridge_transfer';
+    }
   }
 }
 
@@ -1481,24 +1763,18 @@ export interface AgentUpdateParams {
    *
    * - `coffee-shop`: Coffee shop ambience with people chatting in background.
    *   [Listen to Ambience](https://retell-utils-public.s3.us-west-2.amazonaws.com/coffee-shop.wav)
-   *
    * - `convention-hall`: Convention hall ambience, with some echo and people
    *   chatting in background.
    *   [Listen to Ambience](https://retell-utils-public.s3.us-west-2.amazonaws.com/convention-hall.wav)
-   *
    * - `summer-outdoor`: Summer outdoor ambience with cicada chirping.
    *   [Listen to Ambience](https://retell-utils-public.s3.us-west-2.amazonaws.com/summer-outdoor.wav)
-   *
    * - `mountain-outdoor`: Mountain outdoor ambience with birds singing.
    *   [Listen to Ambience](https://retell-utils-public.s3.us-west-2.amazonaws.com/mountain-outdoor.wav)
-   *
    * - `static-noise`: Constant static noise.
    *   [Listen to Ambience](https://retell-utils-public.s3.us-west-2.amazonaws.com/static-noise.wav)
-   *
    * - `call-center`: Call center work noise.
    *   [Listen to Ambience](https://retell-utils-public.s3.us-west-2.amazonaws.com/call-center.wav)
-   *
-   * Set to `null` to remove ambient sound from this agent.
+   *   Set to `null` to remove ambient sound from this agent.
    */
   ambient_sound?:
     | 'coffee-shop'
@@ -1562,6 +1838,11 @@ export interface AgentUpdateParams {
    */
   boosted_keywords?: Array<string> | null;
 
+  /**
+   * Body param: Custom STT configuration. Only used when stt_mode is set to custom.
+   */
+  custom_stt_config?: AgentUpdateParams.CustomSttConfig;
+
   /**
    * Body param: Granular setting to manage how Retell stores sensitive data
    * (transcripts, recordings, logs, etc.). This replaces the deprecated
@@ -1576,10 +1857,10 @@ export interface AgentUpdateParams {
   data_storage_setting?: 'everything' | 'everything_except_pii' | 'basic_attributes_only';
 
   /**
-   * Body param: If set, determines what denoising mode to use. Default to
-   * noise-cancellation.
+   * Body param: If set, determines what denoising mode to use. Use "no-denoise" to
+   * bypass all audio denoising. Default to noise-cancellation.
    */
-  denoising_mode?: 'noise-cancellation' | 'noise-and-background-speech-cancellation';
+  denoising_mode?: 'no-denoise' | 'noise-cancellation' | 'noise-and-background-speech-cancellation';
 
   /**
    * Body param: Controls whether the agent would backchannel (agent interjects the
@@ -1589,6 +1870,19 @@ export interface AgentUpdateParams {
    */
   enable_backchannel?: boolean;
 
+  /**
+   * Body param: If set to true, will enable dynamic voice speed adjustment based on
+   * the user's speech rate and conversation context. If unset, default value false
+   * will apply.
+   */
+  enable_dynamic_voice_speed?: boolean;
+
+  /**
+   * Body param: If set to true, will detect whether the call enters a voicemail.
+   * Note that this feature is only available for phone calls.
+   */
+  enable_voicemail_detection?: 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
@@ -1605,6 +1899,12 @@ export interface AgentUpdateParams {
    */
   fallback_voice_ids?: Array<string> | null;
 
+  /**
+   * Body param: Configuration for guardrail checks to detect and prevent prohibited
+   * topics in agent output and user input.
+   */
+  guardrail_config?: AgentUpdateParams.GuardrailConfig;
+
   /**
    * Body param: Controls how sensitive the agent is to user interruptions. Value
    * ranging from [0,1]. Lower value means it will take longer / more words for user
@@ -1614,6 +1914,19 @@ export interface AgentUpdateParams {
    */
   interruption_sensitivity?: number;
 
+  /**
+   * Body param: Whether the agent is public. When set to true, the agent is
+   * available for public agent preview link.
+   */
+  is_public?: boolean | null;
+
+  /**
+   * Body param: 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 null to disable IVR detection.
+   */
+  ivr_option?: AgentUpdateParams.IvrOption | null;
+
   /**
    * Body param: Specifies what language (and dialect) the speech recognition will
    * operate in. For instance, selecting `en-GB` optimizes speech recognition for
@@ -1656,6 +1969,9 @@ export interface AgentUpdateParams {
     | 'no-NO'
     | 'sk-SK'
     | 'sv-SE'
+    | 'lt-LT'
+    | 'lv-LV'
+    | 'cs-CZ'
     | 'ms-MY'
     | 'af-ZA'
     | 'ar-SA'
@@ -1733,12 +2049,15 @@ export interface AgentUpdateParams {
     | 'gpt-4.1-mini'
     | 'gpt-4.1-nano'
     | 'gpt-5'
+    | 'gpt-5.1'
+    | 'gpt-5.2'
     | 'gpt-5-mini'
     | 'gpt-5-nano'
     | 'claude-4.5-sonnet'
     | 'claude-4.5-haiku'
     | 'gemini-2.5-flash'
     | 'gemini-2.5-flash-lite'
+    | 'gemini-3.0-flash'
     | null;
 
   /**
@@ -1798,15 +2117,22 @@ export interface AgentUpdateParams {
 
   /**
    * Body param: If set, determines whether speech to text should focus on latency or
-   * accuracy. Default to fast mode.
+   * accuracy. Default to fast mode. When set to custom, custom_stt_config must be
+   * provided.
    */
-  stt_mode?: 'fast' | 'accurate';
+  stt_mode?: 'fast' | 'accurate' | 'custom';
 
   /**
-   * Body param:
+   * Body param
    */
   user_dtmf_options?: AgentUpdateParams.UserDtmfOptions | null;
 
+  /**
+   * Body param: Optional description of the agent version. Used for your own
+   * reference and documentation.
+   */
+  version_description?: 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
@@ -1814,6 +2140,13 @@ export interface AgentUpdateParams {
    */
   vocab_specialization?: 'general' | 'medical';
 
+  /**
+   * Body param: Controls the emotional tone of the agent's voice. Currently
+   * supported for Cartesia and Minimax TTS providers. If unset, no emotion will be
+   * used.
+   */
+  voice_emotion?: 'calm' | 'sympathetic' | 'happy' | 'sad' | 'angry' | 'fearful' | 'surprised' | null;
+
   /**
    * Body param: Unique voice id used for the agent. Find list of available voices
    * and their preview in Dashboard.
@@ -1821,10 +2154,10 @@ export interface AgentUpdateParams {
   voice_id?: string;
 
   /**
-   * Body param: Optionally set the voice model used for the selected voice.
-   * Currently only elevenlab voices have voice model selections. Set to null to
-   * remove voice model selection, and default ones will apply. Check out the
-   * dashboard for details on each voice model.
+   * Body param: Select the voice model used for the selected voice. Each provider
+   * has a set of available voice models. Set to null to remove voice model
+   * selection, and default ones will apply. Check out dashboard for more details of
+   * each voice model.
    */
   voice_model?:
     | 'eleven_turbo_v2'
@@ -1832,8 +2165,14 @@ export interface AgentUpdateParams {
     | 'eleven_turbo_v2_5'
     | 'eleven_flash_v2_5'
     | 'eleven_multilingual_v2'
+    | 'sonic-2'
+    | 'sonic-3'
+    | 'sonic-3-latest'
+    | 'sonic-turbo'
     | 'tts-1'
     | 'gpt-4o-mini-tts'
+    | 'speech-02-turbo'
+    | 'speech-2.8-turbo'
     | null;
 
   /**
@@ -1851,6 +2190,21 @@ 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
@@ -1866,6 +2220,21 @@ export interface AgentUpdateParams {
    */
   volume?: number;
 
+  /**
+   * Body param: Which webhook events this agent should receive. If not set, defaults
+   * to call_started, call_ended, call_analyzed.
+   */
+  webhook_events?: Array<
+    | 'call_started'
+    | 'call_ended'
+    | 'call_analyzed'
+    | 'transcript_updated'
+    | 'transfer_started'
+    | 'transfer_bridged'
+    | 'transfer_cancelled'
+    | 'transfer_ended'
+  > | null;
+
   /**
    * Body param: The timeout for the webhook in milliseconds. If not set, default
    * value of 10000 will apply.
@@ -1882,6 +2251,65 @@ export interface AgentUpdateParams {
 }
 
 export namespace AgentUpdateParams {
+  /**
+   * Custom STT configuration. Only used when stt_mode is set to custom.
+   */
+  export interface CustomSttConfig {
+    /**
+     * Endpointing timeout in milliseconds. Minimum is 100 for azure, 10 for deepgram.
+     */
+    endpointing_ms: number;
+
+    /**
+     * The STT provider to use.
+     */
+    provider: 'azure' | 'deepgram';
+  }
+
+  /**
+   * Configuration for guardrail checks to detect and prevent prohibited topics in
+   * agent output and user input.
+   */
+  export interface GuardrailConfig {
+    /**
+     * Selected prohibited user topic categories to check. When user messages contain
+     * these topics, the agent will respond with a placeholder message instead of
+     * processing the request.
+     */
+    input_topics?: Array<'platform_integrity_jailbreaking'> | null;
+
+    /**
+     * Selected prohibited agent topic categories to check. When agent messages contain
+     * these topics, they will be replaced with a placeholder message.
+     */
+    output_topics?: Array<
+      | 'harassment'
+      | 'self_harm'
+      | 'sexual_exploitation'
+      | 'violence'
+      | 'defense_and_national_security'
+      | 'illicit_and_harmful_activity'
+      | 'gambling'
+      | 'regulated_professional_advice'
+      | 'child_safety_and_exploitation'
+    > | null;
+  }
+
+  /**
+   * 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
+   * null to disable IVR detection.
+   */
+  export interface IvrOption {
+    action: IvrOption.Action;
+  }
+
+  export namespace IvrOption {
+    export interface Action {
+      type: 'hangup';
+    }
+  }
+
   /**
    * Configuration for PII scrubbing from transcripts and recordings.
    */
@@ -1903,6 +2331,7 @@ export namespace AgentUpdateParams {
       | 'pin'
       | 'medical_id'
       | 'date_of_birth'
+      | 'customer_account_number'
     >;
 
     /**
@@ -2062,7 +2491,7 @@ export namespace AgentUpdateParams {
 
     /**
      * A single key that signals the end of DTMF input. Acceptable values include any
-     * digit (0–9), the pound/hash symbol (#), or the asterisk (\*).
+     * digit (0-9), the pound/hash symbol (#), or the asterisk (\*).
      */
     termination_key?: string | null;
 
@@ -2083,7 +2512,8 @@ export namespace AgentUpdateParams {
     action:
       | VoicemailOption.VoicemailActionPrompt
       | VoicemailOption.VoicemailActionStaticText
-      | VoicemailOption.VoicemailActionHangup;
+      | VoicemailOption.VoicemailActionHangup
+      | VoicemailOption.VoicemailActionBridgeTransfer;
   }
 
   export namespace VoicemailOption {
@@ -2109,6 +2539,10 @@ export namespace AgentUpdateParams {
     export interface VoicemailActionHangup {
       type: 'hangup';
     }
+
+    export interface VoicemailActionBridgeTransfer {
+      type: 'bridge_transfer';
+    }
   }
 }