retell-sdk 5.31.1 → 5.32.0

package/resources/call.d.ts

@@ -3,100 +3,100 @@ import { APIPromise } from "../core/api-promise.js";
 import { RequestOptions } from "../internal/request-options.js";
 export declare class Call extends APIResource {
     /**
-     * Retrieve details of a specific call
+     * Create a new outbound phone call
      *
      * @example
      * ```ts
-     * const callResponse = await client.call.retrieve(
-     *   '119c3f8e47135a29e65947eeb34cf12d',
+     * const phoneCallResponse = await client.call.createPhoneCall(
+     *   {
+     *     from_number: '+14157774444',
+     *     to_number: '+12137774445',
+     *   },
      * );
      * ```
      */
-    retrieve(callID: string, options?: RequestOptions): APIPromise<CallResponse>;
+    createPhoneCall(body: CallCreatePhoneCallParams, options?: RequestOptions): APIPromise<PhoneCallResponse>;
     /**
-     * Update metadata and sensitive data storage settings for an existing call.
+     * Register a new phone call for custom telephony
      *
      * @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 phoneCallResponse =
+     *   await client.call.registerPhoneCall({
+     *     agent_id: 'oBeDLoLOeuAbiuaMFXRtDOLriTJ5tSxD',
+     *   });
      * ```
      */
-    update(callID: string, body: CallUpdateParams, options?: RequestOptions): APIPromise<CallResponse>;
+    registerPhoneCall(body: CallRegisterPhoneCallParams, options?: RequestOptions): APIPromise<PhoneCallResponse>;
     /**
-     * List calls with unified cursor pagination response.
+     * Create a new web call
      *
      * @example
      * ```ts
-     * const calls = await client.call.list();
+     * const webCallResponse = await client.call.createWebCall({
+     *   agent_id: 'oBeDLoLOeuAbiuaMFXRtDOLriTJ5tSxD',
+     * });
      * ```
      */
-    list(body?: CallListParams | null | undefined, options?: RequestOptions): APIPromise<CallListResponse>;
+    createWebCall(body: CallCreateWebCallParams, options?: RequestOptions): APIPromise<WebCallResponse>;
     /**
-     * Delete a specific call and its associated data
+     * Retrieve details of a specific call
      *
      * @example
      * ```ts
-     * await client.call.delete(
+     * const callResponse = await client.call.retrieve(
      *   '119c3f8e47135a29e65947eeb34cf12d',
      * );
      * ```
      */
-    delete(callID: string, options?: RequestOptions): APIPromise<void>;
+    retrieve(callID: string, options?: RequestOptions): APIPromise<CallResponse>;
     /**
-     * Create a new outbound phone call
+     * List calls with unified cursor pagination response.
      *
      * @example
      * ```ts
-     * const phoneCallResponse = await client.call.createPhoneCall(
-     *   {
-     *     from_number: '+14157774444',
-     *     to_number: '+12137774445',
-     *   },
-     * );
+     * const calls = await client.call.list();
      * ```
      */
-    createPhoneCall(body: CallCreatePhoneCallParams, options?: RequestOptions): APIPromise<PhoneCallResponse>;
+    list(body?: CallListParams | null | undefined, options?: RequestOptions): APIPromise<CallListResponse>;
     /**
-     * Create a new web call
+     * Update metadata and sensitive data storage settings for an existing call.
      *
      * @example
      * ```ts
-     * const webCallResponse = await client.call.createWebCall({
-     *   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',
+     *     },
+     *   },
+     * );
      * ```
      */
-    createWebCall(body: CallCreateWebCallParams, options?: RequestOptions): APIPromise<WebCallResponse>;
+    update(callID: string, body: CallUpdateParams, options?: RequestOptions): APIPromise<CallResponse>;
     /**
-     * Register a new phone call for custom telephony
+     * Stop an ongoing call.
      *
      * @example
      * ```ts
-     * const phoneCallResponse =
-     *   await client.call.registerPhoneCall({
-     *     agent_id: 'oBeDLoLOeuAbiuaMFXRtDOLriTJ5tSxD',
-     *   });
+     * await client.call.stop('call_a4441234567890777c4a4a123e6');
      * ```
      */
-    registerPhoneCall(body: CallRegisterPhoneCallParams, options?: RequestOptions): APIPromise<PhoneCallResponse>;
+    stop(callID: string, options?: RequestOptions): APIPromise<void>;
     /**
-     * Stop an ongoing call.
+     * Delete a specific call and its associated data
      *
      * @example
      * ```ts
-     * await client.call.stop('call_a4441234567890777c4a4a123e6');
+     * await client.call.delete(
+     *   '119c3f8e47135a29e65947eeb34cf12d',
+     * );
      * ```
      */
-    stop(callID: string, options?: RequestOptions): APIPromise<void>;
+    delete(callID: string, options?: RequestOptions): APIPromise<void>;
 }
 export type CallResponse = WebCallResponse | PhoneCallResponse;
 export interface PhoneCallResponse {
@@ -3195,722 +3195,1034 @@ export declare namespace CallListResponse {
         }
     }
 }
-export interface CallUpdateParams {
+export interface CallCreatePhoneCallParams {
     /**
-     * Custom attributes for the call
+     * The number you own in E.164 format. Must be a number purchased from Retell or
+     * imported to Retell.
      */
-    custom_attributes?: {
-        [key: string]: string | number | boolean;
-    };
+    from_number: string;
     /**
-     * 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.
+     * 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?: 'everything' | 'everything_except_pii' | 'basic_attributes_only';
+    to_number: string;
     /**
-     * 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.
+     * 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.
      */
-    metadata?: unknown;
+    agent_override?: CallCreatePhoneCallParams.AgentOverride;
     /**
-     * Override dynamic variables represented as key-value pairs of strings. Setting
-     * this will override or add the dynamic variables set in the agent during the
-     * call. Only need to set the delta where you want to override, no need to set the
-     * entire dynamic variables object. Setting this to null will remove any existing
-     * override.
+     * Add optional custom SIP headers to the call.
      */
-    override_dynamic_variables?: {
+    custom_sip_headers?: {
         [key: string]: string;
-    } | null;
-}
-export interface CallListParams {
-    /**
-     * Filter criteria for calls. All conditions are implicitly connected with AND.
-     */
-    filter_criteria?: CallListParams.FilterCriteria;
+    };
     /**
-     * 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.
+     * 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.
      */
-    include_total?: boolean;
+    ignore_e164_validation?: boolean;
     /**
-     * Maximum number of calls to return.
+     * 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.
      */
-    limit?: number;
+    metadata?: unknown;
     /**
-     * Opaque pagination cursor from a previous response.
+     * 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.
      */
-    pagination_key?: string;
+    override_agent_id?: string;
     /**
-     * Number of records to skip for pagination.
+     * 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.
      */
-    skip?: number;
+    override_agent_version?: number | string;
     /**
-     * Sort calls by `start_timestamp` in ascending or descending order.
+     * 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_order?: 'ascending' | 'descending';
+    retell_llm_dynamic_variables?: {
+        [key: string]: string;
+    };
 }
-export declare namespace CallListParams {
+export declare namespace CallCreatePhoneCallParams {
     /**
-     * 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 batch call ID.
-         */
-        batch_call_id?: FilterCriteria.BatchCallID;
-        /**
-         * Filter by call ID.
-         */
-        call_id?: FilterCriteria.CallID;
-        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_id: string;
+            agent_name?: string | null;
             /**
-             * Specific versions to filter on. If not provided, all versions are included.
+             * 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.
              */
-            version?: Array<number>;
-        }
-        /**
-         * Filter by batch call ID.
-         */
-        interface BatchCallID {
+            allow_dtmf_interruption?: boolean;
             /**
-             * eq: equal, ne: not equal, sw: starts with, ew: ends with, co: contains
+             * If set to true, DTMF input will be accepted and processed. If false, any DTMF
+             * input will be ignored. Default to true.
              */
-            op: 'eq' | 'ne' | 'sw' | 'ew' | 'co';
-            type: 'string';
-            value: string;
-        }
-        /**
-         * Filter by call ID.
-         */
-        interface CallID {
+            allow_user_dtmf?: boolean;
             /**
-             * eq: equal, ne: not equal, sw: starts with, ew: ends with, co: contains
+             * 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.
              */
-            op: 'eq' | 'ne' | 'sw' | 'ew' | 'co';
-            type: 'string';
-            value: string;
-        }
-        interface CallStatus {
+            ambient_sound?: 'coffee-shop' | 'convention-hall' | 'summer-outdoor' | 'mountain-outdoor' | 'static-noise' | 'call-center' | null;
             /**
-             * in: value is one of the listed values
+             * 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.
              */
-            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 {
+            ambient_sound_volume?: number;
             /**
-             * in: value is one of the listed values
+             * Prompt to determine whether the post call or chat analysis should mark the
+             * interaction as successful. Set to null to use the default prompt.
              */
-            op: 'in';
-            type: 'enum';
-            value: Array<'web_call' | 'phone_call'>;
-        }
-        interface NumberFilter {
+            analysis_successful_prompt?: string | null;
             /**
-             * eq: equal, ne: not equal, gt: greater than, ge: greater than or equal, lt: less
-             * than, le: less than or equal
+             * Prompt to guide how the post call or chat analysis summary should be generated.
+             * When unset, the default system prompt is used. Set to null to use the default
+             * prompt.
              */
-            op: 'eq' | 'ne' | 'gt' | 'ge' | 'lt' | 'le';
-            type: 'number';
-            value: number;
-        }
-        interface RangeFilter {
+            analysis_summary_prompt?: string | null;
             /**
-             * bt: between
+             * Prompt to guide how the post call or chat analysis should evaluate user
+             * sentiment. When unset, the default system prompt is used. Set to null to use the
+             * default prompt.
              */
-            op: 'bt';
-            type: 'range';
+            analysis_user_sentiment_prompt?: string | null;
             /**
-             * [lower_bound, upper_bound]
+             * 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.
              */
-            value: Array<number>;
-        }
-        interface StringFilter {
+            backchannel_frequency?: number;
             /**
-             * eq: equal, ne: not equal, sw: starts with, ew: ends with, co: contains
+             * 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.
              */
-            op: 'eq' | 'ne' | 'sw' | 'ew' | 'co';
-            type: 'string';
-            value: string;
+            backchannel_words?: Array<string> | null;
             /**
-             * The field name to filter on.
+             * 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.
              */
-            key?: string;
-        }
-        interface NumberFilter {
+            begin_message_delay_ms?: number;
             /**
-             * eq: equal, ne: not equal, gt: greater than, ge: greater than or equal, lt: less
-             * than, le: less than or equal
+             * 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.
              */
-            op: 'eq' | 'ne' | 'gt' | 'ge' | 'lt' | 'le';
-            type: 'number';
-            value: number;
+            boosted_keywords?: Array<string> | null;
             /**
-             * The field name to filter on.
+             * 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.
              */
-            key?: string;
-        }
-        interface BooleanFilter {
-            op: 'eq';
-            type: 'boolean';
-            value: boolean;
+            call_screening_option?: Agent.CallScreeningOption | null;
             /**
-             * The field name to filter on.
+             * Custom STT configuration. Only used when stt_mode is set to custom.
              */
-            key?: string;
-        }
-        interface RangeFilter {
+            custom_stt_config?: Agent.CustomSttConfig | null;
             /**
-             * bt: between
+             * 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).
              */
-            op: 'bt';
-            type: 'range';
+            data_storage_retention_days?: number | null;
             /**
-             * [lower_bound, upper_bound]
+             * 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.
              */
-            value: Array<number>;
+            data_storage_setting?: 'everything' | 'everything_except_pii' | 'basic_attributes_only';
             /**
-             * The field name to filter on.
+             * If set, determines what denoising mode to use. Use "no-denoise" to bypass all
+             * audio denoising. Default to noise-cancellation.
              */
-            key?: string;
-        }
-        interface EnumFilter {
+            denoising_mode?: 'no-denoise' | 'noise-cancellation' | 'noise-and-background-speech-cancellation';
             /**
-             * in: value is one of the listed values
+             * 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: 'in';
-            type: 'enum';
-            value: Array<string>;
+            enable_backchannel?: boolean;
             /**
-             * The field name to filter on.
+             * 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.
              */
-            key?: string;
-        }
-        interface PresentFilter {
+            enable_dynamic_responsiveness?: boolean;
             /**
-             * pr: present (has value), np: not present
+             * 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: 'pr' | 'np';
-            type: 'present';
+            enable_dynamic_voice_speed?: boolean;
             /**
-             * The field name to filter on.
+             * 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).
              */
-            key?: string;
-        }
-        interface StringFilter {
+            end_call_after_silence_ms?: number;
             /**
-             * 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
-             */
-            op: 'bt';
-            type: 'range';
-            /**
-             * [lower_bound, upper_bound]
+             * 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`.
              */
-            value: Array<number>;
+            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'>;
             /**
-             * The field name to filter on.
+             * 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).
              */
-            key?: string;
-        }
-        interface EnumFilter {
+            max_call_duration_ms?: number;
             /**
-             * in: value is one of the listed values
+             * 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.
              */
-            op: 'in';
-            type: 'enum';
-            value: Array<string>;
+            opt_in_signed_url?: boolean;
             /**
-             * The field name to filter on.
+             * Configuration for PII scrubbing from transcripts and recordings.
              */
-            key?: string;
-        }
-        interface PresentFilter {
+            pii_config?: Agent.PiiConfig;
             /**
-             * pr: present (has value), np: not 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.
              */
-            op: 'pr' | 'np';
-            type: 'present';
+            post_call_analysis_data?: Array<Agent.StringAnalysisData | Agent.EnumAnalysisData | Agent.BooleanAnalysisData | Agent.NumberAnalysisData | Agent.CallPresetAnalysisData> | null;
             /**
-             * The field name to filter on.
+             * The model to use for post call analysis. Default to gpt-4.1.
              */
-            key?: string;
-        }
-        interface DataStorageSetting {
+            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' | 'claude-4.5-sonnet' | 'claude-4.6-sonnet' | 'claude-4.5-haiku' | 'gemini-2.5-flash-lite' | 'gemini-3.0-flash' | 'gemini-3.1-flash-lite' | null;
             /**
-             * in: value is one of the listed values
+             * 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.
              */
-            op: 'in';
-            type: 'enum';
-            value: Array<'everything' | 'everything_except_pii' | 'basic_attributes_only'>;
-        }
-        interface Direction {
+            pronunciation_dictionary?: Array<Agent.PronunciationDictionary> | null;
             /**
-             * in: value is one of the listed values
+             * 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: 'in';
-            type: 'enum';
-            value: Array<'inbound' | 'outbound'>;
-        }
-        interface DisconnectionReason {
+            reminder_max_count?: number;
             /**
-             * in: value is one of the listed values
+             * 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.
              */
-            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'>;
-        }
-        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;
-        }
-        interface RangeFilter {
+            response_engine?: Agent.ResponseEngineRetellLm | Agent.ResponseEngineCustomLm | Agent.ResponseEngineConversationFlow;
             /**
-             * bt: between
+             * 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.
              */
-            op: 'bt';
-            type: 'range';
+            responsiveness?: number;
             /**
-             * [lower_bound, upper_bound]
+             * 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].
              */
-            value: Array<number>;
-        }
-        interface DynamicVariable {
+            ring_duration_ms?: number;
             /**
-             * The dynamic variable 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;
+            signed_url_expiration_ms?: number | null;
             /**
-             * eq: equal, ne: not equal, sw: starts with, ew: ends with, co: contains
+             * 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: 'eq' | 'ne' | 'sw' | 'ew' | 'co';
-            type: 'string';
-            value: string;
-        }
-        interface NumberFilter {
+            stt_mode?: 'fast' | 'accurate' | 'custom';
             /**
-             * eq: equal, ne: not equal, gt: greater than, ge: greater than or equal, lt: less
-             * than, le: less than or equal
+             * IANA timezone for the agent (e.g. America/New_York). Defaults to
+             * America/Los_Angeles if not set.
              */
-            op: 'eq' | 'ne' | 'gt' | 'ge' | 'lt' | 'le';
-            type: 'number';
-            value: number;
-        }
-        interface RangeFilter {
+            timezone?: string | null;
+            user_dtmf_options?: Agent.UserDtmfOptions | null;
             /**
-             * bt: between
+             * Optional description of the agent version. Used for your own reference and
+             * documentation.
              */
-            op: 'bt';
-            type: 'range';
+            version_description?: string | null;
             /**
-             * [lower_bound, upper_bound]
+             * 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.
              */
-            value: Array<number>;
-        }
-        interface NumberFilter {
+            vocab_specialization?: 'general' | 'medical';
             /**
-             * eq: equal, ne: not equal, gt: greater than, ge: greater than or equal, lt: less
-             * than, le: less than or equal
+             * 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: 'eq' | 'ne' | 'gt' | 'ge' | 'lt' | 'le';
-            type: 'number';
-            value: number;
-        }
-        interface RangeFilter {
+            voice_emotion?: 'calm' | 'sympathetic' | 'happy' | 'sad' | 'angry' | 'fearful' | 'surprised' | null;
             /**
-             * bt: between
+             * Unique voice id used for the agent. Find list of available voices and their
+             * preview in Dashboard.
              */
-            op: 'bt';
-            type: 'range';
+            voice_id?: string;
             /**
-             * [lower_bound, upper_bound]
+             * 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.
              */
-            value: Array<number>;
-        }
-        /**
-         * Filter by from number.
-         */
-        interface FromNumber {
+            voice_model?: 'eleven_turbo_v2' | 'eleven_flash_v2' | 'eleven_turbo_v2_5' | '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;
             /**
-             * eq: equal, ne: not equal, sw: starts with, ew: ends with, co: contains
+             * 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: '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 {
+            voice_speed?: number;
             /**
-             * eq: equal, ne: not equal, sw: starts with, ew: ends with, co: contains
+             * 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: 'eq' | 'ne' | 'sw' | 'ew' | 'co';
-            type: 'string';
-            value: string;
+            voice_temperature?: number;
             /**
-             * The field name to filter on.
+             * Configures when to stop running voicemail detection, as it becomes unlikely to
+             * hit voicemail after a couple minutes, and keep running it will only have
+             * negative impact. The minimum value allowed is 5,000 ms (5 s), and maximum value
+             * allowed is 180,000 (3 minutes). By default, this is set to 30,000 (30 s).
              */
-            key?: string;
-        }
-        interface NumberFilter {
+            voicemail_detection_timeout_ms?: number;
             /**
-             * eq: equal, ne: not equal, gt: greater than, ge: greater than or equal, lt: less
-             * than, le: less than or equal
+             * The message to be played when the call enters a voicemail. Note that this
+             * feature is only available for phone calls. If you want to hangup after hitting
+             * voicemail, set this to empty string.
              */
-            op: 'eq' | 'ne' | 'gt' | 'ge' | 'lt' | 'le';
-            type: 'number';
-            value: number;
+            voicemail_message?: string;
             /**
-             * The field name to filter on.
+             * 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.
              */
-            key?: string;
-        }
-        interface BooleanFilter {
-            op: 'eq';
-            type: 'boolean';
-            value: boolean;
+            voicemail_option?: Agent.VoicemailOption | null;
             /**
-             * The field name to filter on.
+             * 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.
              */
-            key?: string;
-        }
-        interface RangeFilter {
+            volume?: number;
             /**
-             * bt: between
+             * Which webhook events this agent should receive. If not set, defaults to
+             * call_started, call_ended, call_analyzed.
              */
-            op: 'bt';
-            type: 'range';
+            webhook_events?: Array<'call_started' | 'call_ended' | 'call_analyzed' | 'transcript_updated' | 'transfer_started' | 'transfer_bridged' | 'transfer_cancelled' | 'transfer_ended'> | null;
             /**
-             * [lower_bound, upper_bound]
+             * The timeout for the webhook in milliseconds. If not set, default value of 10000
+             * will apply.
              */
-            value: Array<number>;
+            webhook_timeout_ms?: number;
             /**
-             * The field name to filter on.
+             * 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.
              */
-            key?: string;
+            webhook_url?: string | null;
         }
-        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 {
+        namespace Agent {
             /**
-             * bt: between
+             * 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: 'bt';
-            type: 'range';
+            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;
+            }
             /**
-             * [lower_bound, upper_bound]
+             * Custom STT configuration. Only used when stt_mode is set to custom.
              */
-            value: Array<number>;
-        }
-        /**
-         * Filter by to number.
-         */
-        interface ToNumber {
+            interface CustomSttConfig {
+                /**
+                 * Endpointing timeout in milliseconds. Minimum is 100 for Azure, 10 for Deepgram,
+                 * 500 for Soniox
+                 */
+                endpointing_ms: number;
+                /**
+                 * ASR provider name.
+                 */
+                provider: 'azure' | 'deepgram' | 'soniox';
+            }
             /**
-             * eq: equal, ne: not equal, sw: starts with, ew: ends with, co: contains
+             * Configuration for guardrail checks to detect and prevent prohibited topics in
+             * agent output and user input.
              */
-            op: 'eq' | 'ne' | 'sw' | 'ew' | 'co';
-            type: 'string';
-            value: string;
-        }
-        interface ToolCall {
+            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;
+            }
             /**
-             * The tool call name to filter on.
+             * Toggle behavior presets on/off to influence agent response style and behaviors.
              */
-            name: string;
+            interface HandbookConfig {
+                /**
+                 * When asked, acknowledge being a virtual assistant.
+                 */
+                ai_disclosure?: 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;
+            }
             /**
-             * Filter by tool call latency in milliseconds.
+             * 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.
              */
-            latency_ms?: ToolCall.NumberFilter | ToolCall.RangeFilter;
+            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';
+                }
+            }
             /**
-             * Filter by tool call success status.
+             * Configuration for PII scrubbing from transcripts and recordings.
              */
-            success?: ToolCall.Success;
-        }
-        namespace ToolCall {
-            interface NumberFilter {
+            interface PiiConfig {
                 /**
-                 * eq: equal, ne: not equal, gt: greater than, ge: greater than or equal, lt: less
-                 * than, le: less than or equal
+                 * 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.
                  */
-                op: 'eq' | 'ne' | 'gt' | 'ge' | 'lt' | 'le';
-                type: 'number';
-                value: number;
+                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 RangeFilter {
+            interface StringAnalysisData {
                 /**
-                 * bt: between
+                 * Description of the variable.
                  */
-                op: 'bt';
-                type: 'range';
+                description: string;
                 /**
-                 * [lower_bound, upper_bound]
+                 * Name of the variable.
                  */
-                value: Array<number>;
+                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;
             }
-            /**
-             * Filter by tool call success status.
-             */
-            interface Success {
-                op: 'eq';
-                type: 'boolean';
-                value: 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 UserSentiment {
-            /**
-             * in: value is one of the listed values
-             */
-            op: 'in';
-            type: 'enum';
-            value: Array<'Negative' | 'Positive' | 'Neutral' | 'Unknown'>;
-        }
-    }
-}
-export interface CallCreatePhoneCallParams {
-    /**
-     * 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.
-     */
-    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?: CallCreatePhoneCallParams.AgentOverride;
-    /**
-     * Add optional custom SIP headers to the call.
-     */
-    custom_sip_headers?: {
-        [key: string]: string;
-    };
-    /**
-     * 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.
-     */
-    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?: number | string;
-    /**
-     * 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;
-    };
-}
-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
-     * the base agent.
-     */
-    interface AgentOverride {
-        /**
-         * Override agent configuration settings. Any properties specified here will
-         * override the base agent configuration for this call.
-         */
-        agent?: AgentOverride.Agent;
+            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.
          */
-        conversation_flow?: AgentOverride.ConversationFlow;
-        /**
-         * 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.
-         */
-        retell_llm?: AgentOverride.RetellLlm;
+        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' | 'claude-4.5-sonnet' | 'claude-4.6-sonnet' | 'claude-4.5-haiku' | 'gemini-2.5-flash-lite' | 'gemini-3.0-flash' | 'gemini-3.1-flash-lite';
+                /**
+                 * 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' | 'claude-4.5-sonnet' | 'claude-4.6-sonnet' | 'claude-4.5-haiku' | 'gemini-2.5-flash-lite' | 'gemini-3.0-flash' | 'gemini-3.1-flash-lite' | 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' | '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;
+            }
+        }
+    }
+}
+export interface CallRegisterPhoneCallParams {
+    /**
+     * The agent to use for the call.
+     */
+    agent_id: 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?: number | string;
+    /**
+     * Direction of the phone call. Stored for tracking purpose.
+     */
+    direction?: 'inbound' | 'outbound';
+    /**
+     * The number you own in E.164 format. Stored for tracking purpose.
+     */
+    from_number?: string;
+    /**
+     * 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;
+    /**
+     * 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 CallRegisterPhoneCallParams {
+    /**
+     * 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 AgentOverride {
+        /**
+         * Override agent configuration settings. Any properties specified here will
+         * override the base agent configuration for this call.
+         */
+        agent?: AgentOverride.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.
+         */
+        conversation_flow?: AgentOverride.ConversationFlow;
+        /**
+         * 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.
+         */
+        retell_llm?: AgentOverride.RetellLlm;
     }
     namespace AgentOverride {
         /**
@@ -5733,952 +6045,640 @@ export declare namespace CallCreateWebCallParams {
         }
     }
 }
-export interface CallRegisterPhoneCallParams {
+export interface CallListParams {
     /**
-     * The agent to use for the call.
+     * Filter criteria for calls. All conditions are implicitly connected with AND.
      */
-    agent_id: string;
+    filter_criteria?: CallListParams.FilterCriteria;
     /**
-     * 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.
+     * 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.
      */
-    agent_override?: CallRegisterPhoneCallParams.AgentOverride;
+    include_total?: boolean;
     /**
-     * The version of the agent to use for the call.
+     * Maximum number of calls to return.
      */
-    agent_version?: number | string;
+    limit?: number;
     /**
-     * Direction of the phone call. Stored for tracking purpose.
+     * Opaque pagination cursor from a previous response.
      */
-    direction?: 'inbound' | 'outbound';
+    pagination_key?: string;
     /**
-     * The number you own in E.164 format. Stored for tracking purpose.
+     * Number of records to skip for pagination.
      */
-    from_number?: string;
+    skip?: number;
     /**
-     * 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 calls by `start_timestamp` in ascending or descending order.
      */
-    metadata?: unknown;
+    sort_order?: 'ascending' | 'descending';
+}
+export declare namespace CallListParams {
     /**
-     * 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.
+     * Filter criteria for calls. All conditions are implicitly connected with AND.
      */
-    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 {
-    /**
-     * 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 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 batch call ID.
          */
-        conversation_flow?: AgentOverride.ConversationFlow;
+        batch_call_id?: FilterCriteria.BatchCallID;
         /**
-         * 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 call ID.
          */
-        retell_llm?: AgentOverride.RetellLlm;
-    }
-    namespace AgentOverride {
+        call_id?: FilterCriteria.CallID;
+        call_status?: FilterCriteria.CallStatus;
         /**
-         * Override agent configuration settings. Any properties specified here will
-         * override the base agent configuration for this call.
+         * 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 {
             /**
-             * The name of the agent. Only used for your own reference.
+             * The agent ID to filter on.
              */
-            agent_name?: string | null;
+            agent_id: string;
             /**
-             * 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.
+             * Specific versions to filter on. If not provided, all versions are included.
              */
-            allow_dtmf_interruption?: boolean;
+            version?: Array<number>;
+        }
+        /**
+         * Filter by batch call ID.
+         */
+        interface BatchCallID {
             /**
-             * If set to true, DTMF input will be accepted and processed. If false, any DTMF
-             * input will be ignored. Default to true.
+             * eq: equal, ne: not equal, sw: starts with, ew: ends with, co: contains
              */
-            allow_user_dtmf?: boolean;
+            op: 'eq' | 'ne' | 'sw' | 'ew' | 'co';
+            type: 'string';
+            value: string;
+        }
+        /**
+         * Filter by call ID.
+         */
+        interface CallID {
             /**
-             * 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.
+             * eq: equal, ne: not equal, sw: starts with, ew: ends with, co: contains
              */
-            ambient_sound?: 'coffee-shop' | 'convention-hall' | 'summer-outdoor' | 'mountain-outdoor' | 'static-noise' | 'call-center' | null;
+            op: 'eq' | 'ne' | 'sw' | 'ew' | 'co';
+            type: 'string';
+            value: string;
+        }
+        interface CallStatus {
             /**
-             * 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.
+             * in: value is one of the listed values
              */
-            ambient_sound_volume?: number;
+            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 {
             /**
-             * Prompt to determine whether the post call or chat analysis should mark the
-             * interaction as successful. Set to null to use the default prompt.
+             * in: value is one of the listed values
              */
-            analysis_successful_prompt?: string | null;
+            op: 'in';
+            type: 'enum';
+            value: Array<'web_call' | 'phone_call'>;
+        }
+        interface NumberFilter {
             /**
-             * Prompt to guide how the post call or chat analysis summary should be generated.
-             * When unset, the default system prompt is used. Set to null to use the default
-             * prompt.
+             * eq: equal, ne: not equal, gt: greater than, ge: greater than or equal, lt: less
+             * than, le: less than or equal
              */
-            analysis_summary_prompt?: string | null;
+            op: 'eq' | 'ne' | 'gt' | 'ge' | 'lt' | 'le';
+            type: 'number';
+            value: number;
+        }
+        interface RangeFilter {
             /**
-             * Prompt to guide how the post call or chat analysis should evaluate user
-             * sentiment. When unset, the default system prompt is used. Set to null to use the
-             * default prompt.
+             * bt: between
              */
-            analysis_user_sentiment_prompt?: string | null;
+            op: 'bt';
+            type: 'range';
             /**
-             * 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.
+             * [lower_bound, upper_bound]
              */
-            backchannel_frequency?: number;
+            value: Array<number>;
+        }
+        interface StringFilter {
             /**
-             * 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.
+             * eq: equal, ne: not equal, sw: starts with, ew: ends with, co: contains
              */
-            backchannel_words?: Array<string> | null;
+            op: 'eq' | 'ne' | 'sw' | 'ew' | 'co';
+            type: 'string';
+            value: string;
             /**
-             * 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.
+             * The field name to filter on.
              */
-            begin_message_delay_ms?: number;
+            key?: string;
+        }
+        interface NumberFilter {
             /**
-             * 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.
+             * eq: equal, ne: not equal, gt: greater than, ge: greater than or equal, lt: less
+             * than, le: less than or equal
              */
-            boosted_keywords?: Array<string> | null;
+            op: 'eq' | 'ne' | 'gt' | 'ge' | 'lt' | 'le';
+            type: 'number';
+            value: number;
             /**
-             * 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.
+             * The field name to filter on.
              */
-            call_screening_option?: Agent.CallScreeningOption | null;
+            key?: string;
+        }
+        interface BooleanFilter {
+            op: 'eq';
+            type: 'boolean';
+            value: boolean;
             /**
-             * Custom STT configuration. Only used when stt_mode is set to custom.
+             * The field name to filter on.
              */
-            custom_stt_config?: Agent.CustomSttConfig | null;
+            key?: string;
+        }
+        interface RangeFilter {
             /**
-             * 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).
+             * bt: between
              */
-            data_storage_retention_days?: number | null;
-            /**
-             * 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.
-             */
-            data_storage_setting?: 'everything' | 'everything_except_pii' | 'basic_attributes_only';
+            op: 'bt';
+            type: 'range';
             /**
-             * If set, determines what denoising mode to use. Use "no-denoise" to bypass all
-             * audio denoising. Default to noise-cancellation.
+             * [lower_bound, upper_bound]
              */
-            denoising_mode?: 'no-denoise' | 'noise-cancellation' | 'noise-and-background-speech-cancellation';
+            value: Array<number>;
             /**
-             * 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.
+             * The field name to filter on.
              */
-            enable_backchannel?: boolean;
+            key?: string;
+        }
+        interface EnumFilter {
             /**
-             * 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<string>;
             /**
-             * 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.
+             * The field name to filter on.
              */
-            enable_dynamic_voice_speed?: boolean;
+            key?: string;
+        }
+        interface PresentFilter {
             /**
-             * 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).
+             * pr: present (has value), np: not present
              */
-            end_call_after_silence_ms?: number;
+            op: 'pr' | 'np';
+            type: 'present';
             /**
-             * 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.
+             * The field name to filter on.
              */
-            fallback_voice_ids?: Array<string> | null;
+            key?: string;
+        }
+        interface StringFilter {
             /**
-             * Configuration for guardrail checks to detect and prevent prohibited topics in
-             * agent output and user input.
+             * eq: equal, ne: not equal, sw: starts with, ew: ends with, co: contains
              */
-            guardrail_config?: Agent.GuardrailConfig;
+            op: 'eq' | 'ne' | 'sw' | 'ew' | 'co';
+            type: 'string';
+            value: string;
             /**
-             * 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 NumberFilter {
             /**
-             * 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.
+             * eq: equal, ne: not equal, gt: greater than, ge: greater than or equal, lt: less
+             * than, le: less than or equal
              */
-            interruption_sensitivity?: number;
+            op: 'eq' | 'ne' | 'gt' | 'ge' | 'lt' | 'le';
+            type: 'number';
+            value: 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.
+             * The field name to filter on.
              */
-            ivr_option?: Agent.IvrOption | null;
+            key?: string;
+        }
+        interface BooleanFilter {
+            op: 'eq';
+            type: 'boolean';
+            value: boolean;
             /**
-             * 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 RangeFilter {
             /**
-             * 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).
+             * bt: between
              */
-            max_call_duration_ms?: number;
+            op: 'bt';
+            type: 'range';
             /**
-             * 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.
+             * [lower_bound, upper_bound]
              */
-            opt_in_signed_url?: boolean;
+            value: Array<number>;
             /**
-             * Configuration for PII scrubbing from transcripts and recordings.
+             * The field name to filter on.
              */
-            pii_config?: Agent.PiiConfig;
+            key?: string;
+        }
+        interface EnumFilter {
             /**
-             * 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.
+             * in: value is one of the listed values
              */
-            post_call_analysis_data?: Array<Agent.StringAnalysisData | Agent.EnumAnalysisData | Agent.BooleanAnalysisData | Agent.NumberAnalysisData | Agent.CallPresetAnalysisData> | null;
+            op: 'in';
+            type: 'enum';
+            value: Array<string>;
             /**
-             * The model to use for post call analysis. Default to gpt-4.1.
+             * The field name to filter on.
              */
-            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' | 'claude-4.5-sonnet' | 'claude-4.6-sonnet' | 'claude-4.5-haiku' | 'gemini-2.5-flash-lite' | 'gemini-3.0-flash' | 'gemini-3.1-flash-lite' | null;
+            key?: string;
+        }
+        interface PresentFilter {
             /**
-             * 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.
+             * pr: present (has value), np: not present
              */
-            pronunciation_dictionary?: Array<Agent.PronunciationDictionary> | null;
+            op: 'pr' | 'np';
+            type: 'present';
             /**
-             * 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.
+             * The field name to filter on.
              */
-            reminder_max_count?: number;
+            key?: string;
+        }
+        interface DataStorageSetting {
             /**
-             * 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.
+             * in: value is one of the listed values
              */
-            reminder_trigger_ms?: number;
+            op: 'in';
+            type: 'enum';
+            value: Array<'everything' | 'everything_except_pii' | 'basic_attributes_only'>;
+        }
+        interface Direction {
             /**
-             * 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.
+             * in: value is one of the listed values
              */
-            response_engine?: Agent.ResponseEngineRetellLm | Agent.ResponseEngineCustomLm | Agent.ResponseEngineConversationFlow;
+            op: 'in';
+            type: 'enum';
+            value: Array<'inbound' | 'outbound'>;
+        }
+        interface DisconnectionReason {
             /**
-             * 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.
+             * in: value is one of the listed values
              */
-            responsiveness?: number;
+            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'>;
+        }
+        interface NumberFilter {
             /**
-             * 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].
+             * eq: equal, ne: not equal, gt: greater than, ge: greater than or equal, lt: less
+             * than, le: less than or equal
              */
-            ring_duration_ms?: number;
+            op: 'eq' | 'ne' | 'gt' | 'ge' | 'lt' | 'le';
+            type: 'number';
+            value: number;
+        }
+        interface RangeFilter {
             /**
-             * 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.
+             * bt: between
              */
-            signed_url_expiration_ms?: number | null;
+            op: 'bt';
+            type: 'range';
             /**
-             * 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.
+             * [lower_bound, upper_bound]
              */
-            stt_mode?: 'fast' | 'accurate' | 'custom';
+            value: Array<number>;
+        }
+        interface DynamicVariable {
             /**
-             * IANA timezone for the agent (e.g. America/New_York). Defaults to
-             * America/Los_Angeles if not set.
+             * The dynamic variable name to filter on.
              */
-            timezone?: string | null;
-            user_dtmf_options?: Agent.UserDtmfOptions | null;
+            key: string;
             /**
-             * Optional description of the agent version. Used for your own reference and
-             * documentation.
+             * eq: equal, ne: not equal, sw: starts with, ew: ends with, co: contains
              */
-            version_description?: string | null;
+            op: 'eq' | 'ne' | 'sw' | 'ew' | 'co';
+            type: 'string';
+            value: string;
+        }
+        interface NumberFilter {
             /**
-             * 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.
+             * eq: equal, ne: not equal, gt: greater than, ge: greater than or equal, lt: less
+             * than, le: less than or equal
              */
-            vocab_specialization?: 'general' | 'medical';
+            op: 'eq' | 'ne' | 'gt' | 'ge' | 'lt' | 'le';
+            type: 'number';
+            value: number;
+        }
+        interface RangeFilter {
             /**
-             * Controls the emotional tone of the agent's voice. Currently supported for
-             * Cartesia and Minimax TTS providers. If unset, no emotion will be used.
+             * bt: between
              */
-            voice_emotion?: 'calm' | 'sympathetic' | 'happy' | 'sad' | 'angry' | 'fearful' | 'surprised' | null;
+            op: 'bt';
+            type: 'range';
             /**
-             * Unique voice id used for the agent. Find list of available voices and their
-             * preview in Dashboard.
+             * [lower_bound, upper_bound]
              */
-            voice_id?: string;
+            value: Array<number>;
+        }
+        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_turbo_v2' | 'eleven_flash_v2' | 'eleven_turbo_v2_5' | '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;
-            /**
-             * 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.
-             */
-            voice_speed?: number;
-            /**
-             * 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.
-             */
-            voice_temperature?: number;
-            /**
-             * Configures when to stop running voicemail detection, as it becomes unlikely to
-             * hit voicemail after a couple minutes, and keep running it will only have
-             * negative impact. The minimum value allowed is 5,000 ms (5 s), and maximum value
-             * allowed is 180,000 (3 minutes). By default, this is set to 30,000 (30 s).
-             */
-            voicemail_detection_timeout_ms?: number;
-            /**
-             * The message to be played when the call enters a voicemail. Note that this
-             * feature is only available for phone calls. If you want to hangup after hitting
-             * voicemail, set this to empty string.
-             */
-            voicemail_message?: string;
-            /**
-             * If this option is set, the call will try to detect voicemail in the first 3
-             * minutes of the call. Actions defined (hangup, or leave a message) will be
-             * applied when the voicemail is detected. Set this to null to disable voicemail
-             * detection.
-             */
-            voicemail_option?: Agent.VoicemailOption | null;
-            /**
-             * 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.
-             */
-            volume?: number;
-            /**
-             * Which webhook events this agent should receive. If not set, defaults to
-             * call_started, call_ended, call_analyzed.
-             */
-            webhook_events?: Array<'call_started' | 'call_ended' | 'call_analyzed' | 'transcript_updated' | 'transfer_started' | 'transfer_bridged' | 'transfer_cancelled' | 'transfer_ended'> | null;
-            /**
-             * The timeout for the webhook in milliseconds. If not set, default value of 10000
-             * will apply.
-             */
-            webhook_timeout_ms?: number;
-            /**
-             * 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.
-             */
-            webhook_url?: string | null;
+            op: 'eq' | 'ne' | 'gt' | 'ge' | 'lt' | 'le';
+            type: 'number';
+            value: number;
         }
-        namespace Agent {
-            /**
-             * 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.
-             */
-            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;
-            }
-            /**
-             * Custom STT configuration. Only used when stt_mode is set to custom.
-             */
-            interface CustomSttConfig {
-                /**
-                 * Endpointing timeout in milliseconds. Minimum is 100 for Azure, 10 for Deepgram,
-                 * 500 for Soniox
-                 */
-                endpointing_ms: number;
-                /**
-                 * ASR provider name.
-                 */
-                provider: 'azure' | 'deepgram' | 'soniox';
-            }
-            /**
-             * Configuration for guardrail checks to detect and prevent prohibited topics in
-             * agent output and user input.
-             */
-            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;
-            }
-            /**
-             * Toggle behavior presets on/off to influence agent response style and behaviors.
-             */
-            interface HandbookConfig {
-                /**
-                 * When asked, acknowledge being a virtual assistant.
-                 */
-                ai_disclosure?: 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';
-                }
-            }
-            /**
-             * Configuration for PII scrubbing from transcripts and recordings.
-             */
-            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;
-            }
+        interface RangeFilter {
             /**
-             * System preset for post-call analysis (voice agents). Use in
-             * post_call_analysis_data to override prompts or mark fields optional.
+             * bt: between
              */
-            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;
-            }
+            op: 'bt';
+            type: 'range';
             /**
-             * 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.
+             * [lower_bound, upper_bound]
              */
-            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';
-                }
-            }
+            value: Array<number>;
         }
         /**
-         * 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 from number.
          */
-        interface ConversationFlow {
+        interface FromNumber {
             /**
-             * 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.
+             * eq: equal, ne: not equal, sw: starts with, ew: ends with, co: contains
              */
-            begin_after_user_silence_ms?: number | null;
+            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 {
             /**
-             * Knowledge base configuration for RAG retrieval.
+             * eq: equal, ne: not equal, sw: starts with, ew: ends with, co: contains
              */
-            kb_config?: ConversationFlow.KBConfig;
+            op: 'eq' | 'ne' | 'sw' | 'ew' | 'co';
+            type: 'string';
+            value: string;
             /**
-             * Knowledge base IDs for RAG (Retrieval-Augmented Generation).
+             * The field name to filter on.
              */
-            knowledge_base_ids?: Array<string> | null;
+            key?: string;
+        }
+        interface NumberFilter {
             /**
-             * The model choice for the conversation flow.
+             * eq: equal, ne: not equal, gt: greater than, ge: greater than or equal, lt: less
+             * than, le: less than or equal
              */
-            model_choice?: ConversationFlow.ModelChoice;
+            op: 'eq' | 'ne' | 'gt' | 'ge' | 'lt' | 'le';
+            type: 'number';
+            value: number;
             /**
-             * Controls the randomness of the model's responses. Lower values make responses
-             * more deterministic.
+             * The field name to filter on.
              */
-            model_temperature?: number | null;
+            key?: string;
+        }
+        interface BooleanFilter {
+            op: 'eq';
+            type: 'boolean';
+            value: boolean;
             /**
-             * Who starts the conversation - user or agent.
+             * The field name to filter on.
              */
-            start_speaker?: 'user' | 'agent';
+            key?: string;
+        }
+        interface RangeFilter {
             /**
-             * Whether to use strict mode for tool calls. Only applicable when using certain
-             * supported models.
+             * bt: between
              */
-            tool_call_strict_mode?: boolean | null;
-        }
-        namespace ConversationFlow {
+            op: 'bt';
+            type: 'range';
             /**
-             * Knowledge base configuration for RAG retrieval.
+             * [lower_bound, upper_bound]
              */
-            interface KBConfig {
-                /**
-                 * Similarity threshold for filtering search results
-                 */
-                filter_score?: number;
-                /**
-                 * Max number of knowledge base chunks to retrieve
-                 */
-                top_k?: number;
-            }
+            value: Array<number>;
             /**
-             * The model choice for the conversation flow.
+             * The field name to filter on.
              */
-            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' | 'claude-4.5-sonnet' | 'claude-4.6-sonnet' | 'claude-4.5-haiku' | 'gemini-2.5-flash-lite' | 'gemini-3.0-flash' | 'gemini-3.1-flash-lite';
-                /**
-                 * Type of model choice
-                 */
-                type: 'cascading';
-                /**
-                 * Whether to use high priority pool with more dedicated resource, default false
-                 */
-                high_priority?: boolean;
-            }
+            key?: string;
         }
-        /**
-         * 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 {
+        interface EnumFilter {
             /**
-             * 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.
+             * in: value is one of the listed values
              */
-            begin_after_user_silence_ms?: number | null;
+            op: 'in';
+            type: 'enum';
+            value: Array<string>;
             /**
-             * 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.
+             * The field name to filter on.
              */
-            begin_message?: string | null;
+            key?: string;
+        }
+        interface PresentFilter {
             /**
-             * Knowledge base configuration for RAG retrieval.
+             * pr: present (has value), np: not present
              */
-            kb_config?: RetellLlm.KBConfig | null;
+            op: 'pr' | 'np';
+            type: 'present';
             /**
-             * A list of knowledge base ids to use for this resource.
+             * The field name to filter on.
              */
-            knowledge_base_ids?: Array<string> | null;
+            key?: string;
+        }
+        interface NumberFilter {
             /**
-             * Select the underlying text LLM. If not set, would default to gpt-4.1.
+             * eq: equal, ne: not equal, gt: greater than, ge: greater than or equal, lt: less
+             * than, le: less than or equal
              */
-            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' | 'claude-4.5-sonnet' | 'claude-4.6-sonnet' | 'claude-4.5-haiku' | 'gemini-2.5-flash-lite' | 'gemini-3.0-flash' | 'gemini-3.1-flash-lite' | null;
+            op: 'eq' | 'ne' | 'gt' | 'ge' | 'lt' | 'le';
+            type: 'number';
+            value: number;
+        }
+        interface RangeFilter {
             /**
-             * 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.
+             * bt: between
              */
-            model_high_priority?: boolean | null;
+            op: 'bt';
+            type: 'range';
             /**
-             * 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.
+             * [lower_bound, upper_bound]
              */
-            model_temperature?: number;
+            value: Array<number>;
+        }
+        /**
+         * Filter by to number.
+         */
+        interface ToNumber {
             /**
-             * Select the underlying speech to speech model. Can only set this or model, not
-             * both.
+             * eq: equal, ne: not equal, sw: starts with, ew: ends with, co: contains
              */
-            s2s_model?: 'gpt-realtime-2' | 'gpt-realtime-1.5' | 'gpt-realtime' | 'gpt-realtime-mini' | null;
+            op: 'eq' | 'ne' | 'sw' | 'ew' | 'co';
+            type: 'string';
+            value: string;
+        }
+        interface ToolCall {
             /**
-             * The speaker who starts the conversation. Required. Must be either 'user' or
-             * 'agent'.
+             * The tool call name to filter on.
              */
-            start_speaker?: 'user' | 'agent';
+            name: string;
             /**
-             * Whether to use strict mode for tool calls. Only applicable when using certain
-             * supported models.
+             * Filter by tool call latency in milliseconds.
              */
-            tool_call_strict_mode?: boolean | null;
-        }
-        namespace RetellLlm {
+            latency_ms?: ToolCall.NumberFilter | ToolCall.RangeFilter;
             /**
-             * Knowledge base configuration for RAG retrieval.
+             * Filter by tool call success status.
              */
-            interface KBConfig {
+            success?: ToolCall.Success;
+        }
+        namespace ToolCall {
+            interface NumberFilter {
                 /**
-                 * Similarity threshold for filtering search results
+                 * eq: equal, ne: not equal, gt: greater than, ge: greater than or equal, lt: less
+                 * than, le: less than or equal
                  */
-                filter_score?: number;
+                op: 'eq' | 'ne' | 'gt' | 'ge' | 'lt' | 'le';
+                type: 'number';
+                value: number;
+            }
+            interface RangeFilter {
                 /**
-                 * Max number of knowledge base chunks to retrieve
+                 * bt: between
                  */
-                top_k?: number;
+                op: 'bt';
+                type: 'range';
+                /**
+                 * [lower_bound, upper_bound]
+                 */
+                value: Array<number>;
+            }
+            /**
+             * Filter by tool call success status.
+             */
+            interface Success {
+                op: 'eq';
+                type: 'boolean';
+                value: boolean;
             }
         }
+        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
+     */
+    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;
+    /**
+     * Override dynamic variables represented as key-value pairs of strings. Setting
+     * this will override or add the dynamic variables set in the agent during the
+     * call. Only need to set the delta where you want to override, no need to set the
+     * entire dynamic variables object. Setting this to null will remove any existing
+     * override.
+     */
+    override_dynamic_variables?: {
+        [key: string]: string;
+    } | null;
+}
 export declare namespace Call {
-    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, };
+    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, };
 }
 //# sourceMappingURL=call.d.ts.map