retell-sdk 5.18.0 → 5.19.0

package/src/resources/agent.ts

@@ -101,26 +101,12 @@ export class Agent extends APIResource {
    * );
    * ```
    */
-  getVersions(agentID: string, options?: RequestOptions): APIPromise<AgentGetVersionsResponse> {
-    return this._client.get(path`/get-agent-versions/${agentID}`, options);
-  }
-
-  /**
-   * Publish the latest version of the agent and create a new draft agent with newer
-   * version.
-   *
-   * @example
-   * ```ts
-   * await client.agent.publish(
-   *   '16b980523634a6dc504898cda492e939',
-   * );
-   * ```
-   */
-  publish(agentID: string, options?: RequestOptions): APIPromise<void> {
-    return this._client.post(path`/publish-agent/${agentID}`, {
-      ...options,
-      headers: buildHeaders([{ Accept: '*/*' }, options?.headers]),
-    });
+  getVersions(
+    agentID: string,
+    query: AgentGetVersionsParams | null | undefined = {},
+    options?: RequestOptions,
+  ): APIPromise<AgentGetVersionsResponse> {
+    return this._client.get(path`/get-agent-versions/${agentID}`, { query, ...options });
   }
 }
 
@@ -162,6 +148,13 @@ export interface AgentResponse {
    */
   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.
@@ -223,6 +216,11 @@ export interface AgentResponse {
    */
   analysis_user_sentiment_prompt?: string | null;
 
+  /**
+   * Tags assigned to this agent version. Preferred tag is listed first.
+   */
+  assigned_tags?: Array<string>;
+
   /**
    * Only applicable when enable_backchannel is true. Controls how often the agent
    * would backchannel when a backchannel is possible. Value ranging from [0,1].
@@ -241,6 +239,11 @@ export interface AgentResponse {
    */
   backchannel_words?: Array<string> | null;
 
+  /**
+   * Version that this draft was based on. Null for initial versions.
+   */
+  base_version?: number | null;
+
   /**
    * If set, will delay the first message by the specified amount of milliseconds, so
    * that it gives user more time to prepare to take the call. Valid range is [0,
@@ -256,6 +259,13 @@ export interface AgentResponse {
    */
   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?: AgentResponse.CallScreeningOption | null;
+
   /**
    * Custom STT configuration. Only used when stt_mode is set to custom.
    */
@@ -552,7 +562,6 @@ export interface AgentResponse {
     | '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'
@@ -580,6 +589,12 @@ export interface AgentResponse {
    */
   reminder_trigger_ms?: number;
 
+  /**
+   * Hydrated response engine for this agent version. Only present when
+   * include_response_engine is true on /get-agent-versions.
+   */
+  response_engine_data?: unknown;
+
   /**
    * Controls how responsive is the agent. Value ranging from [0,1]. Lower value
    * means less responsive agent (wait more, respond slower), while higher value
@@ -779,6 +794,25 @@ export namespace AgentResponse {
     version?: number | 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.
+   */
+  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.
    */
@@ -883,6 +917,12 @@ export namespace AgentResponse {
    */
   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 {
@@ -1134,6 +1174,12 @@ export namespace AgentResponse {
       | 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 {
@@ -1192,6 +1238,13 @@ export interface AgentCreateParams {
    */
   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.
@@ -1286,6 +1339,13 @@ export interface AgentCreateParams {
    */
   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?: AgentCreateParams.CallScreeningOption | null;
+
   /**
    * Custom STT configuration. Only used when stt_mode is set to custom.
    */
@@ -1577,7 +1637,6 @@ export interface AgentCreateParams {
     | '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'
@@ -1804,6 +1863,25 @@ export namespace AgentCreateParams {
     version?: number | 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.
+   */
+  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.
    */
@@ -1908,6 +1986,12 @@ export namespace AgentCreateParams {
    */
   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 {
@@ -2159,6 +2243,12 @@ export namespace AgentCreateParams {
       | 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 {
@@ -2211,6 +2301,13 @@ export interface AgentUpdateParams {
    */
   agent_name?: string | null;
 
+  /**
+   * Body param: 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;
+
   /**
    * Body param: If set to true, DTMF input will be accepted and processed. If false,
    * any DTMF input will be ignored. Default to true.
@@ -2305,6 +2402,13 @@ export interface AgentUpdateParams {
    */
   boosted_keywords?: Array<string> | null;
 
+  /**
+   * Body param: 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?: AgentUpdateParams.CallScreeningOption | null;
+
   /**
    * Body param: Custom STT configuration. Only used when stt_mode is set to custom.
    */
@@ -2599,7 +2703,6 @@ export interface AgentUpdateParams {
     | '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'
@@ -2803,6 +2906,25 @@ export interface AgentUpdateParams {
 }
 
 export namespace AgentUpdateParams {
+  /**
+   * 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.
    */
@@ -2907,6 +3029,12 @@ export namespace AgentUpdateParams {
    */
   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 {
@@ -3204,6 +3332,12 @@ export namespace AgentUpdateParams {
       | 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 {
@@ -3263,6 +3397,15 @@ export interface AgentListParams {
   pagination_key_version?: number;
 }
 
+export interface AgentGetVersionsParams {
+  /**
+   * When true, each returned 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 Agent {
   export {
     type AgentResponse as AgentResponse,
@@ -3272,5 +3415,6 @@ export declare namespace Agent {
     type AgentRetrieveParams as AgentRetrieveParams,
     type AgentUpdateParams as AgentUpdateParams,
     type AgentListParams as AgentListParams,
+    type AgentGetVersionsParams as AgentGetVersionsParams,
   };
 }

package/src/resources/batch-call.ts

@@ -180,7 +180,7 @@ export namespace BatchCallCreateBatchCallParams {
      * For this particular call, override the agent version used with this version.
      * This does not bind the agent 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
@@ -232,6 +232,13 @@ export namespace BatchCallCreateBatchCallParams {
          */
         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.
@@ -326,6 +333,13 @@ export namespace BatchCallCreateBatchCallParams {
          */
         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.
          */
@@ -617,7 +631,6 @@ export namespace BatchCallCreateBatchCallParams {
           | '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'
@@ -814,6 +827,25 @@ export namespace BatchCallCreateBatchCallParams {
       }
 
       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.
          */
@@ -918,6 +950,12 @@ export namespace BatchCallCreateBatchCallParams {
          */
         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 {
@@ -1215,6 +1253,12 @@ export namespace BatchCallCreateBatchCallParams {
             | 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 {
@@ -1334,7 +1378,6 @@ export namespace BatchCallCreateBatchCallParams {
             | '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';
@@ -1402,7 +1445,6 @@ export namespace BatchCallCreateBatchCallParams {
           | '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'