retell-sdk 5.49.1 → 5.49.2

package/resources/call.d.mts

@@ -3,100 +3,100 @@ import { APIPromise } from "../core/api-promise.mjs";
 import { RequestOptions } from "../internal/request-options.mjs";
 export declare class Call extends APIResource {
     /**
-     * Create a new outbound phone call
+     * Retrieve details of a specific call
      *
      * @example
      * ```ts
-     * const phoneCallResponse = await client.call.createPhoneCall(
-     *   {
-     *     from_number: '+14157774444',
-     *     to_number: '+12137774445',
-     *   },
+     * const callResponse = await client.call.retrieve(
+     *   '119c3f8e47135a29e65947eeb34cf12d',
      * );
      * ```
      */
-    createPhoneCall(body: CallCreatePhoneCallParams, options?: RequestOptions): APIPromise<PhoneCallResponse>;
+    retrieve(callID: string, options?: RequestOptions): APIPromise<CallResponse>;
     /**
-     * Register a new phone call for custom telephony
+     * Update metadata and sensitive data storage settings for an existing call.
      *
      * @example
      * ```ts
-     * const phoneCallResponse =
-     *   await client.call.registerPhoneCall({
-     *     agent_id: 'oBeDLoLOeuAbiuaMFXRtDOLriTJ5tSxD',
-     *   });
+     * const callResponse = await client.call.update(
+     *   'call_a4441234567890777c4a4a123e6',
+     *   {
+     *     data_storage_setting: 'everything_except_pii',
+     *     metadata: {
+     *       customer_id: 'cust_123',
+     *       notes: 'Follow-up required',
+     *     },
+     *   },
+     * );
      * ```
      */
-    registerPhoneCall(body: CallRegisterPhoneCallParams, options?: RequestOptions): APIPromise<PhoneCallResponse>;
+    update(callID: string, body: CallUpdateParams, options?: RequestOptions): APIPromise<CallResponse>;
     /**
-     * Create a new web call
+     * List calls with unified cursor pagination response.
      *
      * @example
      * ```ts
-     * const webCallResponse = await client.call.createWebCall({
-     *   agent_id: 'oBeDLoLOeuAbiuaMFXRtDOLriTJ5tSxD',
-     * });
+     * const calls = await client.call.list();
      * ```
      */
-    createWebCall(body: CallCreateWebCallParams, options?: RequestOptions): APIPromise<WebCallResponse>;
+    list(body?: CallListParams | null | undefined, options?: RequestOptions): APIPromise<CallListResponse>;
     /**
-     * Retrieve details of a specific call
+     * Delete a specific call and its associated data
      *
      * @example
      * ```ts
-     * const callResponse = await client.call.retrieve(
+     * await client.call.delete(
      *   '119c3f8e47135a29e65947eeb34cf12d',
      * );
      * ```
      */
-    retrieve(callID: string, options?: RequestOptions): APIPromise<CallResponse>;
+    delete(callID: string, options?: RequestOptions): APIPromise<void>;
     /**
-     * List calls with unified cursor pagination response.
+     * Create a new outbound phone call
      *
      * @example
      * ```ts
-     * const calls = await client.call.list();
+     * const phoneCallResponse = await client.call.createPhoneCall(
+     *   {
+     *     from_number: '+14157774444',
+     *     to_number: '+12137774445',
+     *   },
+     * );
      * ```
      */
-    list(body?: CallListParams | null | undefined, options?: RequestOptions): APIPromise<CallListResponse>;
+    createPhoneCall(body: CallCreatePhoneCallParams, options?: RequestOptions): APIPromise<PhoneCallResponse>;
     /**
-     * Update metadata and sensitive data storage settings for an existing call.
+     * Create a new web call
      *
      * @example
      * ```ts
-     * const callResponse = await client.call.update(
-     *   'call_a4441234567890777c4a4a123e6',
-     *   {
-     *     data_storage_setting: 'everything_except_pii',
-     *     metadata: {
-     *       customer_id: 'cust_123',
-     *       notes: 'Follow-up required',
-     *     },
-     *   },
-     * );
+     * const webCallResponse = await client.call.createWebCall({
+     *   agent_id: 'oBeDLoLOeuAbiuaMFXRtDOLriTJ5tSxD',
+     * });
      * ```
      */
-    update(callID: string, body: CallUpdateParams, options?: RequestOptions): APIPromise<CallResponse>;
+    createWebCall(body: CallCreateWebCallParams, options?: RequestOptions): APIPromise<WebCallResponse>;
     /**
-     * Stop an ongoing call.
+     * Register a new phone call for custom telephony
      *
      * @example
      * ```ts
-     * await client.call.stop('call_a4441234567890777c4a4a123e6');
+     * const phoneCallResponse =
+     *   await client.call.registerPhoneCall({
+     *     agent_id: 'oBeDLoLOeuAbiuaMFXRtDOLriTJ5tSxD',
+     *   });
      * ```
      */
-    stop(callID: string, options?: RequestOptions): APIPromise<void>;
+    registerPhoneCall(body: CallRegisterPhoneCallParams, options?: RequestOptions): APIPromise<PhoneCallResponse>;
     /**
-     * Delete a specific call and its associated data
+     * Stop an ongoing call.
      *
      * @example
      * ```ts
-     * await client.call.delete(
-     *   '119c3f8e47135a29e65947eeb34cf12d',
-     * );
+     * await client.call.stop('call_a4441234567890777c4a4a123e6');
      * ```
      */
-    delete(callID: string, options?: RequestOptions): APIPromise<void>;
+    stop(callID: string, options?: RequestOptions): APIPromise<void>;
 }
 export type CallResponse = WebCallResponse | PhoneCallResponse;
 export interface PhoneCallResponse {
@@ -3235,993 +3235,705 @@ export declare namespace CallListResponse {
         }
     }
 }
-export interface CallCreatePhoneCallParams {
+export interface CallUpdateParams {
     /**
-     * The number you own in E.164 format. Must be a number purchased from Retell or
-     * imported to Retell.
+     * Custom attributes for the call, as key-value pairs. Each attribute must first be
+     * defined for your organization in the Retell dashboard (Call History → Actions →
+     * Custom attributes) before it can be set here. The object key must match the id
+     * of an existing organization-level custom attribute; keys that do not match a
+     * defined attribute are ignored and will not be saved. Values must be a string,
+     * number, or boolean.
      */
-    from_number: string;
+    custom_attributes?: {
+        [key: string]: string | number | boolean;
+    };
     /**
-     * The number you want to call, in E.164 format. If using a number purchased from
-     * Retell, only US numbers are supported as destination.
+     * Data storage setting for this call. Overrides the agent's default setting.
+     * "everything" stores all data, "everything_except_pii" excludes PII when
+     * possible, "basic_attributes_only" stores only metadata. Cannot be downgraded
+     * from more restrictive to less restrictive settings.
      */
-    to_number: string;
+    data_storage_setting?: 'everything' | 'everything_except_pii' | 'basic_attributes_only';
     /**
-     * For this particular call, override agent configuration with these settings. This
-     * allows you to customize agent behavior for individual calls without modifying
-     * the base agent.
+     * An arbitrary object for storage purpose only. You can put anything here like
+     * your internal customer id associated with the call. Not used for processing. You
+     * can later get this field from the call object. Size limited to 50kB max.
      */
-    agent_override?: CallCreatePhoneCallParams.AgentOverride;
+    metadata?: unknown;
+}
+export interface CallListParams {
     /**
-     * Add optional custom SIP headers to the call.
+     * Filter criteria for calls. All conditions are implicitly connected with AND.
      */
-    custom_sip_headers?: {
-        [key: string]: string;
-    };
+    filter_criteria?: CallListParams.FilterCriteria;
     /**
-     * If true, the e.164 validation will be ignored for the from_number. This can be
-     * useful when you want to dial to internal pseudo numbers. This only applies when
-     * you are using custom telephony and does not apply when you are using Retell
-     * Telephony. If omitted, the default value is false.
+     * Whether to include `total` (count of all calls matching `filter_criteria`,
+     * ignoring `limit`/`skip`/`pagination_key`) in the response. Defaults to false.
+     * Each enabled request triggers an additional aggregate query, so opt in only when
+     * the total is needed.
      */
-    ignore_e164_validation?: boolean;
+    include_total?: boolean;
     /**
-     * An arbitrary object for storage purpose only. You can put anything here like
-     * your internal customer id associated with the call. Not used for processing. You
-     * can later get this field from the call object.
+     * Maximum number of calls to return.
      */
-    metadata?: unknown;
+    limit?: number;
     /**
-     * For this particular call, override the agent used with this agent id. This does
-     * not bind the agent to this number, this is for one time override.
+     * Opaque pagination cursor from a previous response.
      */
-    override_agent_id?: string;
+    pagination_key?: string;
     /**
-     * For this particular call, override the agent version used with this version.
-     * This does not bind the agent version to this number, this is for one time
-     * override.
+     * Number of records to skip for pagination.
      */
-    override_agent_version?: string | number;
+    skip?: number;
     /**
-     * Add optional dynamic variables in key value pairs of string that injects into
-     * your Response Engine prompt and tool description. Only applicable for Response
-     * Engine.
+     * Sort calls by `start_timestamp` in ascending or descending order.
      */
-    retell_llm_dynamic_variables?: {
-        [key: string]: string;
-    };
+    sort_order?: 'ascending' | 'descending';
 }
-export declare namespace CallCreatePhoneCallParams {
+export declare namespace CallListParams {
     /**
-     * For this particular call, override agent configuration with these settings. This
-     * allows you to customize agent behavior for individual calls without modifying
-     * the base agent.
+     * Filter criteria for calls. All conditions are implicitly connected with AND.
      */
-    interface AgentOverride {
+    interface FilterCriteria {
         /**
-         * Override agent configuration settings. Any properties specified here will
-         * override the base agent configuration for this call.
+         * Filter by agent(s). Agent filters are connected by OR.
          */
-        agent?: AgentOverride.Agent;
+        agent?: Array<FilterCriteria.Agent>;
         /**
-         * Override conversation flow configuration settings. Only applicable when using
-         * conversation flow as the response engine. Supported attributes - model_choice,
-         * model_temperature, tool_call_strict_mode, knowledge_base_ids, kb_config,
-         * start_speaker, begin_after_user_silence_ms.
+         * Filter by agent environment tag(s) (e.g. "prod", "staging").
          */
-        conversation_flow?: AgentOverride.ConversationFlow;
+        agent_tag?: FilterCriteria.AgentTag;
         /**
-         * 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,
-         * knowledge_base_ids, kb_config, start_speaker, begin_after_user_silence_ms,
-         * begin_message.
+         * Filter by batch call ID.
          */
-        retell_llm?: AgentOverride.RetellLlm;
-    }
-    namespace AgentOverride {
+        batch_call_id?: FilterCriteria.BatchCallID;
         /**
-         * Override agent configuration settings. Any properties specified here will
-         * override the base agent configuration for this call.
+         * Filter by call ID.
          */
-        interface Agent {
-            /**
-             * The name of the agent. Only used for your own reference.
-             */
-            agent_name?: string | null;
-            /**
-             * If set to true, DTMF input will interrupt the agent even when
-             * interruption_sensitivity is 0. Can be overridden per conversation or subagent
-             * node. Default to false.
-             */
-            allow_dtmf_interruption?: boolean;
-            /**
-             * If set to true, DTMF input will be accepted and processed. If false, any DTMF
-             * input will be ignored. Default to true.
-             */
-            allow_user_dtmf?: boolean;
-            /**
-             * If set, will add ambient environment sound to the call to make experience more
-             * realistic. Currently supports the following options:
-             *
-             * - `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.
-             */
-            ambient_sound?: 'coffee-shop' | 'convention-hall' | 'summer-outdoor' | 'mountain-outdoor' | 'static-noise' | 'call-center' | null;
-            /**
-             * If set, will control the volume of the ambient sound. Value ranging from [0,2].
-             * Lower value means quieter ambient sound, while higher value means louder ambient
-             * sound. If unset, default value 1 will apply.
-             */
-            ambient_sound_volume?: number;
-            /**
-             * Only applicable when enable_backchannel is true. Controls how often the agent
-             * would backchannel when a backchannel is possible. Value ranging from [0,1].
-             * Lower value means less frequent backchannel, while higher value means more
-             * frequent backchannel. If unset, default value 0.8 will apply.
-             */
-            backchannel_frequency?: number;
-            /**
-             * Only applicable when enable_backchannel is true. A list of words that the agent
-             * would use as backchannel. If not set, default backchannel words will apply.
-             * Check out
-             * [backchannel default words](/agent/interaction-configuration#backchannel) for
-             * more details. Note that certain voices do not work too well with certain words,
-             * so it's recommended to experiment before adding any words.
-             */
-            backchannel_words?: Array<string> | null;
-            /**
-             * If set, will delay the first message by the specified amount of milliseconds, so
-             * that it gives user more time to prepare to take the call. Valid range is [0,
-             * 5000]. If not set or set to 0, agent will speak immediately. Only applicable
-             * when agent speaks first.
-             */
-            begin_message_delay_ms?: number;
+        call_id?: FilterCriteria.StringFilter | FilterCriteria.EnumFilter;
+        call_status?: FilterCriteria.CallStatus;
+        /**
+         * Filter by whether the call was successful.
+         */
+        call_successful?: FilterCriteria.CallSuccessful;
+        call_type?: FilterCriteria.CallType;
+        /**
+         * Filter by combined cost of the call.
+         */
+        combined_cost?: FilterCriteria.NumberFilter | FilterCriteria.RangeFilter;
+        /**
+         * Filter by custom analysis data fields.
+         */
+        custom_analysis_data?: Array<FilterCriteria.StringFilter | FilterCriteria.NumberFilter | FilterCriteria.BooleanFilter | FilterCriteria.RangeFilter | FilterCriteria.EnumFilter | FilterCriteria.PresentFilter>;
+        /**
+         * Filter by custom attributes fields.
+         */
+        custom_attributes?: Array<FilterCriteria.StringFilter | FilterCriteria.NumberFilter | FilterCriteria.BooleanFilter | FilterCriteria.RangeFilter | FilterCriteria.EnumFilter | FilterCriteria.PresentFilter>;
+        data_storage_setting?: FilterCriteria.DataStorageSetting;
+        direction?: FilterCriteria.Direction;
+        disconnection_reason?: FilterCriteria.DisconnectionReason;
+        /**
+         * Filter by call duration in milliseconds.
+         */
+        duration_ms?: FilterCriteria.NumberFilter | FilterCriteria.RangeFilter;
+        /**
+         * Filter by dynamic variables.
+         */
+        dynamic_variables?: Array<FilterCriteria.DynamicVariable>;
+        /**
+         * Filter by end-to-end latency p50.
+         */
+        e2e_latency_p50?: FilterCriteria.NumberFilter | FilterCriteria.RangeFilter;
+        /**
+         * Filter by call end timestamp (epoch ms).
+         */
+        end_timestamp?: FilterCriteria.NumberFilter | FilterCriteria.RangeFilter;
+        /**
+         * Filter by from number.
+         */
+        from_number?: FilterCriteria.FromNumber;
+        /**
+         * Filter by whether the call is in voicemail.
+         */
+        in_voicemail?: FilterCriteria.InVoicemail;
+        /**
+         * Filter by metadata fields.
+         */
+        metadata?: Array<FilterCriteria.StringFilter | FilterCriteria.NumberFilter | FilterCriteria.BooleanFilter | FilterCriteria.RangeFilter | FilterCriteria.EnumFilter | FilterCriteria.PresentFilter>;
+        /**
+         * Filter by call start timestamp (epoch ms).
+         */
+        start_timestamp?: FilterCriteria.NumberFilter | FilterCriteria.RangeFilter;
+        /**
+         * Filter by to number.
+         */
+        to_number?: FilterCriteria.ToNumber;
+        /**
+         * Filter by tool call criteria. Tool call filters are connected by AND.
+         */
+        tool_calls?: Array<FilterCriteria.ToolCall>;
+        user_sentiment?: FilterCriteria.UserSentiment;
+    }
+    namespace FilterCriteria {
+        interface Agent {
             /**
-             * Provide a customized list of keywords to bias the transcriber model, so that
-             * these words are more likely to get transcribed. Commonly used for names, brands,
-             * street, etc. Entries may reference dynamic variables with `{{variable}}` syntax.
+             * The agent ID to filter on.
              */
-            boosted_keywords?: Array<string> | null;
+            agent_id: string;
             /**
-             * If this option is set, the agent prompt will include call screen handling
-             * instructions for identity and call purpose questions. Set this to null to
-             * disable call screen prompt instructions.
+             * Specific versions to filter on. If not provided, all versions are included.
              */
-            call_screening_option?: Agent.CallScreeningOption | null;
+            version?: Array<number>;
+        }
+        /**
+         * Filter by agent environment tag(s) (e.g. "prod", "staging").
+         */
+        interface AgentTag {
             /**
-             * Custom STT configuration. Only used when stt_mode is set to custom.
+             * in: value is one of the listed values
              */
-            custom_stt_config?: Agent.CustomSttConfig | null;
+            op: 'in';
+            type: 'enum';
+            value: Array<string>;
+        }
+        /**
+         * Filter by batch call ID.
+         */
+        interface BatchCallID {
             /**
-             * Number of days to retain call/chat data before automatic deletion. Must be
-             * between 1 and 730 days. If not set, data is retained forever (no automatic
-             * deletion).
+             * eq: equal, ne: not equal, sw: starts with, ew: ends with, co: contains
              */
-            data_storage_retention_days?: number | null;
+            op: 'eq' | 'ne' | 'sw' | 'ew' | 'co';
+            type: 'string';
+            value: string;
+        }
+        interface StringFilter {
             /**
-             * Granular setting to manage how Retell stores sensitive data (transcripts,
-             * recordings, logs, etc.). This replaces the deprecated
-             * `opt_out_sensitive_data_storage` field.
-             *
-             * - `everything`: Store all data including transcripts, recordings, and logs.
-             * - `everything_except_pii`: Store data without PII when PII is detected.
-             * - `basic_attributes_only`: Store only basic attributes; no
-             *   transcripts/recordings/logs. If not set, default value of "everything" will
-             *   apply.
+             * eq: equal, ne: not equal, sw: starts with, ew: ends with, co: contains
              */
-            data_storage_setting?: 'everything' | 'everything_except_pii' | 'basic_attributes_only';
+            op: 'eq' | 'ne' | 'sw' | 'ew' | 'co';
+            type: 'string';
+            value: string;
+        }
+        interface EnumFilter {
             /**
-             * If set, determines what denoising mode to use. Use "no-denoise" to bypass all
-             * audio denoising. Default to noise-cancellation.
+             * in: value is one of the listed values
              */
-            denoising_mode?: 'no-denoise' | 'noise-cancellation' | 'noise-and-background-speech-cancellation';
+            op: 'in';
+            type: 'enum';
+            value: Array<string>;
+        }
+        interface CallStatus {
             /**
-             * Controls whether the agent would backchannel (agent interjects the speaker with
-             * phrases like "yeah", "uh-huh" to signify interest and engagement). Backchannel
-             * when enabled tends to show up more in longer user utterances. If not set, agent
-             * will not backchannel.
+             * in: value is one of the listed values
              */
-            enable_backchannel?: boolean;
+            op: 'in';
+            type: 'enum';
+            value: Array<'not_connected' | 'ongoing' | 'ended' | 'error'>;
+        }
+        /**
+         * Filter by whether the call was successful.
+         */
+        interface CallSuccessful {
+            op: 'eq';
+            type: 'boolean';
+            value: boolean;
+        }
+        interface CallType {
             /**
-             * If set to true, the agent will dynamically adjust how quickly it responds based
-             * on the user's speech rate and past turn-taking behavior in the call. If unset,
-             * default value false will apply.
+             * in: value is one of the listed values
              */
-            enable_dynamic_responsiveness?: boolean;
+            op: 'in';
+            type: 'enum';
+            value: Array<'web_call' | 'phone_call'>;
+        }
+        interface NumberFilter {
             /**
-             * 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.
+             * eq: equal, ne: not equal, gt: greater than, ge: greater than or equal, lt: less
+             * than, le: less than or equal
              */
-            enable_dynamic_voice_speed?: boolean;
+            op: 'eq' | 'ne' | 'gt' | 'ge' | 'lt' | 'le';
+            type: 'number';
+            value: number;
+        }
+        interface RangeFilter {
             /**
-             * Master toggle for expressive mode. When true, the agent may add expressive voice
-             * tags to the audio it generates. Only applicable for platform voices. If unset,
-             * defaults to false.
+             * bt: between
              */
-            enable_expressive_mode?: boolean;
+            op: 'bt';
+            type: 'range';
             /**
-             * 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).
+             * [lower_bound, upper_bound]
              */
-            end_call_after_silence_ms?: number;
+            value: Array<number>;
+        }
+        interface StringFilter {
             /**
-             * The expressive voice tags Retell pre-teaches the model to use when
-             * enable_expressive_mode is true. Custom tags defined in the system prompt are
-             * still allowed. If empty, the agent follows general expressive guidance without a
-             * fixed tag set.
+             * eq: equal, ne: not equal, sw: starts with, ew: ends with, co: contains
              */
-            expressive_emotion_tags?: Array<'empathetic' | 'excited' | 'happy' | 'curious' | 'surprised' | 'sigh' | 'clear throat' | 'pause' | 'long pause' | 'emphasis'>;
+            op: 'eq' | 'ne' | 'sw' | 'ew' | 'co';
+            type: 'string';
+            value: string;
             /**
-             * Custom expressive voice guidance to use instead of the default Retell expressive
-             * prompt when enable_expressive_mode is true. If omitted or blank, the default
-             * expressive prompt will be used.
+             * The field name to filter on.
              */
-            expressive_mode_prompt?: string | null;
+            key?: string;
+        }
+        interface NumberFilter {
             /**
-             * When TTS provider for the selected voice is experiencing outages, we would use
-             * fallback voices listed here for the agent. Voice id and the fallback voice ids
-             * must be from different TTS providers. The system would go through the list in
-             * order, if the first one in the list is also having outage, it would use the next
-             * one. Set to null to remove voice fallback for the agent.
+             * eq: equal, ne: not equal, gt: greater than, ge: greater than or equal, lt: less
+             * than, le: less than or equal
              */
-            fallback_voice_ids?: Array<string> | null;
+            op: 'eq' | 'ne' | 'gt' | 'ge' | 'lt' | 'le';
+            type: 'number';
+            value: number;
             /**
-             * Configuration for guardrail checks to detect and prevent prohibited topics in
-             * agent output and user input.
+             * The field name to filter on.
              */
-            guardrail_config?: Agent.GuardrailConfig;
+            key?: string;
+        }
+        interface BooleanFilter {
+            op: 'eq';
+            type: 'boolean';
+            value: boolean;
             /**
-             * Toggle behavior presets on/off to influence agent response style and behaviors.
+             * The field name to filter on.
              */
-            handbook_config?: Agent.HandbookConfig;
+            key?: string;
+        }
+        interface RangeFilter {
             /**
-             * 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
-             * agent, while higher value means it's easier for user to interrupt agent. If
-             * unset, default value 1 will apply. When this is set to 0, agent would never be
-             * interrupted.
+             * bt: between
              */
-            interruption_sensitivity?: number;
+            op: 'bt';
+            type: 'range';
             /**
-             * 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.
+             * [lower_bound, upper_bound]
              */
-            ivr_option?: Agent.IvrOption | null;
+            value: Array<number>;
             /**
-             * Specifies what language(s) the agent will operate in. Accepts either a single
-             * scalar locale (e.g. `en-US`), the legacy scalar value `multi` for multilingual
-             * support, or an array of concrete locale codes for explicit multi-locale
-             * selection (e.g. `["en-US","es-ES"]`). The array form must contain concrete
-             * locale codes only — the `multi` value is valid only as the scalar legacy form
-             * and must not appear inside an array. Single-element arrays are normalized to the
-             * equivalent scalar on output. If unset, defaults to `en-US`.
+             * The field name to filter on.
              */
-            language?: 'en-US' | 'en-IN' | 'en-GB' | 'en-AU' | 'en-NZ' | 'de-DE' | 'es-ES' | 'es-419' | 'hi-IN' | 'fr-FR' | 'fr-CA' | 'ja-JP' | 'pt-PT' | 'pt-BR' | 'zh-CN' | 'ru-RU' | 'it-IT' | 'ko-KR' | 'nl-NL' | 'nl-BE' | 'pl-PL' | 'tr-TR' | 'vi-VN' | 'ro-RO' | 'bg-BG' | 'ca-ES' | 'th-TH' | 'da-DK' | 'fi-FI' | 'el-GR' | 'hu-HU' | 'id-ID' | 'no-NO' | 'sk-SK' | 'sv-SE' | 'lt-LT' | 'lv-LV' | 'cs-CZ' | 'ms-MY' | 'af-ZA' | 'ar-SA' | 'az-AZ' | 'bs-BA' | 'cy-GB' | 'fa-IR' | 'fil-PH' | 'gl-ES' | 'he-IL' | 'hr-HR' | 'hy-AM' | 'is-IS' | 'kk-KZ' | 'kn-IN' | 'mk-MK' | 'mr-IN' | 'ne-NP' | 'sl-SI' | 'sr-RS' | 'sw-KE' | 'ta-IN' | 'ur-IN' | 'yue-CN' | 'uk-UA' | 'multi' | Array<'en-US' | 'en-IN' | 'en-GB' | 'en-AU' | 'en-NZ' | 'de-DE' | 'es-ES' | 'es-419' | 'hi-IN' | 'fr-FR' | 'fr-CA' | 'ja-JP' | 'pt-PT' | 'pt-BR' | 'zh-CN' | 'ru-RU' | 'it-IT' | 'ko-KR' | 'nl-NL' | 'nl-BE' | 'pl-PL' | 'tr-TR' | 'vi-VN' | 'ro-RO' | 'bg-BG' | 'ca-ES' | 'th-TH' | 'da-DK' | 'fi-FI' | 'el-GR' | 'hu-HU' | 'id-ID' | 'no-NO' | 'sk-SK' | 'sv-SE' | 'lt-LT' | 'lv-LV' | 'cs-CZ' | 'ms-MY' | 'af-ZA' | 'ar-SA' | 'az-AZ' | 'bs-BA' | 'cy-GB' | 'fa-IR' | 'fil-PH' | 'gl-ES' | 'he-IL' | 'hr-HR' | 'hy-AM' | 'is-IS' | 'kk-KZ' | 'kn-IN' | 'mk-MK' | 'mr-IN' | 'ne-NP' | 'sl-SI' | 'sr-RS' | 'sw-KE' | 'ta-IN' | 'ur-IN' | 'yue-CN' | 'uk-UA'>;
+            key?: string;
+        }
+        interface EnumFilter {
             /**
-             * Maximum allowed length for the call, will force end the call if reached. The
-             * minimum value allowed is 60,000 ms (1 min), and maximum value allowed is
-             * 7,200,000 (2 hours). By default, this is set to 3,600,000 (1 hour).
+             * in: value is one of the listed values
              */
-            max_call_duration_ms?: number;
+            op: 'in';
+            type: 'enum';
+            value: Array<string>;
             /**
-             * Whether this agent opts in for signed URLs for public logs and recordings. When
-             * enabled, the generated URLs will include security signatures that restrict
-             * access and automatically expire after 24 hours.
+             * The field name to filter on.
              */
-            opt_in_signed_url?: boolean;
+            key?: string;
+        }
+        interface PresentFilter {
             /**
-             * Configuration for PII scrubbing from transcripts and recordings.
+             * pr: present (has value), np: not present
              */
-            pii_config?: Agent.PiiConfig;
+            op: 'pr' | 'np';
+            type: 'present';
             /**
-             * Post call analysis data to extract from the call. This data will augment the
-             * pre-defined variables extracted in the call analysis. This will be available
-             * after the call ends.
+             * The field name to filter on.
              */
-            post_call_analysis_data?: Array<Agent.StringAnalysisData | Agent.EnumAnalysisData | Agent.BooleanAnalysisData | Agent.NumberAnalysisData | Agent.CallPresetAnalysisData> | null;
+            key?: string;
+        }
+        interface StringFilter {
             /**
-             * The model to use for post call analysis. Default to gpt-4.1.
+             * eq: equal, ne: not equal, sw: starts with, ew: ends with, co: contains
              */
-            post_call_analysis_model?: 'gpt-4.1' | 'gpt-4.1-mini' | 'gpt-4.1-nano' | 'gpt-5' | 'gpt-5-mini' | 'gpt-5-nano' | 'gpt-5.1' | 'gpt-5.2' | 'gpt-5.4' | 'gpt-5.4-mini' | 'gpt-5.4-nano' | 'gpt-5.5' | 'gpt-5.6-terra' | 'gpt-5.6-luna' | 'claude-4.5-sonnet' | 'claude-4.6-sonnet' | 'claude-5-sonnet' | 'claude-4.5-haiku' | 'gemini-3.0-flash' | 'gemini-3.1-flash-lite' | 'gemini-3.5-flash' | null;
+            op: 'eq' | 'ne' | 'sw' | 'ew' | 'co';
+            type: 'string';
+            value: string;
             /**
-             * A list of words / phrases and their pronunciation to be used to guide the audio
-             * synthesize for consistent pronunciation. Check the dashboard to see what
-             * provider supports this feature. Set to null to remove pronunciation dictionary
-             * from this agent.
+             * The field name to filter on.
              */
-            pronunciation_dictionary?: Array<Agent.PronunciationDictionary> | null;
+            key?: string;
+        }
+        interface NumberFilter {
             /**
-             * If set, controls how many times agent would remind user when user is
-             * unresponsive. Must be a non negative integer. If unset, default value of 1 will
-             * apply (remind once). Set to 0 to disable agent from reminding.
+             * eq: equal, ne: not equal, gt: greater than, ge: greater than or equal, lt: less
+             * than, le: less than or equal
              */
-            reminder_max_count?: number;
+            op: 'eq' | 'ne' | 'gt' | 'ge' | 'lt' | 'le';
+            type: 'number';
+            value: number;
             /**
-             * If set (in milliseconds), will trigger a reminder to the agent to speak if the
-             * user has been silent for the specified duration after some agent speech. Must be
-             * a positive number. If unset, default value of 10000 ms (10 s) will apply.
+             * The field name to filter on.
              */
-            reminder_trigger_ms?: number;
+            key?: string;
+        }
+        interface BooleanFilter {
+            op: 'eq';
+            type: 'boolean';
+            value: boolean;
             /**
-             * The Response Engine to attach to the agent. It is used to generate responses for
-             * the agent. You need to create a Response Engine first before attaching it to an
-             * agent.
+             * The field name to filter on.
              */
-            response_engine?: Agent.ResponseEngineRetellLm | Agent.ResponseEngineCustomLm | Agent.ResponseEngineConversationFlow;
+            key?: string;
+        }
+        interface RangeFilter {
             /**
-             * Controls how responsive is the agent. Value ranging from [0,1]. Lower value
-             * means less responsive agent (wait more, respond slower), while higher value
-             * means faster exchanges (respond when it can). If unset, default value 1 will
-             * apply.
+             * bt: between
              */
-            responsiveness?: number;
+            op: 'bt';
+            type: 'range';
             /**
-             * If set, the phone ringing will last for the specified amount of milliseconds.
-             * This applies for both outbound call ringtime, and call transfer ringtime.
-             * Default to 30000 (30 s). Valid range is [5000, 300000].
+             * [lower_bound, upper_bound]
              */
-            ring_duration_ms?: number;
+            value: Array<number>;
             /**
-             * The expiration time for the signed url in milliseconds. Only applicable when
-             * opt_in_signed_url is true. If not set, default value of 86400000 (24 hours) will
-             * apply.
+             * The field name to filter on.
              */
-            signed_url_expiration_ms?: number | null;
+            key?: string;
+        }
+        interface EnumFilter {
             /**
-             * If set, determines whether speech to text should focus on latency or accuracy.
-             * Default to fast mode. When set to custom, custom_stt_config must be provided.
+             * in: value is one of the listed values
              */
-            stt_mode?: 'fast' | 'accurate' | 'custom';
+            op: 'in';
+            type: 'enum';
+            value: Array<string>;
             /**
-             * IANA timezone for the agent (e.g. America/New_York). Defaults to
-             * America/Los_Angeles if not set.
+             * The field name to filter on.
              */
-            timezone?: string | null;
-            user_dtmf_options?: Agent.UserDtmfOptions | null;
+            key?: string;
+        }
+        interface PresentFilter {
             /**
-             * Optional description of the agent version. Used for your own reference and
-             * documentation.
+             * pr: present (has value), np: not present
              */
-            version_description?: string | null;
+            op: 'pr' | 'np';
+            type: 'present';
             /**
-             * Optional title of the agent version. Used for your own reference.
+             * The field name to filter on.
              */
-            version_title?: string | null;
+            key?: string;
+        }
+        interface DataStorageSetting {
             /**
-             * 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.
-             * Default to general.
+             * in: value is one of the listed values
              */
-            vocab_specialization?: 'general' | 'medical';
+            op: 'in';
+            type: 'enum';
+            value: Array<'everything' | 'everything_except_pii' | 'basic_attributes_only'>;
+        }
+        interface Direction {
             /**
-             * Controls the emotional tone of the agent's voice. Currently supported for
-             * Cartesia and Minimax TTS providers. If unset, no emotion will be used.
+             * in: value is one of the listed values
              */
-            voice_emotion?: 'calm' | 'sympathetic' | 'happy' | 'sad' | 'angry' | 'fearful' | 'surprised' | null;
+            op: 'in';
+            type: 'enum';
+            value: Array<'inbound' | 'outbound'>;
+        }
+        interface DisconnectionReason {
             /**
-             * Unique voice id used for the agent. Find list of available voices and their
-             * preview in Dashboard.
+             * in: value is one of the listed values
              */
-            voice_id?: string;
+            op: 'in';
+            type: 'enum';
+            value: Array<'user_hangup' | 'agent_hangup' | 'call_transfer' | 'voicemail_reached' | 'ivr_reached' | 'inactivity' | 'max_duration_reached' | 'concurrency_limit_reached' | 'no_concurrency_fallback' | 'no_valid_payment' | 'scam_detected' | 'dial_busy' | 'dial_failed' | 'dial_no_answer' | 'invalid_destination' | 'telephony_provider_permission_denied' | 'telephony_provider_unavailable' | 'sip_routing_error' | 'marked_as_spam' | 'user_declined' | 'error_llm_websocket_open' | 'error_llm_websocket_lost_connection' | 'error_llm_websocket_runtime' | 'error_llm_websocket_corrupt_payload' | 'error_no_audio_received' | 'error_asr' | 'error_retell' | 'error_unknown' | 'error_user_not_joined' | 'registered_call_timeout' | 'transfer_bridged' | 'transfer_cancelled' | 'manual_stopped' | 'call_take_over'>;
+        }
+        interface NumberFilter {
             /**
-             * 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.
+             * eq: equal, ne: not equal, gt: greater than, ge: greater than or equal, lt: less
+             * than, le: less than or equal
              */
-            voice_model?: 'eleven_flash_v2' | 'eleven_flash_v2_5' | 'eleven_multilingual_v2' | 'eleven_v3' | 'sonic-3' | 'sonic-3-latest' | 'sonic-3.5' | 'tts-1' | 'gpt-4o-mini-tts' | 'speech-02-turbo' | 'speech-2.8-turbo' | 's1' | 's2-pro' | 's2.1-pro' | null;
+            op: 'eq' | 'ne' | 'gt' | 'ge' | 'lt' | 'le';
+            type: 'number';
+            value: number;
+        }
+        interface RangeFilter {
             /**
-             * Controls speed of voice. Value ranging from [0.5,2]. Lower value means slower
-             * speech, while higher value means faster speech rate. If unset, default value 1
-             * will apply.
+             * bt: between
              */
-            voice_speed?: number;
+            op: 'bt';
+            type: 'range';
             /**
-             * Controls how stable the voice is. Value ranging from [0,2]. Lower value means
-             * more stable, and higher value means more variant speech generation. Check the
-             * dashboard to see what provider supports this feature. If unset, default value 1
-             * will apply.
+             * [lower_bound, upper_bound]
              */
-            voice_temperature?: number;
+            value: Array<number>;
+        }
+        interface DynamicVariable {
             /**
-             * 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
-             * applied when the voicemail is detected. Set this to null to disable voicemail
-             * detection.
+             * The dynamic variable name to filter on.
              */
-            voicemail_option?: Agent.VoicemailOption | null;
+            key: string;
             /**
-             * If set, will control the volume of the agent. Value ranging from [0,2]. Lower
-             * value means quieter agent speech, while higher value means louder agent speech.
-             * If unset, default value 1 will apply.
+             * eq: equal, ne: not equal, sw: starts with, ew: ends with, co: contains
              */
-            volume?: number;
+            op: 'eq' | 'ne' | 'sw' | 'ew' | 'co';
+            type: 'string';
+            value: string;
+        }
+        interface NumberFilter {
             /**
-             * Which webhook events this agent should receive. If not set, defaults to
-             * call_started, call_ended, call_analyzed.
+             * eq: equal, ne: not equal, gt: greater than, ge: greater than or equal, lt: less
+             * than, le: less than or equal
              */
-            webhook_events?: Array<'call_started' | 'call_ended' | 'call_analyzed' | 'transcript_updated' | 'transfer_started' | 'transfer_bridged' | 'transfer_cancelled' | 'transfer_ended'> | null;
+            op: 'eq' | 'ne' | 'gt' | 'ge' | 'lt' | 'le';
+            type: 'number';
+            value: number;
+        }
+        interface RangeFilter {
             /**
-             * The timeout for the webhook in milliseconds. If not set, default value of 10000
-             * will apply.
+             * bt: between
              */
-            webhook_timeout_ms?: number;
+            op: 'bt';
+            type: 'range';
             /**
-             * The webhook for agent to listen to call events. See what events it would get at
-             * [webhook doc](/features/webhook). If set, will binds webhook events for this
-             * agent to the specified url, and will ignore the account level webhook for this
-             * agent. Set to `null` to remove webhook url from this agent.
+             * [lower_bound, upper_bound]
              */
-            webhook_url?: string | null;
+            value: Array<number>;
         }
-        namespace Agent {
+        interface NumberFilter {
             /**
-             * If this option is set, the agent prompt will include call screen handling
-             * instructions for identity and call purpose questions. Set this to null to
-             * disable call screen prompt instructions.
+             * eq: equal, ne: not equal, gt: greater than, ge: greater than or equal, lt: less
+             * than, le: less than or equal
              */
-            interface CallScreeningOption {
-                /**
-                 * Identity the agent should provide when a call screen asks who is calling.
-                 * Dynamic variables are supported.
-                 */
-                agent_identity: string;
-                /**
-                 * Purpose the agent should provide when a call screen asks why it is calling.
-                 * Dynamic variables are supported.
-                 */
-                call_purpose: string;
-            }
+            op: 'eq' | 'ne' | 'gt' | 'ge' | 'lt' | 'le';
+            type: 'number';
+            value: number;
+        }
+        interface RangeFilter {
             /**
-             * Custom STT configuration. Only used when stt_mode is set to custom.
+             * bt: between
              */
-            interface CustomSttConfig {
-                /**
-                 * Endpointing timeout in milliseconds. Minimum is 100 for Azure, 10 for Deepgram,
-                 * 500 for Soniox, 100 for AssemblyAI.
-                 */
-                endpointing_ms: number;
-                /**
-                 * ASR provider name.
-                 */
-                provider: 'azure' | 'deepgram' | 'soniox' | 'assemblyai';
-            }
+            op: 'bt';
+            type: 'range';
             /**
-             * Configuration for guardrail checks to detect and prevent prohibited topics in
-             * agent output and user input.
+             * [lower_bound, upper_bound]
              */
-            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;
-            }
+            value: Array<number>;
+        }
+        /**
+         * Filter by from number.
+         */
+        interface FromNumber {
             /**
-             * Toggle behavior presets on/off to influence agent response style and behaviors.
+             * eq: equal, ne: not equal, sw: starts with, ew: ends with, co: contains
              */
-            interface HandbookConfig {
-                /**
-                 * When asked, acknowledge being a virtual assistant.
-                 */
-                ai_disclosure?: boolean;
-                /**
-                 * Enables Conversational Personality. When true, the agent uses the Conversational
-                 * Personality handbook preset, skips Professional Rep Personality during prompt
-                 * assembly, and enables internal colloquial rewrite behavior.
-                 */
-                conversational_personality?: boolean;
-                /**
-                 * Professional call center rep baseline.
-                 */
-                default_personality?: boolean;
-                /**
-                 * Repeat back and confirm important details (voice only).
-                 */
-                echo_verification?: boolean;
-                /**
-                 * Warm acknowledgment of caller concerns.
-                 */
-                high_empathy?: boolean;
-                /**
-                 * Spell using NATO phonetic alphabet style (voice only).
-                 */
-                nato_phonetic_alphabet?: boolean;
-                /**
-                 * Sprinkle natural speech fillers like "um", "you know" for a more human,
-                 * conversational tone.
-                 */
-                natural_filler_words?: boolean;
+            op: 'eq' | 'ne' | 'sw' | 'ew' | 'co';
+            type: 'string';
+            value: string;
+        }
+        /**
+         * Filter by whether the call is in voicemail.
+         */
+        interface InVoicemail {
+            op: 'eq';
+            type: 'boolean';
+            value: boolean;
+        }
+        interface StringFilter {
+            /**
+             * eq: equal, ne: not equal, sw: starts with, ew: ends with, co: contains
+             */
+            op: 'eq' | 'ne' | 'sw' | 'ew' | 'co';
+            type: 'string';
+            value: string;
+            /**
+             * The field name to filter on.
+             */
+            key?: string;
+        }
+        interface NumberFilter {
+            /**
+             * eq: equal, ne: not equal, gt: greater than, ge: greater than or equal, lt: less
+             * than, le: less than or equal
+             */
+            op: 'eq' | 'ne' | 'gt' | 'ge' | 'lt' | 'le';
+            type: 'number';
+            value: number;
+            /**
+             * The field name to filter on.
+             */
+            key?: string;
+        }
+        interface BooleanFilter {
+            op: 'eq';
+            type: 'boolean';
+            value: boolean;
+            /**
+             * The field name to filter on.
+             */
+            key?: string;
+        }
+        interface RangeFilter {
+            /**
+             * bt: between
+             */
+            op: 'bt';
+            type: 'range';
+            /**
+             * [lower_bound, upper_bound]
+             */
+            value: Array<number>;
+            /**
+             * The field name to filter on.
+             */
+            key?: string;
+        }
+        interface EnumFilter {
+            /**
+             * in: value is one of the listed values
+             */
+            op: 'in';
+            type: 'enum';
+            value: Array<string>;
+            /**
+             * The field name to filter on.
+             */
+            key?: string;
+        }
+        interface PresentFilter {
+            /**
+             * pr: present (has value), np: not present
+             */
+            op: 'pr' | 'np';
+            type: 'present';
+            /**
+             * The field name to filter on.
+             */
+            key?: string;
+        }
+        interface NumberFilter {
+            /**
+             * eq: equal, ne: not equal, gt: greater than, ge: greater than or equal, lt: less
+             * than, le: less than or equal
+             */
+            op: 'eq' | 'ne' | 'gt' | 'ge' | 'lt' | 'le';
+            type: 'number';
+            value: number;
+        }
+        interface RangeFilter {
+            /**
+             * bt: between
+             */
+            op: 'bt';
+            type: 'range';
+            /**
+             * [lower_bound, upper_bound]
+             */
+            value: Array<number>;
+        }
+        /**
+         * Filter by to number.
+         */
+        interface ToNumber {
+            /**
+             * eq: equal, ne: not equal, sw: starts with, ew: ends with, co: contains
+             */
+            op: 'eq' | 'ne' | 'sw' | 'ew' | 'co';
+            type: 'string';
+            value: string;
+        }
+        interface ToolCall {
+            /**
+             * Filter by tool call latency in milliseconds.
+             */
+            latency_ms?: ToolCall.NumberFilter | ToolCall.RangeFilter;
+            /**
+             * The tool call name to filter on.
+             */
+            name?: string;
+            /**
+             * Filter by tool call success status.
+             */
+            success?: ToolCall.Success;
+            /**
+             * The tool call type to filter on.
+             */
+            type?: string;
+        }
+        namespace ToolCall {
+            interface NumberFilter {
                 /**
-                 * Stay within prompt/context scope, don't invent details.
+                 * eq: equal, ne: not equal, gt: greater than, ge: greater than or equal, lt: less
+                 * than, le: less than or equal
                  */
-                scope_boundaries?: boolean;
+                op: 'eq' | 'ne' | 'gt' | 'ge' | 'lt' | 'le';
+                type: 'number';
+                value: number;
+            }
+            interface RangeFilter {
                 /**
-                 * Treat near-match similar words as same entity to reduce impact of transcription
-                 * error (voice only).
+                 * bt: between
                  */
-                smart_matching?: boolean;
+                op: 'bt';
+                type: 'range';
                 /**
-                 * Convert numbers/dates/currency to spoken forms (voice only).
+                 * [lower_bound, upper_bound]
                  */
-                speech_normalization?: boolean;
+                value: Array<number>;
             }
             /**
-             * 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.
+             * Filter by tool call success status.
              */
-            interface IvrOption {
-                action: IvrOption.Action;
-                /**
-                 * Optionally describe what should be treated as an IVR. Leave as null to use the
-                 * default definition.
-                 */
-                detection_prompt?: string | null;
-            }
-            namespace IvrOption {
-                interface Action {
-                    type: 'hangup';
-                }
+            interface Success {
+                op: 'eq';
+                type: 'boolean';
+                value: boolean;
             }
+        }
+        interface UserSentiment {
             /**
-             * Configuration for PII scrubbing from transcripts and recordings.
+             * in: value is one of the listed values
              */
-            interface PiiConfig {
-                /**
-                 * List of PII categories to scrub from transcripts and recordings. PII redaction
-                 * is only active when this list is non-empty; an empty array means no PII
-                 * scrubbing is performed.
-                 */
-                categories: Array<'person_name' | 'address' | 'email' | 'phone_number' | 'ssn' | 'passport' | 'driver_license' | 'credit_card' | 'bank_account' | 'password' | 'pin' | 'medical_id' | 'date_of_birth' | 'customer_account_number'>;
-                /**
-                 * The processing mode for PII scrubbing. Currently only post-call is supported.
-                 */
-                mode: 'post_call';
-            }
-            interface StringAnalysisData {
-                /**
-                 * Description of the variable.
-                 */
-                description: string;
-                /**
-                 * Name of the variable.
-                 */
-                name: string;
-                /**
-                 * Type of the variable to extract.
-                 */
-                type: 'string';
-                /**
-                 * Optional instruction to help decide whether this field needs to be populated in
-                 * the analysis. If not set, the field is always included. If required is true,
-                 * this is ignored.
-                 */
-                conditional_prompt?: string;
-                /**
-                 * Examples of the variable value to teach model the style and syntax.
-                 */
-                examples?: Array<string>;
-                /**
-                 * Whether this data is required. If true and the data is not extracted, the call
-                 * will be marked as unsuccessful.
-                 */
-                required?: boolean;
-            }
-            interface EnumAnalysisData {
-                /**
-                 * The possible values of the variable, must be non empty array.
-                 */
-                choices: Array<string>;
-                /**
-                 * Description of the variable.
-                 */
-                description: string;
-                /**
-                 * Name of the variable.
-                 */
-                name: string;
-                /**
-                 * Type of the variable to extract.
-                 */
-                type: 'enum';
-                /**
-                 * Optional instruction to help decide whether this field needs to be populated in
-                 * the analysis. If not set, the field is always included. If required is true,
-                 * this is ignored.
-                 */
-                conditional_prompt?: string;
-                /**
-                 * Whether this data is required. If true and the data is not extracted, the call
-                 * will be marked as unsuccessful.
-                 */
-                required?: boolean;
-            }
-            interface BooleanAnalysisData {
-                /**
-                 * Description of the variable.
-                 */
-                description: string;
-                /**
-                 * Name of the variable.
-                 */
-                name: string;
-                /**
-                 * Type of the variable to extract.
-                 */
-                type: 'boolean';
-                /**
-                 * Optional instruction to help decide whether this field needs to be populated in
-                 * the analysis. If not set, the field is always included. If required is true,
-                 * this is ignored.
-                 */
-                conditional_prompt?: string;
-                /**
-                 * Whether this data is required. If true and the data is not extracted, the call
-                 * will be marked as unsuccessful.
-                 */
-                required?: boolean;
-            }
-            interface NumberAnalysisData {
-                /**
-                 * Description of the variable.
-                 */
-                description: string;
-                /**
-                 * Name of the variable.
-                 */
-                name: string;
-                /**
-                 * Type of the variable to extract.
-                 */
-                type: 'number';
-                /**
-                 * Optional instruction to help decide whether this field needs to be populated in
-                 * the analysis. If not set, the field is always included. If required is true,
-                 * this is ignored.
-                 */
-                conditional_prompt?: string;
-                /**
-                 * Whether this data is required. If true and the data is not extracted, the call
-                 * will be marked as unsuccessful.
-                 */
-                required?: boolean;
-            }
-            /**
-             * System preset for post-call analysis (voice agents). Use in
-             * post_call_analysis_data to override prompts or mark fields optional.
-             */
-            interface CallPresetAnalysisData {
-                /**
-                 * Preset identifier for voice agent analysis.
-                 */
-                name: 'call_summary' | 'call_successful' | 'user_sentiment';
-                /**
-                 * Identifies this item as a system preset.
-                 */
-                type: 'system-presets';
-                /**
-                 * Optional instruction to help decide whether this field needs to be populated. If
-                 * not set, the field is always included.
-                 */
-                conditional_prompt?: string;
-                /**
-                 * Prompt or description for this preset.
-                 */
-                description?: string;
-                /**
-                 * If false, this field is optional in the analysis. If true or unset, the field is
-                 * required.
-                 */
-                required?: boolean;
-            }
-            interface PronunciationDictionary {
-                /**
-                 * The phonetic alphabet to be used for pronunciation.
-                 */
-                alphabet: 'ipa' | 'cmu';
-                /**
-                 * Pronunciation of the word in the format of a IPA / CMU pronunciation.
-                 */
-                phoneme: string;
-                /**
-                 * The string of word / phrase to be annotated with pronunciation.
-                 */
-                word: string;
-            }
-            interface ResponseEngineRetellLm {
-                /**
-                 * id of the Retell LLM Response Engine.
-                 */
-                llm_id: string;
-                /**
-                 * type of the Response Engine.
-                 */
-                type: 'retell-llm';
-                /**
-                 * Version of the Retell LLM Response Engine.
-                 */
-                version?: number | null;
-            }
-            interface ResponseEngineCustomLm {
-                /**
-                 * LLM websocket url of the custom LLM.
-                 */
-                llm_websocket_url: string;
-                /**
-                 * type of the Response Engine.
-                 */
-                type: 'custom-llm';
-            }
-            interface ResponseEngineConversationFlow {
-                /**
-                 * ID of the Conversation Flow Response Engine.
-                 */
-                conversation_flow_id: string;
-                /**
-                 * type of the Response Engine.
-                 */
-                type: 'conversation-flow';
-                /**
-                 * Version of the Conversation Flow Response Engine.
-                 */
-                version?: number | null;
-            }
-            interface UserDtmfOptions {
-                /**
-                 * The maximum number of digits allowed in the user's DTMF (Dual-Tone
-                 * Multi-Frequency) input per turn. Once this limit is reached, the input is
-                 * considered complete and a response will be generated immediately.
-                 */
-                digit_limit?: number | null;
-                /**
-                 * A single key that signals the end of DTMF input. Acceptable values include any
-                 * digit (0-9), the pound/hash symbol (#), or the asterisk (\*).
-                 */
-                termination_key?: string | null;
-                /**
-                 * The time (in milliseconds) to wait for user DTMF input before timing out. The
-                 * timer resets with each digit received.
-                 */
-                timeout_ms?: number;
-            }
-            /**
-             * 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
-             * applied when the voicemail is detected. Set this to null to disable voicemail
-             * detection.
-             */
-            interface VoicemailOption {
-                action: VoicemailOption.VoicemailActionPrompt | VoicemailOption.VoicemailActionStaticText | VoicemailOption.VoicemailActionHangup | VoicemailOption.VoicemailActionBridgeTransfer;
-                /**
-                 * Optionally describe what should be treated as voicemail. Leave as null to use
-                 * the default definition.
-                 */
-                detection_prompt?: string | null;
-            }
-            namespace VoicemailOption {
-                interface VoicemailActionPrompt {
-                    /**
-                     * The prompt used to generate the text to be spoken when the call is detected to
-                     * be in voicemail.
-                     */
-                    text: string;
-                    type: 'prompt';
-                }
-                interface VoicemailActionStaticText {
-                    /**
-                     * The text to be spoken when the call is detected to be in voicemail.
-                     */
-                    text: string;
-                    type: 'static_text';
-                }
-                interface VoicemailActionHangup {
-                    type: 'hangup';
-                }
-                interface VoicemailActionBridgeTransfer {
-                    type: 'bridge_transfer';
-                }
-            }
-        }
-        /**
-         * Override conversation flow configuration settings. Only applicable when using
-         * conversation flow as the response engine. Supported attributes - model_choice,
-         * model_temperature, tool_call_strict_mode, knowledge_base_ids, kb_config,
-         * start_speaker, begin_after_user_silence_ms.
-         */
-        interface ConversationFlow {
-            /**
-             * If set, the AI will begin the conversation after waiting for the user for the
-             * duration (in milliseconds) specified by this attribute. This only applies if the
-             * agent is configured to wait for the user to speak first. If not set, the agent
-             * will wait indefinitely for the user to speak.
-             */
-            begin_after_user_silence_ms?: number | null;
-            /**
-             * Knowledge base configuration for RAG retrieval.
-             */
-            kb_config?: ConversationFlow.KBConfig;
-            /**
-             * Knowledge base IDs for RAG (Retrieval-Augmented Generation).
-             */
-            knowledge_base_ids?: Array<string> | null;
-            /**
-             * The model choice for the conversation flow.
-             */
-            model_choice?: ConversationFlow.ModelChoice;
-            /**
-             * Controls the randomness of the model's responses. Lower values make responses
-             * more deterministic.
-             */
-            model_temperature?: number | null;
-            /**
-             * Who starts the conversation - user or agent.
-             */
-            start_speaker?: 'user' | 'agent';
-            /**
-             * Whether to use strict mode for tool calls. Only applicable when using certain
-             * supported models.
-             */
-            tool_call_strict_mode?: boolean | null;
-        }
-        namespace ConversationFlow {
-            /**
-             * Knowledge base configuration for RAG retrieval.
-             */
-            interface KBConfig {
-                /**
-                 * Similarity threshold for filtering search results
-                 */
-                filter_score?: number;
-                /**
-                 * Max number of knowledge base chunks to retrieve
-                 */
-                top_k?: number;
-            }
-            /**
-             * The model choice for the conversation flow.
-             */
-            interface ModelChoice {
-                /**
-                 * The LLM model to use
-                 */
-                model: 'gpt-4.1' | 'gpt-4.1-mini' | 'gpt-4.1-nano' | 'gpt-5' | 'gpt-5-mini' | 'gpt-5-nano' | 'gpt-5.1' | 'gpt-5.2' | 'gpt-5.4' | 'gpt-5.4-mini' | 'gpt-5.4-nano' | 'gpt-5.5' | 'gpt-5.6-terra' | 'gpt-5.6-luna' | 'claude-4.5-sonnet' | 'claude-4.6-sonnet' | 'claude-5-sonnet' | 'claude-4.5-haiku' | 'gemini-3.0-flash' | 'gemini-3.1-flash-lite' | 'gemini-3.5-flash';
-                /**
-                 * Type of model choice
-                 */
-                type: 'cascading';
-                /**
-                 * Whether to use high priority pool with more dedicated resource, default false
-                 */
-                high_priority?: boolean;
-            }
-        }
-        /**
-         * 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,
-         * knowledge_base_ids, kb_config, start_speaker, begin_after_user_silence_ms,
-         * begin_message.
-         */
-        interface RetellLlm {
-            /**
-             * If set, the AI will begin the conversation after waiting for the user for the
-             * duration (in milliseconds) specified by this attribute. This only applies if the
-             * agent is configured to wait for the user to speak first. If not set, the agent
-             * will wait indefinitely for the user to speak.
-             */
-            begin_after_user_silence_ms?: number | null;
-            /**
-             * First utterance said by the agent in the call. If not set, LLM will dynamically
-             * generate a message. If set to "", agent will wait for user to speak first.
-             */
-            begin_message?: string | null;
-            /**
-             * Knowledge base configuration for RAG retrieval.
-             */
-            kb_config?: RetellLlm.KBConfig | null;
-            /**
-             * A list of knowledge base ids to use for this resource.
-             */
-            knowledge_base_ids?: Array<string> | null;
-            /**
-             * Select the underlying text LLM. If not set, would default to gpt-4.1.
-             */
-            model?: 'gpt-4.1' | 'gpt-4.1-mini' | 'gpt-4.1-nano' | 'gpt-5' | 'gpt-5-mini' | 'gpt-5-nano' | 'gpt-5.1' | 'gpt-5.2' | 'gpt-5.4' | 'gpt-5.4-mini' | 'gpt-5.4-nano' | 'gpt-5.5' | 'gpt-5.6-terra' | 'gpt-5.6-luna' | 'claude-4.5-sonnet' | 'claude-4.6-sonnet' | 'claude-5-sonnet' | 'claude-4.5-haiku' | 'gemini-3.0-flash' | 'gemini-3.1-flash-lite' | 'gemini-3.5-flash' | null;
-            /**
-             * If set to true, will use high priority pool with more dedicated resource to
-             * ensure lower and more consistent latency, default to false. This feature usually
-             * comes with a higher cost.
-             */
-            model_high_priority?: boolean | null;
-            /**
-             * If set, will control the randomness of the response. Value ranging from [0,1].
-             * Lower value means more deterministic, while higher value means more random. If
-             * unset, default value 0 will apply. Note that for tool calling, a lower value is
-             * recommended.
-             */
-            model_temperature?: number;
-            /**
-             * Select the underlying speech to speech model. Can only set this or model, not
-             * both.
-             */
-            s2s_model?: 'gpt-realtime-2.1' | 'gpt-realtime-2.1-mini' | 'gpt-realtime-2' | 'gpt-realtime-1.5' | 'gpt-realtime' | 'gpt-realtime-mini' | null;
-            /**
-             * The speaker who starts the conversation. Required. Must be either 'user' or
-             * 'agent'.
-             */
-            start_speaker?: 'user' | 'agent';
-            /**
-             * Whether to use strict mode for tool calls. Only applicable when using certain
-             * supported models.
-             */
-            tool_call_strict_mode?: boolean | null;
-        }
-        namespace RetellLlm {
-            /**
-             * Knowledge base configuration for RAG retrieval.
-             */
-            interface KBConfig {
-                /**
-                 * Similarity threshold for filtering search results
-                 */
-                filter_score?: number;
-                /**
-                 * Max number of knowledge base chunks to retrieve
-                 */
-                top_k?: number;
-            }
+            op: 'in';
+            type: 'enum';
+            value: Array<'Negative' | 'Positive' | 'Neutral' | 'Unknown'>;
         }
     }
 }
-export interface CallRegisterPhoneCallParams {
+export interface CallCreatePhoneCallParams {
     /**
-     * The agent to use for the call.
+     * The number you own in E.164 format. Must be a number purchased from Retell or
+     * imported to Retell.
+     */
+    from_number: string;
+    /**
+     * The number you want to call, in E.164 format. If using a number purchased from
+     * Retell, only US numbers are supported as destination.
      */
-    agent_id: string;
+    to_number: string;
     /**
      * For this particular call, override agent configuration with these settings. This
      * allows you to customize agent behavior for individual calls without modifying
      * the base agent.
      */
-    agent_override?: CallRegisterPhoneCallParams.AgentOverride;
-    /**
-     * The version of the agent to use for the call.
-     */
-    agent_version?: string | number;
+    agent_override?: CallCreatePhoneCallParams.AgentOverride;
     /**
-     * Direction of the phone call. Stored for tracking purpose.
+     * Add optional custom SIP headers to the call.
      */
-    direction?: 'inbound' | 'outbound';
+    custom_sip_headers?: {
+        [key: string]: string;
+    };
     /**
-     * The number you own in E.164 format. Stored for tracking purpose.
+     * If true, the e.164 validation will be ignored for the from_number. This can be
+     * useful when you want to dial to internal pseudo numbers. This only applies when
+     * you are using custom telephony and does not apply when you are using Retell
+     * Telephony. If omitted, the default value is false.
      */
-    from_number?: string;
+    ignore_e164_validation?: boolean;
     /**
      * An arbitrary object for storage purpose only. You can put anything here like
      * your internal customer id associated with the call. Not used for processing. You
      * can later get this field from the call object.
      */
     metadata?: unknown;
+    /**
+     * For this particular call, override the agent used with this agent id. This does
+     * not bind the agent to this number, this is for one time override.
+     */
+    override_agent_id?: string;
+    /**
+     * For this particular call, override the agent version used with this version.
+     * This does not bind the agent version to this number, this is for one time
+     * override.
+     */
+    override_agent_version?: string | number;
     /**
      * Add optional dynamic variables in key value pairs of string that injects into
      * your Response Engine prompt and tool description. Only applicable for Response
@@ -4230,12 +3942,8 @@ export interface CallRegisterPhoneCallParams {
     retell_llm_dynamic_variables?: {
         [key: string]: string;
     };
-    /**
-     * The number you want to call, in E.164 format. Stored for tracking purpose.
-     */
-    to_number?: string;
 }
-export declare namespace CallRegisterPhoneCallParams {
+export declare namespace CallCreatePhoneCallParams {
     /**
      * For this particular call, override agent configuration with these settings. This
      * allows you to customize agent behavior for individual calls without modifying
@@ -6082,659 +5790,951 @@ export declare namespace CallCreateWebCallParams {
         }
     }
 }
-export interface CallListParams {
+export interface CallRegisterPhoneCallParams {
     /**
-     * Filter criteria for calls. All conditions are implicitly connected with AND.
+     * The agent to use for the call.
      */
-    filter_criteria?: CallListParams.FilterCriteria;
+    agent_id: string;
     /**
-     * Whether to include `total` (count of all calls matching `filter_criteria`,
-     * ignoring `limit`/`skip`/`pagination_key`) in the response. Defaults to false.
-     * Each enabled request triggers an additional aggregate query, so opt in only when
-     * the total is needed.
+     * For this particular call, override agent configuration with these settings. This
+     * allows you to customize agent behavior for individual calls without modifying
+     * the base agent.
      */
-    include_total?: boolean;
+    agent_override?: CallRegisterPhoneCallParams.AgentOverride;
     /**
-     * Maximum number of calls to return.
+     * The version of the agent to use for the call.
      */
-    limit?: number;
+    agent_version?: string | number;
     /**
-     * Opaque pagination cursor from a previous response.
+     * Direction of the phone call. Stored for tracking purpose.
      */
-    pagination_key?: string;
+    direction?: 'inbound' | 'outbound';
     /**
-     * Number of records to skip for pagination.
+     * The number you own in E.164 format. Stored for tracking purpose.
      */
-    skip?: number;
+    from_number?: string;
     /**
-     * Sort calls by `start_timestamp` in ascending or descending order.
+     * An arbitrary object for storage purpose only. You can put anything here like
+     * your internal customer id associated with the call. Not used for processing. You
+     * can later get this field from the call object.
      */
-    sort_order?: 'ascending' | 'descending';
+    metadata?: unknown;
+    /**
+     * Add optional dynamic variables in key value pairs of string that injects into
+     * your Response Engine prompt and tool description. Only applicable for Response
+     * Engine.
+     */
+    retell_llm_dynamic_variables?: {
+        [key: string]: string;
+    };
+    /**
+     * The number you want to call, in E.164 format. Stored for tracking purpose.
+     */
+    to_number?: string;
 }
-export declare namespace CallListParams {
+export declare namespace CallRegisterPhoneCallParams {
     /**
-     * Filter criteria for calls. All conditions are implicitly connected with AND.
+     * For this particular call, override agent configuration with these settings. This
+     * allows you to customize agent behavior for individual calls without modifying
+     * the base agent.
      */
-    interface FilterCriteria {
-        /**
-         * Filter by agent(s). Agent filters are connected by OR.
-         */
-        agent?: Array<FilterCriteria.Agent>;
-        /**
-         * Filter by agent environment tag(s) (e.g. "prod", "staging").
-         */
-        agent_tag?: FilterCriteria.AgentTag;
-        /**
-         * Filter by batch call ID.
-         */
-        batch_call_id?: FilterCriteria.BatchCallID;
-        /**
-         * Filter by call ID.
-         */
-        call_id?: FilterCriteria.StringFilter | FilterCriteria.EnumFilter;
-        call_status?: FilterCriteria.CallStatus;
-        /**
-         * Filter by whether the call was successful.
-         */
-        call_successful?: FilterCriteria.CallSuccessful;
-        call_type?: FilterCriteria.CallType;
-        /**
-         * Filter by combined cost of the call.
-         */
-        combined_cost?: FilterCriteria.NumberFilter | FilterCriteria.RangeFilter;
-        /**
-         * Filter by custom analysis data fields.
-         */
-        custom_analysis_data?: Array<FilterCriteria.StringFilter | FilterCriteria.NumberFilter | FilterCriteria.BooleanFilter | FilterCriteria.RangeFilter | FilterCriteria.EnumFilter | FilterCriteria.PresentFilter>;
-        /**
-         * Filter by custom attributes fields.
-         */
-        custom_attributes?: Array<FilterCriteria.StringFilter | FilterCriteria.NumberFilter | FilterCriteria.BooleanFilter | FilterCriteria.RangeFilter | FilterCriteria.EnumFilter | FilterCriteria.PresentFilter>;
-        data_storage_setting?: FilterCriteria.DataStorageSetting;
-        direction?: FilterCriteria.Direction;
-        disconnection_reason?: FilterCriteria.DisconnectionReason;
-        /**
-         * Filter by call duration in milliseconds.
-         */
-        duration_ms?: FilterCriteria.NumberFilter | FilterCriteria.RangeFilter;
-        /**
-         * Filter by dynamic variables.
-         */
-        dynamic_variables?: Array<FilterCriteria.DynamicVariable>;
-        /**
-         * Filter by end-to-end latency p50.
-         */
-        e2e_latency_p50?: FilterCriteria.NumberFilter | FilterCriteria.RangeFilter;
-        /**
-         * Filter by call end timestamp (epoch ms).
-         */
-        end_timestamp?: FilterCriteria.NumberFilter | FilterCriteria.RangeFilter;
-        /**
-         * Filter by from number.
-         */
-        from_number?: FilterCriteria.FromNumber;
-        /**
-         * Filter by whether the call is in voicemail.
-         */
-        in_voicemail?: FilterCriteria.InVoicemail;
+    interface AgentOverride {
         /**
-         * Filter by metadata fields.
+         * Override agent configuration settings. Any properties specified here will
+         * override the base agent configuration for this call.
          */
-        metadata?: Array<FilterCriteria.StringFilter | FilterCriteria.NumberFilter | FilterCriteria.BooleanFilter | FilterCriteria.RangeFilter | FilterCriteria.EnumFilter | FilterCriteria.PresentFilter>;
+        agent?: AgentOverride.Agent;
         /**
-         * Filter by call start timestamp (epoch ms).
+         * Override conversation flow configuration settings. Only applicable when using
+         * conversation flow as the response engine. Supported attributes - model_choice,
+         * model_temperature, tool_call_strict_mode, knowledge_base_ids, kb_config,
+         * start_speaker, begin_after_user_silence_ms.
          */
-        start_timestamp?: FilterCriteria.NumberFilter | FilterCriteria.RangeFilter;
+        conversation_flow?: AgentOverride.ConversationFlow;
         /**
-         * Filter by to number.
+         * 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,
+         * knowledge_base_ids, kb_config, start_speaker, begin_after_user_silence_ms,
+         * begin_message.
          */
-        to_number?: FilterCriteria.ToNumber;
+        retell_llm?: AgentOverride.RetellLlm;
+    }
+    namespace AgentOverride {
         /**
-         * Filter by tool call criteria. Tool call filters are connected by AND.
+         * Override agent configuration settings. Any properties specified here will
+         * override the base agent configuration for this call.
          */
-        tool_calls?: Array<FilterCriteria.ToolCall>;
-        user_sentiment?: FilterCriteria.UserSentiment;
-    }
-    namespace FilterCriteria {
         interface Agent {
             /**
-             * The agent ID to filter on.
+             * The name of the agent. Only used for your own reference.
+             */
+            agent_name?: string | null;
+            /**
+             * If set to true, DTMF input will interrupt the agent even when
+             * interruption_sensitivity is 0. Can be overridden per conversation or subagent
+             * node. Default to false.
+             */
+            allow_dtmf_interruption?: boolean;
+            /**
+             * If set to true, DTMF input will be accepted and processed. If false, any DTMF
+             * input will be ignored. Default to true.
+             */
+            allow_user_dtmf?: boolean;
+            /**
+             * If set, will add ambient environment sound to the call to make experience more
+             * realistic. Currently supports the following options:
+             *
+             * - `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.
+             */
+            ambient_sound?: 'coffee-shop' | 'convention-hall' | 'summer-outdoor' | 'mountain-outdoor' | 'static-noise' | 'call-center' | null;
+            /**
+             * If set, will control the volume of the ambient sound. Value ranging from [0,2].
+             * Lower value means quieter ambient sound, while higher value means louder ambient
+             * sound. If unset, default value 1 will apply.
+             */
+            ambient_sound_volume?: number;
+            /**
+             * Only applicable when enable_backchannel is true. Controls how often the agent
+             * would backchannel when a backchannel is possible. Value ranging from [0,1].
+             * Lower value means less frequent backchannel, while higher value means more
+             * frequent backchannel. If unset, default value 0.8 will apply.
+             */
+            backchannel_frequency?: number;
+            /**
+             * Only applicable when enable_backchannel is true. A list of words that the agent
+             * would use as backchannel. If not set, default backchannel words will apply.
+             * Check out
+             * [backchannel default words](/agent/interaction-configuration#backchannel) for
+             * more details. Note that certain voices do not work too well with certain words,
+             * so it's recommended to experiment before adding any words.
+             */
+            backchannel_words?: Array<string> | null;
+            /**
+             * If set, will delay the first message by the specified amount of milliseconds, so
+             * that it gives user more time to prepare to take the call. Valid range is [0,
+             * 5000]. If not set or set to 0, agent will speak immediately. Only applicable
+             * when agent speaks first.
+             */
+            begin_message_delay_ms?: number;
+            /**
+             * Provide a customized list of keywords to bias the transcriber model, so that
+             * these words are more likely to get transcribed. Commonly used for names, brands,
+             * street, etc. Entries may reference dynamic variables with `{{variable}}` syntax.
+             */
+            boosted_keywords?: Array<string> | null;
+            /**
+             * If this option is set, the agent prompt will include call screen handling
+             * instructions for identity and call purpose questions. Set this to null to
+             * disable call screen prompt instructions.
+             */
+            call_screening_option?: Agent.CallScreeningOption | null;
+            /**
+             * Custom STT configuration. Only used when stt_mode is set to custom.
              */
-            agent_id: string;
+            custom_stt_config?: Agent.CustomSttConfig | null;
             /**
-             * Specific versions to filter on. If not provided, all versions are included.
+             * Number of days to retain call/chat data before automatic deletion. Must be
+             * between 1 and 730 days. If not set, data is retained forever (no automatic
+             * deletion).
              */
-            version?: Array<number>;
-        }
-        /**
-         * Filter by agent environment tag(s) (e.g. "prod", "staging").
-         */
-        interface AgentTag {
+            data_storage_retention_days?: number | null;
             /**
-             * in: value is one of the listed values
+             * Granular setting to manage how Retell stores sensitive data (transcripts,
+             * recordings, logs, etc.). This replaces the deprecated
+             * `opt_out_sensitive_data_storage` field.
+             *
+             * - `everything`: Store all data including transcripts, recordings, and logs.
+             * - `everything_except_pii`: Store data without PII when PII is detected.
+             * - `basic_attributes_only`: Store only basic attributes; no
+             *   transcripts/recordings/logs. If not set, default value of "everything" will
+             *   apply.
              */
-            op: 'in';
-            type: 'enum';
-            value: Array<string>;
-        }
-        /**
-         * Filter by batch call ID.
-         */
-        interface BatchCallID {
+            data_storage_setting?: 'everything' | 'everything_except_pii' | 'basic_attributes_only';
             /**
-             * eq: equal, ne: not equal, sw: starts with, ew: ends with, co: contains
+             * If set, determines what denoising mode to use. Use "no-denoise" to bypass all
+             * audio denoising. Default to noise-cancellation.
              */
-            op: 'eq' | 'ne' | 'sw' | 'ew' | 'co';
-            type: 'string';
-            value: string;
-        }
-        interface StringFilter {
+            denoising_mode?: 'no-denoise' | 'noise-cancellation' | 'noise-and-background-speech-cancellation';
             /**
-             * eq: equal, ne: not equal, sw: starts with, ew: ends with, co: contains
+             * Controls whether the agent would backchannel (agent interjects the speaker with
+             * phrases like "yeah", "uh-huh" to signify interest and engagement). Backchannel
+             * when enabled tends to show up more in longer user utterances. If not set, agent
+             * will not backchannel.
              */
-            op: 'eq' | 'ne' | 'sw' | 'ew' | 'co';
-            type: 'string';
-            value: string;
-        }
-        interface EnumFilter {
+            enable_backchannel?: boolean;
             /**
-             * in: value is one of the listed values
+             * If set to true, the agent will dynamically adjust how quickly it responds based
+             * on the user's speech rate and past turn-taking behavior in the call. If unset,
+             * default value false will apply.
              */
-            op: 'in';
-            type: 'enum';
-            value: Array<string>;
-        }
-        interface CallStatus {
+            enable_dynamic_responsiveness?: boolean;
             /**
-             * in: value is one of the listed values
+             * 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.
              */
-            op: 'in';
-            type: 'enum';
-            value: Array<'not_connected' | 'ongoing' | 'ended' | 'error'>;
-        }
-        /**
-         * Filter by whether the call was successful.
-         */
-        interface CallSuccessful {
-            op: 'eq';
-            type: 'boolean';
-            value: boolean;
-        }
-        interface CallType {
+            enable_dynamic_voice_speed?: boolean;
             /**
-             * in: value is one of the listed values
+             * Master toggle for expressive mode. When true, the agent may add expressive voice
+             * tags to the audio it generates. Only applicable for platform voices. If unset,
+             * defaults to false.
              */
-            op: 'in';
-            type: 'enum';
-            value: Array<'web_call' | 'phone_call'>;
-        }
-        interface NumberFilter {
+            enable_expressive_mode?: boolean;
             /**
-             * eq: equal, ne: not equal, gt: greater than, ge: greater than or equal, lt: less
-             * than, le: less than or equal
+             * 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).
              */
-            op: 'eq' | 'ne' | 'gt' | 'ge' | 'lt' | 'le';
-            type: 'number';
-            value: number;
-        }
-        interface RangeFilter {
+            end_call_after_silence_ms?: number;
             /**
-             * bt: between
+             * The expressive voice tags Retell pre-teaches the model to use when
+             * enable_expressive_mode is true. Custom tags defined in the system prompt are
+             * still allowed. If empty, the agent follows general expressive guidance without a
+             * fixed tag set.
              */
-            op: 'bt';
-            type: 'range';
+            expressive_emotion_tags?: Array<'empathetic' | 'excited' | 'happy' | 'curious' | 'surprised' | 'sigh' | 'clear throat' | 'pause' | 'long pause' | 'emphasis'>;
             /**
-             * [lower_bound, upper_bound]
+             * Custom expressive voice guidance to use instead of the default Retell expressive
+             * prompt when enable_expressive_mode is true. If omitted or blank, the default
+             * expressive prompt will be used.
              */
-            value: Array<number>;
-        }
-        interface StringFilter {
+            expressive_mode_prompt?: string | null;
             /**
-             * eq: equal, ne: not equal, sw: starts with, ew: ends with, co: contains
+             * When TTS provider for the selected voice is experiencing outages, we would use
+             * fallback voices listed here for the agent. Voice id and the fallback voice ids
+             * must be from different TTS providers. The system would go through the list in
+             * order, if the first one in the list is also having outage, it would use the next
+             * one. Set to null to remove voice fallback for the agent.
              */
-            op: 'eq' | 'ne' | 'sw' | 'ew' | 'co';
-            type: 'string';
-            value: string;
+            fallback_voice_ids?: Array<string> | null;
             /**
-             * The field name to filter on.
+             * Configuration for guardrail checks to detect and prevent prohibited topics in
+             * agent output and user input.
              */
-            key?: string;
-        }
-        interface NumberFilter {
+            guardrail_config?: Agent.GuardrailConfig;
             /**
-             * eq: equal, ne: not equal, gt: greater than, ge: greater than or equal, lt: less
-             * than, le: less than or equal
+             * Toggle behavior presets on/off to influence agent response style and behaviors.
              */
-            op: 'eq' | 'ne' | 'gt' | 'ge' | 'lt' | 'le';
-            type: 'number';
-            value: number;
+            handbook_config?: Agent.HandbookConfig;
             /**
-             * The field name to filter on.
+             * 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
+             * agent, while higher value means it's easier for user to interrupt agent. If
+             * unset, default value 1 will apply. When this is set to 0, agent would never be
+             * interrupted.
              */
-            key?: string;
-        }
-        interface BooleanFilter {
-            op: 'eq';
-            type: 'boolean';
-            value: boolean;
+            interruption_sensitivity?: number;
             /**
-             * The field name to filter on.
+             * 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.
              */
-            key?: string;
-        }
-        interface RangeFilter {
+            ivr_option?: Agent.IvrOption | null;
             /**
-             * bt: between
+             * Specifies what language(s) the agent will operate in. Accepts either a single
+             * scalar locale (e.g. `en-US`), the legacy scalar value `multi` for multilingual
+             * support, or an array of concrete locale codes for explicit multi-locale
+             * selection (e.g. `["en-US","es-ES"]`). The array form must contain concrete
+             * locale codes only — the `multi` value is valid only as the scalar legacy form
+             * and must not appear inside an array. Single-element arrays are normalized to the
+             * equivalent scalar on output. If unset, defaults to `en-US`.
              */
-            op: 'bt';
-            type: 'range';
+            language?: 'en-US' | 'en-IN' | 'en-GB' | 'en-AU' | 'en-NZ' | 'de-DE' | 'es-ES' | 'es-419' | 'hi-IN' | 'fr-FR' | 'fr-CA' | 'ja-JP' | 'pt-PT' | 'pt-BR' | 'zh-CN' | 'ru-RU' | 'it-IT' | 'ko-KR' | 'nl-NL' | 'nl-BE' | 'pl-PL' | 'tr-TR' | 'vi-VN' | 'ro-RO' | 'bg-BG' | 'ca-ES' | 'th-TH' | 'da-DK' | 'fi-FI' | 'el-GR' | 'hu-HU' | 'id-ID' | 'no-NO' | 'sk-SK' | 'sv-SE' | 'lt-LT' | 'lv-LV' | 'cs-CZ' | 'ms-MY' | 'af-ZA' | 'ar-SA' | 'az-AZ' | 'bs-BA' | 'cy-GB' | 'fa-IR' | 'fil-PH' | 'gl-ES' | 'he-IL' | 'hr-HR' | 'hy-AM' | 'is-IS' | 'kk-KZ' | 'kn-IN' | 'mk-MK' | 'mr-IN' | 'ne-NP' | 'sl-SI' | 'sr-RS' | 'sw-KE' | 'ta-IN' | 'ur-IN' | 'yue-CN' | 'uk-UA' | 'multi' | Array<'en-US' | 'en-IN' | 'en-GB' | 'en-AU' | 'en-NZ' | 'de-DE' | 'es-ES' | 'es-419' | 'hi-IN' | 'fr-FR' | 'fr-CA' | 'ja-JP' | 'pt-PT' | 'pt-BR' | 'zh-CN' | 'ru-RU' | 'it-IT' | 'ko-KR' | 'nl-NL' | 'nl-BE' | 'pl-PL' | 'tr-TR' | 'vi-VN' | 'ro-RO' | 'bg-BG' | 'ca-ES' | 'th-TH' | 'da-DK' | 'fi-FI' | 'el-GR' | 'hu-HU' | 'id-ID' | 'no-NO' | 'sk-SK' | 'sv-SE' | 'lt-LT' | 'lv-LV' | 'cs-CZ' | 'ms-MY' | 'af-ZA' | 'ar-SA' | 'az-AZ' | 'bs-BA' | 'cy-GB' | 'fa-IR' | 'fil-PH' | 'gl-ES' | 'he-IL' | 'hr-HR' | 'hy-AM' | 'is-IS' | 'kk-KZ' | 'kn-IN' | 'mk-MK' | 'mr-IN' | 'ne-NP' | 'sl-SI' | 'sr-RS' | 'sw-KE' | 'ta-IN' | 'ur-IN' | 'yue-CN' | 'uk-UA'>;
             /**
-             * [lower_bound, upper_bound]
+             * Maximum allowed length for the call, will force end the call if reached. The
+             * minimum value allowed is 60,000 ms (1 min), and maximum value allowed is
+             * 7,200,000 (2 hours). By default, this is set to 3,600,000 (1 hour).
              */
-            value: Array<number>;
+            max_call_duration_ms?: number;
             /**
-             * The field name to filter on.
+             * Whether this agent opts in for signed URLs for public logs and recordings. When
+             * enabled, the generated URLs will include security signatures that restrict
+             * access and automatically expire after 24 hours.
              */
-            key?: string;
-        }
-        interface EnumFilter {
+            opt_in_signed_url?: boolean;
             /**
-             * in: value is one of the listed values
+             * Configuration for PII scrubbing from transcripts and recordings.
              */
-            op: 'in';
-            type: 'enum';
-            value: Array<string>;
+            pii_config?: Agent.PiiConfig;
             /**
-             * The field name to filter on.
+             * Post call analysis data to extract from the call. This data will augment the
+             * pre-defined variables extracted in the call analysis. This will be available
+             * after the call ends.
              */
-            key?: string;
-        }
-        interface PresentFilter {
+            post_call_analysis_data?: Array<Agent.StringAnalysisData | Agent.EnumAnalysisData | Agent.BooleanAnalysisData | Agent.NumberAnalysisData | Agent.CallPresetAnalysisData> | null;
             /**
-             * pr: present (has value), np: not present
+             * The model to use for post call analysis. Default to gpt-4.1.
              */
-            op: 'pr' | 'np';
-            type: 'present';
+            post_call_analysis_model?: 'gpt-4.1' | 'gpt-4.1-mini' | 'gpt-4.1-nano' | 'gpt-5' | 'gpt-5-mini' | 'gpt-5-nano' | 'gpt-5.1' | 'gpt-5.2' | 'gpt-5.4' | 'gpt-5.4-mini' | 'gpt-5.4-nano' | 'gpt-5.5' | 'gpt-5.6-terra' | 'gpt-5.6-luna' | 'claude-4.5-sonnet' | 'claude-4.6-sonnet' | 'claude-5-sonnet' | 'claude-4.5-haiku' | 'gemini-3.0-flash' | 'gemini-3.1-flash-lite' | 'gemini-3.5-flash' | null;
             /**
-             * The field name to filter on.
+             * A list of words / phrases and their pronunciation to be used to guide the audio
+             * synthesize for consistent pronunciation. Check the dashboard to see what
+             * provider supports this feature. Set to null to remove pronunciation dictionary
+             * from this agent.
              */
-            key?: string;
-        }
-        interface StringFilter {
+            pronunciation_dictionary?: Array<Agent.PronunciationDictionary> | null;
             /**
-             * eq: equal, ne: not equal, sw: starts with, ew: ends with, co: contains
+             * If set, controls how many times agent would remind user when user is
+             * unresponsive. Must be a non negative integer. If unset, default value of 1 will
+             * apply (remind once). Set to 0 to disable agent from reminding.
              */
-            op: 'eq' | 'ne' | 'sw' | 'ew' | 'co';
-            type: 'string';
-            value: string;
+            reminder_max_count?: number;
             /**
-             * The field name to filter on.
+             * If set (in milliseconds), will trigger a reminder to the agent to speak if the
+             * user has been silent for the specified duration after some agent speech. Must be
+             * a positive number. If unset, default value of 10000 ms (10 s) will apply.
              */
-            key?: string;
-        }
-        interface NumberFilter {
+            reminder_trigger_ms?: number;
             /**
-             * eq: equal, ne: not equal, gt: greater than, ge: greater than or equal, lt: less
-             * than, le: less than or equal
+             * The Response Engine to attach to the agent. It is used to generate responses for
+             * the agent. You need to create a Response Engine first before attaching it to an
+             * agent.
              */
-            op: 'eq' | 'ne' | 'gt' | 'ge' | 'lt' | 'le';
-            type: 'number';
-            value: number;
+            response_engine?: Agent.ResponseEngineRetellLm | Agent.ResponseEngineCustomLm | Agent.ResponseEngineConversationFlow;
             /**
-             * The field name to filter on.
+             * Controls how responsive is the agent. Value ranging from [0,1]. Lower value
+             * means less responsive agent (wait more, respond slower), while higher value
+             * means faster exchanges (respond when it can). If unset, default value 1 will
+             * apply.
              */
-            key?: string;
-        }
-        interface BooleanFilter {
-            op: 'eq';
-            type: 'boolean';
-            value: boolean;
+            responsiveness?: number;
+            /**
+             * If set, the phone ringing will last for the specified amount of milliseconds.
+             * This applies for both outbound call ringtime, and call transfer ringtime.
+             * Default to 30000 (30 s). Valid range is [5000, 300000].
+             */
+            ring_duration_ms?: number;
             /**
-             * The field name to filter on.
+             * The expiration time for the signed url in milliseconds. Only applicable when
+             * opt_in_signed_url is true. If not set, default value of 86400000 (24 hours) will
+             * apply.
              */
-            key?: string;
-        }
-        interface RangeFilter {
+            signed_url_expiration_ms?: number | null;
             /**
-             * bt: between
+             * If set, determines whether speech to text should focus on latency or accuracy.
+             * Default to fast mode. When set to custom, custom_stt_config must be provided.
              */
-            op: 'bt';
-            type: 'range';
+            stt_mode?: 'fast' | 'accurate' | 'custom';
             /**
-             * [lower_bound, upper_bound]
+             * IANA timezone for the agent (e.g. America/New_York). Defaults to
+             * America/Los_Angeles if not set.
              */
-            value: Array<number>;
+            timezone?: string | null;
+            user_dtmf_options?: Agent.UserDtmfOptions | null;
             /**
-             * The field name to filter on.
+             * Optional description of the agent version. Used for your own reference and
+             * documentation.
              */
-            key?: string;
-        }
-        interface EnumFilter {
+            version_description?: string | null;
             /**
-             * in: value is one of the listed values
+             * Optional title of the agent version. Used for your own reference.
              */
-            op: 'in';
-            type: 'enum';
-            value: Array<string>;
+            version_title?: string | null;
             /**
-             * The field name to filter on.
+             * 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.
+             * Default to general.
              */
-            key?: string;
-        }
-        interface PresentFilter {
+            vocab_specialization?: 'general' | 'medical';
             /**
-             * pr: present (has value), np: not present
+             * Controls the emotional tone of the agent's voice. Currently supported for
+             * Cartesia and Minimax TTS providers. If unset, no emotion will be used.
              */
-            op: 'pr' | 'np';
-            type: 'present';
+            voice_emotion?: 'calm' | 'sympathetic' | 'happy' | 'sad' | 'angry' | 'fearful' | 'surprised' | null;
             /**
-             * The field name to filter on.
+             * Unique voice id used for the agent. Find list of available voices and their
+             * preview in Dashboard.
              */
-            key?: string;
-        }
-        interface DataStorageSetting {
+            voice_id?: string;
             /**
-             * in: value is one of the listed values
+             * 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.
              */
-            op: 'in';
-            type: 'enum';
-            value: Array<'everything' | 'everything_except_pii' | 'basic_attributes_only'>;
-        }
-        interface Direction {
+            voice_model?: 'eleven_flash_v2' | 'eleven_flash_v2_5' | 'eleven_multilingual_v2' | 'eleven_v3' | 'sonic-3' | 'sonic-3-latest' | 'sonic-3.5' | 'tts-1' | 'gpt-4o-mini-tts' | 'speech-02-turbo' | 'speech-2.8-turbo' | 's1' | 's2-pro' | 's2.1-pro' | null;
             /**
-             * in: value is one of the listed values
+             * Controls speed of voice. Value ranging from [0.5,2]. Lower value means slower
+             * speech, while higher value means faster speech rate. If unset, default value 1
+             * will apply.
              */
-            op: 'in';
-            type: 'enum';
-            value: Array<'inbound' | 'outbound'>;
-        }
-        interface DisconnectionReason {
+            voice_speed?: number;
             /**
-             * in: value is one of the listed values
+             * Controls how stable the voice is. Value ranging from [0,2]. Lower value means
+             * more stable, and higher value means more variant speech generation. Check the
+             * dashboard to see what provider supports this feature. If unset, default value 1
+             * will apply.
              */
-            op: 'in';
-            type: 'enum';
-            value: Array<'user_hangup' | 'agent_hangup' | 'call_transfer' | 'voicemail_reached' | 'ivr_reached' | 'inactivity' | 'max_duration_reached' | 'concurrency_limit_reached' | 'no_concurrency_fallback' | 'no_valid_payment' | 'scam_detected' | 'dial_busy' | 'dial_failed' | 'dial_no_answer' | 'invalid_destination' | 'telephony_provider_permission_denied' | 'telephony_provider_unavailable' | 'sip_routing_error' | 'marked_as_spam' | 'user_declined' | 'error_llm_websocket_open' | 'error_llm_websocket_lost_connection' | 'error_llm_websocket_runtime' | 'error_llm_websocket_corrupt_payload' | 'error_no_audio_received' | 'error_asr' | 'error_retell' | 'error_unknown' | 'error_user_not_joined' | 'registered_call_timeout' | 'transfer_bridged' | 'transfer_cancelled' | 'manual_stopped' | 'call_take_over'>;
-        }
-        interface NumberFilter {
+            voice_temperature?: number;
             /**
-             * eq: equal, ne: not equal, gt: greater than, ge: greater than or equal, lt: less
-             * than, le: less than or equal
+             * 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
+             * applied when the voicemail is detected. Set this to null to disable voicemail
+             * detection.
              */
-            op: 'eq' | 'ne' | 'gt' | 'ge' | 'lt' | 'le';
-            type: 'number';
-            value: number;
-        }
-        interface RangeFilter {
+            voicemail_option?: Agent.VoicemailOption | null;
             /**
-             * bt: between
+             * If set, will control the volume of the agent. Value ranging from [0,2]. Lower
+             * value means quieter agent speech, while higher value means louder agent speech.
+             * If unset, default value 1 will apply.
              */
-            op: 'bt';
-            type: 'range';
+            volume?: number;
             /**
-             * [lower_bound, upper_bound]
+             * Which webhook events this agent should receive. If not set, defaults to
+             * call_started, call_ended, call_analyzed.
              */
-            value: Array<number>;
-        }
-        interface DynamicVariable {
+            webhook_events?: Array<'call_started' | 'call_ended' | 'call_analyzed' | 'transcript_updated' | 'transfer_started' | 'transfer_bridged' | 'transfer_cancelled' | 'transfer_ended'> | null;
             /**
-             * The dynamic variable name to filter on.
+             * The timeout for the webhook in milliseconds. If not set, default value of 10000
+             * will apply.
              */
-            key: string;
+            webhook_timeout_ms?: number;
             /**
-             * eq: equal, ne: not equal, sw: starts with, ew: ends with, co: contains
+             * The webhook for agent to listen to call events. See what events it would get at
+             * [webhook doc](/features/webhook). If set, will binds webhook events for this
+             * agent to the specified url, and will ignore the account level webhook for this
+             * agent. Set to `null` to remove webhook url from this agent.
              */
-            op: 'eq' | 'ne' | 'sw' | 'ew' | 'co';
-            type: 'string';
-            value: string;
+            webhook_url?: string | null;
         }
-        interface NumberFilter {
+        namespace Agent {
             /**
-             * eq: equal, ne: not equal, gt: greater than, ge: greater than or equal, lt: less
-             * than, le: less than or equal
+             * If this option is set, the agent prompt will include call screen handling
+             * instructions for identity and call purpose questions. Set this to null to
+             * disable call screen prompt instructions.
              */
-            op: 'eq' | 'ne' | 'gt' | 'ge' | 'lt' | 'le';
-            type: 'number';
-            value: number;
-        }
-        interface RangeFilter {
+            interface CallScreeningOption {
+                /**
+                 * Identity the agent should provide when a call screen asks who is calling.
+                 * Dynamic variables are supported.
+                 */
+                agent_identity: string;
+                /**
+                 * Purpose the agent should provide when a call screen asks why it is calling.
+                 * Dynamic variables are supported.
+                 */
+                call_purpose: string;
+            }
             /**
-             * bt: between
+             * Custom STT configuration. Only used when stt_mode is set to custom.
              */
-            op: 'bt';
-            type: 'range';
+            interface CustomSttConfig {
+                /**
+                 * Endpointing timeout in milliseconds. Minimum is 100 for Azure, 10 for Deepgram,
+                 * 500 for Soniox, 100 for AssemblyAI.
+                 */
+                endpointing_ms: number;
+                /**
+                 * ASR provider name.
+                 */
+                provider: 'azure' | 'deepgram' | 'soniox' | 'assemblyai';
+            }
             /**
-             * [lower_bound, upper_bound]
+             * Configuration for guardrail checks to detect and prevent prohibited topics in
+             * agent output and user input.
              */
-            value: Array<number>;
-        }
-        interface NumberFilter {
+            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;
+            }
             /**
-             * eq: equal, ne: not equal, gt: greater than, ge: greater than or equal, lt: less
-             * than, le: less than or equal
+             * Toggle behavior presets on/off to influence agent response style and behaviors.
              */
-            op: 'eq' | 'ne' | 'gt' | 'ge' | 'lt' | 'le';
-            type: 'number';
-            value: number;
-        }
-        interface RangeFilter {
+            interface HandbookConfig {
+                /**
+                 * When asked, acknowledge being a virtual assistant.
+                 */
+                ai_disclosure?: boolean;
+                /**
+                 * Enables Conversational Personality. When true, the agent uses the Conversational
+                 * Personality handbook preset, skips Professional Rep Personality during prompt
+                 * assembly, and enables internal colloquial rewrite behavior.
+                 */
+                conversational_personality?: boolean;
+                /**
+                 * Professional call center rep baseline.
+                 */
+                default_personality?: boolean;
+                /**
+                 * Repeat back and confirm important details (voice only).
+                 */
+                echo_verification?: boolean;
+                /**
+                 * Warm acknowledgment of caller concerns.
+                 */
+                high_empathy?: boolean;
+                /**
+                 * Spell using NATO phonetic alphabet style (voice only).
+                 */
+                nato_phonetic_alphabet?: boolean;
+                /**
+                 * Sprinkle natural speech fillers like "um", "you know" for a more human,
+                 * conversational tone.
+                 */
+                natural_filler_words?: boolean;
+                /**
+                 * Stay within prompt/context scope, don't invent details.
+                 */
+                scope_boundaries?: boolean;
+                /**
+                 * Treat near-match similar words as same entity to reduce impact of transcription
+                 * error (voice only).
+                 */
+                smart_matching?: boolean;
+                /**
+                 * Convert numbers/dates/currency to spoken forms (voice only).
+                 */
+                speech_normalization?: 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.
+             */
+            interface IvrOption {
+                action: IvrOption.Action;
+                /**
+                 * Optionally describe what should be treated as an IVR. Leave as null to use the
+                 * default definition.
+                 */
+                detection_prompt?: string | null;
+            }
+            namespace IvrOption {
+                interface Action {
+                    type: 'hangup';
+                }
+            }
             /**
-             * bt: between
+             * Configuration for PII scrubbing from transcripts and recordings.
              */
-            op: 'bt';
-            type: 'range';
+            interface PiiConfig {
+                /**
+                 * List of PII categories to scrub from transcripts and recordings. PII redaction
+                 * is only active when this list is non-empty; an empty array means no PII
+                 * scrubbing is performed.
+                 */
+                categories: Array<'person_name' | 'address' | 'email' | 'phone_number' | 'ssn' | 'passport' | 'driver_license' | 'credit_card' | 'bank_account' | 'password' | 'pin' | 'medical_id' | 'date_of_birth' | 'customer_account_number'>;
+                /**
+                 * The processing mode for PII scrubbing. Currently only post-call is supported.
+                 */
+                mode: 'post_call';
+            }
+            interface StringAnalysisData {
+                /**
+                 * Description of the variable.
+                 */
+                description: string;
+                /**
+                 * Name of the variable.
+                 */
+                name: string;
+                /**
+                 * Type of the variable to extract.
+                 */
+                type: 'string';
+                /**
+                 * Optional instruction to help decide whether this field needs to be populated in
+                 * the analysis. If not set, the field is always included. If required is true,
+                 * this is ignored.
+                 */
+                conditional_prompt?: string;
+                /**
+                 * Examples of the variable value to teach model the style and syntax.
+                 */
+                examples?: Array<string>;
+                /**
+                 * Whether this data is required. If true and the data is not extracted, the call
+                 * will be marked as unsuccessful.
+                 */
+                required?: boolean;
+            }
+            interface EnumAnalysisData {
+                /**
+                 * The possible values of the variable, must be non empty array.
+                 */
+                choices: Array<string>;
+                /**
+                 * Description of the variable.
+                 */
+                description: string;
+                /**
+                 * Name of the variable.
+                 */
+                name: string;
+                /**
+                 * Type of the variable to extract.
+                 */
+                type: 'enum';
+                /**
+                 * Optional instruction to help decide whether this field needs to be populated in
+                 * the analysis. If not set, the field is always included. If required is true,
+                 * this is ignored.
+                 */
+                conditional_prompt?: string;
+                /**
+                 * Whether this data is required. If true and the data is not extracted, the call
+                 * will be marked as unsuccessful.
+                 */
+                required?: boolean;
+            }
+            interface BooleanAnalysisData {
+                /**
+                 * Description of the variable.
+                 */
+                description: string;
+                /**
+                 * Name of the variable.
+                 */
+                name: string;
+                /**
+                 * Type of the variable to extract.
+                 */
+                type: 'boolean';
+                /**
+                 * Optional instruction to help decide whether this field needs to be populated in
+                 * the analysis. If not set, the field is always included. If required is true,
+                 * this is ignored.
+                 */
+                conditional_prompt?: string;
+                /**
+                 * Whether this data is required. If true and the data is not extracted, the call
+                 * will be marked as unsuccessful.
+                 */
+                required?: boolean;
+            }
+            interface NumberAnalysisData {
+                /**
+                 * Description of the variable.
+                 */
+                description: string;
+                /**
+                 * Name of the variable.
+                 */
+                name: string;
+                /**
+                 * Type of the variable to extract.
+                 */
+                type: 'number';
+                /**
+                 * Optional instruction to help decide whether this field needs to be populated in
+                 * the analysis. If not set, the field is always included. If required is true,
+                 * this is ignored.
+                 */
+                conditional_prompt?: string;
+                /**
+                 * Whether this data is required. If true and the data is not extracted, the call
+                 * will be marked as unsuccessful.
+                 */
+                required?: boolean;
+            }
             /**
-             * [lower_bound, upper_bound]
+             * System preset for post-call analysis (voice agents). Use in
+             * post_call_analysis_data to override prompts or mark fields optional.
              */
-            value: Array<number>;
-        }
-        /**
-         * Filter by from number.
-         */
-        interface FromNumber {
+            interface CallPresetAnalysisData {
+                /**
+                 * Preset identifier for voice agent analysis.
+                 */
+                name: 'call_summary' | 'call_successful' | 'user_sentiment';
+                /**
+                 * Identifies this item as a system preset.
+                 */
+                type: 'system-presets';
+                /**
+                 * Optional instruction to help decide whether this field needs to be populated. If
+                 * not set, the field is always included.
+                 */
+                conditional_prompt?: string;
+                /**
+                 * Prompt or description for this preset.
+                 */
+                description?: string;
+                /**
+                 * If false, this field is optional in the analysis. If true or unset, the field is
+                 * required.
+                 */
+                required?: boolean;
+            }
+            interface PronunciationDictionary {
+                /**
+                 * The phonetic alphabet to be used for pronunciation.
+                 */
+                alphabet: 'ipa' | 'cmu';
+                /**
+                 * Pronunciation of the word in the format of a IPA / CMU pronunciation.
+                 */
+                phoneme: string;
+                /**
+                 * The string of word / phrase to be annotated with pronunciation.
+                 */
+                word: string;
+            }
+            interface ResponseEngineRetellLm {
+                /**
+                 * id of the Retell LLM Response Engine.
+                 */
+                llm_id: string;
+                /**
+                 * type of the Response Engine.
+                 */
+                type: 'retell-llm';
+                /**
+                 * Version of the Retell LLM Response Engine.
+                 */
+                version?: number | null;
+            }
+            interface ResponseEngineCustomLm {
+                /**
+                 * LLM websocket url of the custom LLM.
+                 */
+                llm_websocket_url: string;
+                /**
+                 * type of the Response Engine.
+                 */
+                type: 'custom-llm';
+            }
+            interface ResponseEngineConversationFlow {
+                /**
+                 * ID of the Conversation Flow Response Engine.
+                 */
+                conversation_flow_id: string;
+                /**
+                 * type of the Response Engine.
+                 */
+                type: 'conversation-flow';
+                /**
+                 * Version of the Conversation Flow Response Engine.
+                 */
+                version?: number | null;
+            }
+            interface UserDtmfOptions {
+                /**
+                 * The maximum number of digits allowed in the user's DTMF (Dual-Tone
+                 * Multi-Frequency) input per turn. Once this limit is reached, the input is
+                 * considered complete and a response will be generated immediately.
+                 */
+                digit_limit?: number | null;
+                /**
+                 * A single key that signals the end of DTMF input. Acceptable values include any
+                 * digit (0-9), the pound/hash symbol (#), or the asterisk (\*).
+                 */
+                termination_key?: string | null;
+                /**
+                 * The time (in milliseconds) to wait for user DTMF input before timing out. The
+                 * timer resets with each digit received.
+                 */
+                timeout_ms?: number;
+            }
             /**
-             * eq: equal, ne: not equal, sw: starts with, ew: ends with, co: contains
+             * 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
+             * applied when the voicemail is detected. Set this to null to disable voicemail
+             * detection.
              */
-            op: 'eq' | 'ne' | 'sw' | 'ew' | 'co';
-            type: 'string';
-            value: string;
+            interface VoicemailOption {
+                action: VoicemailOption.VoicemailActionPrompt | VoicemailOption.VoicemailActionStaticText | VoicemailOption.VoicemailActionHangup | VoicemailOption.VoicemailActionBridgeTransfer;
+                /**
+                 * Optionally describe what should be treated as voicemail. Leave as null to use
+                 * the default definition.
+                 */
+                detection_prompt?: string | null;
+            }
+            namespace VoicemailOption {
+                interface VoicemailActionPrompt {
+                    /**
+                     * The prompt used to generate the text to be spoken when the call is detected to
+                     * be in voicemail.
+                     */
+                    text: string;
+                    type: 'prompt';
+                }
+                interface VoicemailActionStaticText {
+                    /**
+                     * The text to be spoken when the call is detected to be in voicemail.
+                     */
+                    text: string;
+                    type: 'static_text';
+                }
+                interface VoicemailActionHangup {
+                    type: 'hangup';
+                }
+                interface VoicemailActionBridgeTransfer {
+                    type: 'bridge_transfer';
+                }
+            }
         }
         /**
-         * Filter by whether the call is in voicemail.
+         * Override conversation flow configuration settings. Only applicable when using
+         * conversation flow as the response engine. Supported attributes - model_choice,
+         * model_temperature, tool_call_strict_mode, knowledge_base_ids, kb_config,
+         * start_speaker, begin_after_user_silence_ms.
          */
-        interface InVoicemail {
-            op: 'eq';
-            type: 'boolean';
-            value: boolean;
-        }
-        interface StringFilter {
-            /**
-             * eq: equal, ne: not equal, sw: starts with, ew: ends with, co: contains
-             */
-            op: 'eq' | 'ne' | 'sw' | 'ew' | 'co';
-            type: 'string';
-            value: string;
+        interface ConversationFlow {
             /**
-             * The field name to filter on.
+             * If set, the AI will begin the conversation after waiting for the user for the
+             * duration (in milliseconds) specified by this attribute. This only applies if the
+             * agent is configured to wait for the user to speak first. If not set, the agent
+             * will wait indefinitely for the user to speak.
              */
-            key?: string;
-        }
-        interface NumberFilter {
+            begin_after_user_silence_ms?: number | null;
             /**
-             * eq: equal, ne: not equal, gt: greater than, ge: greater than or equal, lt: less
-             * than, le: less than or equal
+             * Knowledge base configuration for RAG retrieval.
              */
-            op: 'eq' | 'ne' | 'gt' | 'ge' | 'lt' | 'le';
-            type: 'number';
-            value: number;
+            kb_config?: ConversationFlow.KBConfig;
             /**
-             * The field name to filter on.
+             * Knowledge base IDs for RAG (Retrieval-Augmented Generation).
              */
-            key?: string;
-        }
-        interface BooleanFilter {
-            op: 'eq';
-            type: 'boolean';
-            value: boolean;
+            knowledge_base_ids?: Array<string> | null;
             /**
-             * The field name to filter on.
+             * The model choice for the conversation flow.
              */
-            key?: string;
-        }
-        interface RangeFilter {
+            model_choice?: ConversationFlow.ModelChoice;
             /**
-             * bt: between
+             * Controls the randomness of the model's responses. Lower values make responses
+             * more deterministic.
              */
-            op: 'bt';
-            type: 'range';
+            model_temperature?: number | null;
             /**
-             * [lower_bound, upper_bound]
+             * Who starts the conversation - user or agent.
              */
-            value: Array<number>;
+            start_speaker?: 'user' | 'agent';
             /**
-             * The field name to filter on.
+             * Whether to use strict mode for tool calls. Only applicable when using certain
+             * supported models.
              */
-            key?: string;
+            tool_call_strict_mode?: boolean | null;
         }
-        interface EnumFilter {
+        namespace ConversationFlow {
             /**
-             * in: value is one of the listed values
+             * Knowledge base configuration for RAG retrieval.
              */
-            op: 'in';
-            type: 'enum';
-            value: Array<string>;
+            interface KBConfig {
+                /**
+                 * Similarity threshold for filtering search results
+                 */
+                filter_score?: number;
+                /**
+                 * Max number of knowledge base chunks to retrieve
+                 */
+                top_k?: number;
+            }
             /**
-             * The field name to filter on.
+             * The model choice for the conversation flow.
              */
-            key?: string;
+            interface ModelChoice {
+                /**
+                 * The LLM model to use
+                 */
+                model: 'gpt-4.1' | 'gpt-4.1-mini' | 'gpt-4.1-nano' | 'gpt-5' | 'gpt-5-mini' | 'gpt-5-nano' | 'gpt-5.1' | 'gpt-5.2' | 'gpt-5.4' | 'gpt-5.4-mini' | 'gpt-5.4-nano' | 'gpt-5.5' | 'gpt-5.6-terra' | 'gpt-5.6-luna' | 'claude-4.5-sonnet' | 'claude-4.6-sonnet' | 'claude-5-sonnet' | 'claude-4.5-haiku' | 'gemini-3.0-flash' | 'gemini-3.1-flash-lite' | 'gemini-3.5-flash';
+                /**
+                 * Type of model choice
+                 */
+                type: 'cascading';
+                /**
+                 * Whether to use high priority pool with more dedicated resource, default false
+                 */
+                high_priority?: boolean;
+            }
         }
-        interface PresentFilter {
+        /**
+         * 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,
+         * knowledge_base_ids, kb_config, start_speaker, begin_after_user_silence_ms,
+         * begin_message.
+         */
+        interface RetellLlm {
             /**
-             * pr: present (has value), np: not present
+             * If set, the AI will begin the conversation after waiting for the user for the
+             * duration (in milliseconds) specified by this attribute. This only applies if the
+             * agent is configured to wait for the user to speak first. If not set, the agent
+             * will wait indefinitely for the user to speak.
              */
-            op: 'pr' | 'np';
-            type: 'present';
+            begin_after_user_silence_ms?: number | null;
             /**
-             * The field name to filter on.
+             * First utterance said by the agent in the call. If not set, LLM will dynamically
+             * generate a message. If set to "", agent will wait for user to speak first.
              */
-            key?: string;
-        }
-        interface NumberFilter {
+            begin_message?: string | null;
             /**
-             * eq: equal, ne: not equal, gt: greater than, ge: greater than or equal, lt: less
-             * than, le: less than or equal
+             * Knowledge base configuration for RAG retrieval.
              */
-            op: 'eq' | 'ne' | 'gt' | 'ge' | 'lt' | 'le';
-            type: 'number';
-            value: number;
-        }
-        interface RangeFilter {
+            kb_config?: RetellLlm.KBConfig | null;
             /**
-             * bt: between
+             * A list of knowledge base ids to use for this resource.
              */
-            op: 'bt';
-            type: 'range';
+            knowledge_base_ids?: Array<string> | null;
             /**
-             * [lower_bound, upper_bound]
+             * Select the underlying text LLM. If not set, would default to gpt-4.1.
              */
-            value: Array<number>;
-        }
-        /**
-         * Filter by to number.
-         */
-        interface ToNumber {
+            model?: 'gpt-4.1' | 'gpt-4.1-mini' | 'gpt-4.1-nano' | 'gpt-5' | 'gpt-5-mini' | 'gpt-5-nano' | 'gpt-5.1' | 'gpt-5.2' | 'gpt-5.4' | 'gpt-5.4-mini' | 'gpt-5.4-nano' | 'gpt-5.5' | 'gpt-5.6-terra' | 'gpt-5.6-luna' | 'claude-4.5-sonnet' | 'claude-4.6-sonnet' | 'claude-5-sonnet' | 'claude-4.5-haiku' | 'gemini-3.0-flash' | 'gemini-3.1-flash-lite' | 'gemini-3.5-flash' | null;
             /**
-             * eq: equal, ne: not equal, sw: starts with, ew: ends with, co: contains
+             * If set to true, will use high priority pool with more dedicated resource to
+             * ensure lower and more consistent latency, default to false. This feature usually
+             * comes with a higher cost.
              */
-            op: 'eq' | 'ne' | 'sw' | 'ew' | 'co';
-            type: 'string';
-            value: string;
-        }
-        interface ToolCall {
+            model_high_priority?: boolean | null;
             /**
-             * Filter by tool call latency in milliseconds.
+             * If set, will control the randomness of the response. Value ranging from [0,1].
+             * Lower value means more deterministic, while higher value means more random. If
+             * unset, default value 0 will apply. Note that for tool calling, a lower value is
+             * recommended.
              */
-            latency_ms?: ToolCall.NumberFilter | ToolCall.RangeFilter;
+            model_temperature?: number;
             /**
-             * The tool call name to filter on.
+             * Select the underlying speech to speech model. Can only set this or model, not
+             * both.
              */
-            name?: string;
+            s2s_model?: 'gpt-realtime-2.1' | 'gpt-realtime-2.1-mini' | 'gpt-realtime-2' | 'gpt-realtime-1.5' | 'gpt-realtime' | 'gpt-realtime-mini' | null;
             /**
-             * Filter by tool call success status.
+             * The speaker who starts the conversation. Required. Must be either 'user' or
+             * 'agent'.
              */
-            success?: ToolCall.Success;
+            start_speaker?: 'user' | 'agent';
             /**
-             * The tool call type to filter on.
+             * Whether to use strict mode for tool calls. Only applicable when using certain
+             * supported models.
              */
-            type?: string;
+            tool_call_strict_mode?: boolean | null;
         }
-        namespace ToolCall {
-            interface NumberFilter {
-                /**
-                 * eq: equal, ne: not equal, gt: greater than, ge: greater than or equal, lt: less
-                 * than, le: less than or equal
-                 */
-                op: 'eq' | 'ne' | 'gt' | 'ge' | 'lt' | 'le';
-                type: 'number';
-                value: number;
-            }
-            interface RangeFilter {
+        namespace RetellLlm {
+            /**
+             * Knowledge base configuration for RAG retrieval.
+             */
+            interface KBConfig {
                 /**
-                 * bt: between
+                 * Similarity threshold for filtering search results
                  */
-                op: 'bt';
-                type: 'range';
+                filter_score?: number;
                 /**
-                 * [lower_bound, upper_bound]
+                 * Max number of knowledge base chunks to retrieve
                  */
-                value: Array<number>;
-            }
-            /**
-             * Filter by tool call success status.
-             */
-            interface Success {
-                op: 'eq';
-                type: 'boolean';
-                value: boolean;
+                top_k?: number;
             }
         }
-        interface UserSentiment {
-            /**
-             * in: value is one of the listed values
-             */
-            op: 'in';
-            type: 'enum';
-            value: Array<'Negative' | 'Positive' | 'Neutral' | 'Unknown'>;
-        }
     }
 }
-export interface CallUpdateParams {
-    /**
-     * Custom attributes for the call, as key-value pairs. Each attribute must first be
-     * defined for your organization in the Retell dashboard (Call History → Actions →
-     * Custom attributes) before it can be set here. The object key must match the id
-     * of an existing organization-level custom attribute; keys that do not match a
-     * defined attribute are ignored and will not be saved. Values must be a string,
-     * number, or boolean.
-     */
-    custom_attributes?: {
-        [key: string]: string | number | boolean;
-    };
-    /**
-     * Data storage setting for this call. Overrides the agent's default setting.
-     * "everything" stores all data, "everything_except_pii" excludes PII when
-     * possible, "basic_attributes_only" stores only metadata. Cannot be downgraded
-     * from more restrictive to less restrictive settings.
-     */
-    data_storage_setting?: 'everything' | 'everything_except_pii' | 'basic_attributes_only';
-    /**
-     * An arbitrary object for storage purpose only. You can put anything here like
-     * your internal customer id associated with the call. Not used for processing. You
-     * can later get this field from the call object. Size limited to 50kB max.
-     */
-    metadata?: unknown;
-}
 export declare namespace Call {
-    export { type CallResponse as CallResponse, type PhoneCallResponse as PhoneCallResponse, type WebCallResponse as WebCallResponse, type CallListResponse as CallListResponse, type CallCreatePhoneCallParams as CallCreatePhoneCallParams, type CallRegisterPhoneCallParams as CallRegisterPhoneCallParams, type CallCreateWebCallParams as CallCreateWebCallParams, type CallListParams as CallListParams, type CallUpdateParams as CallUpdateParams, };
+    export { type CallResponse as CallResponse, type PhoneCallResponse as PhoneCallResponse, type WebCallResponse as WebCallResponse, type CallListResponse as CallListResponse, type CallUpdateParams as CallUpdateParams, type CallListParams as CallListParams, type CallCreatePhoneCallParams as CallCreatePhoneCallParams, type CallCreateWebCallParams as CallCreateWebCallParams, type CallRegisterPhoneCallParams as CallRegisterPhoneCallParams, };
 }
 //# sourceMappingURL=call.d.mts.map