retell-sdk 5.17.0 → 5.19.0

package/src/resources/call.ts

@@ -2561,7 +2561,7 @@ export interface CallCreatePhoneCallParams {
    * This does not bind the agent version to this number, this is for one time
    * override.
    */
-  override_agent_version?: number;
+  override_agent_version?: number | string;
 
   /**
    * Add optional dynamic variables in key value pairs of string that injects into
@@ -2613,6 +2613,13 @@ export namespace CallCreatePhoneCallParams {
        */
       agent_name?: string | null;
 
+      /**
+       * If set to true, DTMF input will interrupt the agent even when
+       * interruption_sensitivity is 0. Can be overridden per conversation or subagent
+       * node. Default to false.
+       */
+      allow_dtmf_interruption?: boolean;
+
       /**
        * If set to true, DTMF input will be accepted and processed. If false, any DTMF
        * input will be ignored. Default to true.
@@ -2707,6 +2714,13 @@ export namespace CallCreatePhoneCallParams {
        */
       boosted_keywords?: Array<string> | null;
 
+      /**
+       * If this option is set, the agent prompt will include call screen handling
+       * instructions for identity and call purpose questions. Set this to null to
+       * disable call screen prompt instructions.
+       */
+      call_screening_option?: Agent.CallScreeningOption | null;
+
       /**
        * Custom STT configuration. Only used when stt_mode is set to custom.
        */
@@ -2998,7 +3012,6 @@ export namespace CallCreatePhoneCallParams {
         | 'claude-4.5-sonnet'
         | 'claude-4.6-sonnet'
         | 'claude-4.5-haiku'
-        | 'gemini-2.5-flash'
         | 'gemini-2.5-flash-lite'
         | 'gemini-3.0-flash'
         | 'gemini-3.1-flash-lite'
@@ -3195,6 +3208,25 @@ export namespace CallCreatePhoneCallParams {
     }
 
     export 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.
+       */
+      export 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.
        */
@@ -3299,6 +3331,12 @@ export namespace CallCreatePhoneCallParams {
        */
       export 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;
       }
 
       export namespace IvrOption {
@@ -3596,6 +3634,12 @@ export namespace CallCreatePhoneCallParams {
           | 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;
       }
 
       export namespace VoicemailOption {
@@ -3715,7 +3759,6 @@ export namespace CallCreatePhoneCallParams {
           | 'claude-4.5-sonnet'
           | 'claude-4.6-sonnet'
           | 'claude-4.5-haiku'
-          | 'gemini-2.5-flash'
           | 'gemini-2.5-flash-lite'
           | 'gemini-3.0-flash'
           | 'gemini-3.1-flash-lite';
@@ -3783,7 +3826,6 @@ export namespace CallCreatePhoneCallParams {
         | 'claude-4.5-sonnet'
         | 'claude-4.6-sonnet'
         | 'claude-4.5-haiku'
-        | 'gemini-2.5-flash'
         | 'gemini-2.5-flash-lite'
         | 'gemini-3.0-flash'
         | 'gemini-3.1-flash-lite'
@@ -3859,7 +3901,7 @@ export interface CallCreateWebCallParams {
   /**
    * The version of the agent to use for the call.
    */
-  agent_version?: number;
+  agent_version?: number | string;
 
   /**
    * Start the call at this conversation flow node (stage). Must be a valid node id
@@ -3932,6 +3974,13 @@ export namespace CallCreateWebCallParams {
        */
       agent_name?: string | null;
 
+      /**
+       * If set to true, DTMF input will interrupt the agent even when
+       * interruption_sensitivity is 0. Can be overridden per conversation or subagent
+       * node. Default to false.
+       */
+      allow_dtmf_interruption?: boolean;
+
       /**
        * If set to true, DTMF input will be accepted and processed. If false, any DTMF
        * input will be ignored. Default to true.
@@ -4026,6 +4075,13 @@ export namespace CallCreateWebCallParams {
        */
       boosted_keywords?: Array<string> | null;
 
+      /**
+       * If this option is set, the agent prompt will include call screen handling
+       * instructions for identity and call purpose questions. Set this to null to
+       * disable call screen prompt instructions.
+       */
+      call_screening_option?: Agent.CallScreeningOption | null;
+
       /**
        * Custom STT configuration. Only used when stt_mode is set to custom.
        */
@@ -4317,7 +4373,6 @@ export namespace CallCreateWebCallParams {
         | 'claude-4.5-sonnet'
         | 'claude-4.6-sonnet'
         | 'claude-4.5-haiku'
-        | 'gemini-2.5-flash'
         | 'gemini-2.5-flash-lite'
         | 'gemini-3.0-flash'
         | 'gemini-3.1-flash-lite'
@@ -4514,6 +4569,25 @@ export namespace CallCreateWebCallParams {
     }
 
     export 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.
+       */
+      export 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.
        */
@@ -4618,6 +4692,12 @@ export namespace CallCreateWebCallParams {
        */
       export 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;
       }
 
       export namespace IvrOption {
@@ -4915,6 +4995,12 @@ export namespace CallCreateWebCallParams {
           | 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;
       }
 
       export namespace VoicemailOption {
@@ -5034,7 +5120,6 @@ export namespace CallCreateWebCallParams {
           | 'claude-4.5-sonnet'
           | 'claude-4.6-sonnet'
           | 'claude-4.5-haiku'
-          | 'gemini-2.5-flash'
           | 'gemini-2.5-flash-lite'
           | 'gemini-3.0-flash'
           | 'gemini-3.1-flash-lite';
@@ -5102,7 +5187,6 @@ export namespace CallCreateWebCallParams {
         | 'claude-4.5-sonnet'
         | 'claude-4.6-sonnet'
         | 'claude-4.5-haiku'
-        | 'gemini-2.5-flash'
         | 'gemini-2.5-flash-lite'
         | 'gemini-3.0-flash'
         | 'gemini-3.1-flash-lite'
@@ -5177,7 +5261,7 @@ export interface CallRegisterPhoneCallParams {
   /**
    * The version of the agent to use for the call.
    */
-  agent_version?: number;
+  agent_version?: number | string;
 
   /**
    * Direction of the phone call. Stored for tracking purpose.
@@ -5251,6 +5335,13 @@ export namespace CallRegisterPhoneCallParams {
        */
       agent_name?: string | null;
 
+      /**
+       * If set to true, DTMF input will interrupt the agent even when
+       * interruption_sensitivity is 0. Can be overridden per conversation or subagent
+       * node. Default to false.
+       */
+      allow_dtmf_interruption?: boolean;
+
       /**
        * If set to true, DTMF input will be accepted and processed. If false, any DTMF
        * input will be ignored. Default to true.
@@ -5345,6 +5436,13 @@ export namespace CallRegisterPhoneCallParams {
        */
       boosted_keywords?: Array<string> | null;
 
+      /**
+       * If this option is set, the agent prompt will include call screen handling
+       * instructions for identity and call purpose questions. Set this to null to
+       * disable call screen prompt instructions.
+       */
+      call_screening_option?: Agent.CallScreeningOption | null;
+
       /**
        * Custom STT configuration. Only used when stt_mode is set to custom.
        */
@@ -5636,7 +5734,6 @@ export namespace CallRegisterPhoneCallParams {
         | 'claude-4.5-sonnet'
         | 'claude-4.6-sonnet'
         | 'claude-4.5-haiku'
-        | 'gemini-2.5-flash'
         | 'gemini-2.5-flash-lite'
         | 'gemini-3.0-flash'
         | 'gemini-3.1-flash-lite'
@@ -5833,6 +5930,25 @@ export namespace CallRegisterPhoneCallParams {
     }
 
     export 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.
+       */
+      export 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.
        */
@@ -5937,6 +6053,12 @@ export namespace CallRegisterPhoneCallParams {
        */
       export 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;
       }
 
       export namespace IvrOption {
@@ -6234,6 +6356,12 @@ export namespace CallRegisterPhoneCallParams {
           | 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;
       }
 
       export namespace VoicemailOption {
@@ -6353,7 +6481,6 @@ export namespace CallRegisterPhoneCallParams {
           | 'claude-4.5-sonnet'
           | 'claude-4.6-sonnet'
           | 'claude-4.5-haiku'
-          | 'gemini-2.5-flash'
           | 'gemini-2.5-flash-lite'
           | 'gemini-3.0-flash'
           | 'gemini-3.1-flash-lite';
@@ -6421,7 +6548,6 @@ export namespace CallRegisterPhoneCallParams {
         | 'claude-4.5-sonnet'
         | 'claude-4.6-sonnet'
         | 'claude-4.5-haiku'
-        | 'gemini-2.5-flash'
         | 'gemini-2.5-flash-lite'
         | 'gemini-3.0-flash'
         | 'gemini-3.1-flash-lite'

package/src/resources/chat-agent.ts

@@ -104,26 +104,12 @@ export class ChatAgent extends APIResource {
    *   );
    * ```
    */
-  getVersions(agentID: string, options?: RequestOptions): APIPromise<ChatAgentGetVersionsResponse> {
-    return this._client.get(path`/get-chat-agent-versions/${agentID}`, options);
-  }
-
-  /**
-   * Publish the latest version of the chat agent and create a new draft chat agent
-   * with newer version.
-   *
-   * @example
-   * ```ts
-   * await client.chatAgent.publish(
-   *   '16b980523634a6dc504898cda492e939',
-   * );
-   * ```
-   */
-  publish(agentID: string, options?: RequestOptions): APIPromise<void> {
-    return this._client.post(path`/publish-chat-agent/${agentID}`, {
-      ...options,
-      headers: buildHeaders([{ Accept: '*/*' }, options?.headers]),
-    });
+  getVersions(
+    agentID: string,
+    query: ChatAgentGetVersionsParams | null | undefined = {},
+    options?: RequestOptions,
+  ): APIPromise<ChatAgentGetVersionsResponse> {
+    return this._client.get(path`/get-chat-agent-versions/${agentID}`, { query, ...options });
   }
 }
 
@@ -172,11 +158,21 @@ export interface ChatAgentResponse {
    */
   analysis_user_sentiment_prompt?: string | null;
 
+  /**
+   * Tags assigned to this chat agent version. Preferred tag is listed first.
+   */
+  assigned_tags?: Array<string>;
+
   /**
    * Message to display when the chat is automatically closed.
    */
   auto_close_message?: string | null;
 
+  /**
+   * Version that this draft was based on. Null for initial versions.
+   */
+  base_version?: number | null;
+
   /**
    * 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
@@ -405,12 +401,17 @@ export interface ChatAgentResponse {
     | 'claude-4.5-sonnet'
     | 'claude-4.6-sonnet'
     | 'claude-4.5-haiku'
-    | 'gemini-2.5-flash'
     | 'gemini-2.5-flash-lite'
     | 'gemini-3.0-flash'
     | 'gemini-3.1-flash-lite'
     | null;
 
+  /**
+   * Hydrated response engine for this chat agent version. Only present when
+   * include_response_engine is true on /get-chat-agent-versions.
+   */
+  response_engine_data?: unknown;
+
   /**
    * 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
@@ -433,7 +434,7 @@ export interface ChatAgentResponse {
    * Which webhook events this agent should receive. If not set, defaults to
    * chat_started, chat_ended, chat_analyzed.
    */
-  webhook_events?: Array<'chat_started' | 'chat_ended' | 'chat_analyzed'> | null;
+  webhook_events?: Array<'chat_started' | 'chat_ended' | 'chat_analyzed' | 'transcript_updated'> | null;
 
   /**
    * The timeout for the webhook in milliseconds. If not set, default value of 10000
@@ -1012,7 +1013,6 @@ export interface ChatAgentCreateParams {
     | 'claude-4.5-sonnet'
     | 'claude-4.6-sonnet'
     | 'claude-4.5-haiku'
-    | 'gemini-2.5-flash'
     | 'gemini-2.5-flash-lite'
     | 'gemini-3.0-flash'
     | 'gemini-3.1-flash-lite'
@@ -1035,7 +1035,7 @@ export interface ChatAgentCreateParams {
    * Which webhook events this agent should receive. If not set, defaults to
    * chat_started, chat_ended, chat_analyzed.
    */
-  webhook_events?: Array<'chat_started' | 'chat_ended' | 'chat_analyzed'> | null;
+  webhook_events?: Array<'chat_started' | 'chat_ended' | 'chat_analyzed' | 'transcript_updated'> | null;
 
   /**
    * The timeout for the webhook in milliseconds. If not set, default value of 10000
@@ -1616,7 +1616,6 @@ export interface ChatAgentUpdateParams {
     | 'claude-4.5-sonnet'
     | 'claude-4.6-sonnet'
     | 'claude-4.5-haiku'
-    | 'gemini-2.5-flash'
     | 'gemini-2.5-flash-lite'
     | 'gemini-3.0-flash'
     | 'gemini-3.1-flash-lite'
@@ -1649,7 +1648,7 @@ export interface ChatAgentUpdateParams {
    * Body param: Which webhook events this agent should receive. If not set, defaults
    * to chat_started, chat_ended, chat_analyzed.
    */
-  webhook_events?: Array<'chat_started' | 'chat_ended' | 'chat_analyzed'> | null;
+  webhook_events?: Array<'chat_started' | 'chat_ended' | 'chat_analyzed' | 'transcript_updated'> | null;
 
   /**
    * Body param: The timeout for the webhook in milliseconds. If not set, default
@@ -1989,6 +1988,15 @@ export interface ChatAgentListParams {
   pagination_key_version?: number;
 }
 
+export interface ChatAgentGetVersionsParams {
+  /**
+   * When true, each returned chat agent version includes a response_engine_data
+   * field with the hydrated response engine (full retell-llm or conversation-flow
+   * configuration) bound to that version.
+   */
+  include_response_engine?: boolean;
+}
+
 export declare namespace ChatAgent {
   export {
     type ChatAgentResponse as ChatAgentResponse,
@@ -1998,5 +2006,6 @@ export declare namespace ChatAgent {
     type ChatAgentRetrieveParams as ChatAgentRetrieveParams,
     type ChatAgentUpdateParams as ChatAgentUpdateParams,
     type ChatAgentListParams as ChatAgentListParams,
+    type ChatAgentGetVersionsParams as ChatAgentGetVersionsParams,
   };
 }

package/src/resources/chat.ts

@@ -646,7 +646,7 @@ export interface ChatCreateParams {
    * The version of the chat agent to use for the chat. If not provided, will default
    * to latest version.
    */
-  agent_version?: number;
+  agent_version?: number | string;
 
   /**
    * An arbitrary object for storage purpose only. You can put anything here like
@@ -757,7 +757,7 @@ export interface ChatCreateSMSChatParams {
    * This does not bind the agent version to this number, this is for one time
    * override.
    */
-  override_agent_version?: number;
+  override_agent_version?: number | string;
 
   /**
    * Add optional dynamic variables in key value pairs of string that injects into