retell-sdk 4.57.0 → 4.59.0

package/src/resources/chat.ts

@@ -32,6 +32,34 @@ export class Chat extends APIResource {
     return this._client.get(`/get-chat/${chatId}`, options);
   }
 
+  /**
+   * Update metadata and sensitive data storage settings for an existing chat.
+   *
+   * @example
+   * ```ts
+   * const chatResponse = await client.chat.update(
+   *   'chat_98c1a2157aa0559144d67bb0729',
+   *   {
+   *     data_storage_setting: 'everything',
+   *     metadata: {
+   *       customer_id: 'cust_123',
+   *       notes: 'Follow-up required',
+   *     },
+   *     override_dynamic_variables: {
+   *       additional_discount: '15%',
+   *     },
+   *   },
+   * );
+   * ```
+   */
+  update(
+    chatId: string,
+    body: ChatUpdateParams,
+    options?: Core.RequestOptions,
+  ): Core.APIPromise<ChatResponse> {
+    return this._client.patch(`/update-chat/${chatId}`, { body, ...options });
+  }
+
   /**
    * List all chats
    *
@@ -572,6 +600,31 @@ export interface ChatCreateParams {
   retell_llm_dynamic_variables?: { [key: string]: unknown };
 }
 
+export interface ChatUpdateParams {
+  /**
+   * Data storage setting for this chat. Overrides the agent's default setting.
+   * "everything" stores all data, "basic_attributes_only" stores only metadata.
+   * Cannot be downgraded from more restrictive to less restrictive settings.
+   */
+  data_storage_setting?: 'everything' | 'basic_attributes_only';
+
+  /**
+   * An arbitrary object for storage purpose only. You can put anything here like
+   * your internal customer id associated with the chat. Not used for processing. You
+   * can later get this field from the chat object. Size limited to 50kB max.
+   */
+  metadata?: unknown;
+
+  /**
+   * Override dynamic varaibles 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 interface ChatCreateChatCompletionParams {
   /**
    * Unique id of the chat to create completion.
@@ -630,6 +683,7 @@ export declare namespace Chat {
     type ChatListResponse as ChatListResponse,
     type ChatCreateChatCompletionResponse as ChatCreateChatCompletionResponse,
     type ChatCreateParams as ChatCreateParams,
+    type ChatUpdateParams as ChatUpdateParams,
     type ChatCreateChatCompletionParams as ChatCreateChatCompletionParams,
     type ChatCreateSMSChatParams as ChatCreateSMSChatParams,
   };

package/src/resources/conversation-flow.ts

@@ -172,6 +172,11 @@ export interface ConversationFlowResponse {
    */
   global_prompt?: string | null;
 
+  /**
+   * Whether this conversation flow is used for transfer LLM.
+   */
+  is_transfer_llm?: boolean | null;
+
   /**
    * Knowledge base configuration for RAG retrieval.
    */
@@ -226,8 +231,8 @@ export interface ConversationFlowResponse {
   start_speaker?: 'user' | 'agent';
 
   /**
-   * Whether to use strict mode for tool calls. Only applicable when using structured
-   * output models.
+   * Whether to use strict mode for tool calls. Only applicable when using certain
+   * supported models.
    */
   tool_call_strict_mode?: boolean | null;
 
@@ -7539,6 +7544,11 @@ export interface ConversationFlowCreateParams {
    */
   global_prompt?: string | null;
 
+  /**
+   * Whether this conversation flow is used for transfer LLM.
+   */
+  is_transfer_llm?: boolean | null;
+
   /**
    * Knowledge base configuration for RAG retrieval.
    */
@@ -7566,8 +7576,8 @@ export interface ConversationFlowCreateParams {
   start_node_id?: string | null;
 
   /**
-   * Whether to use strict mode for tool calls. Only applicable when using structured
-   * output models.
+   * Whether to use strict mode for tool calls. Only applicable when using certain
+   * supported models.
    */
   tool_call_strict_mode?: boolean | null;
 
@@ -14859,6 +14869,11 @@ export interface ConversationFlowUpdateParams {
    */
   global_prompt?: string | null;
 
+  /**
+   * Body param: Whether this conversation flow is used for transfer LLM.
+   */
+  is_transfer_llm?: boolean | null;
+
   /**
    * Body param: Knowledge base configuration for RAG retrieval.
    */
@@ -14915,7 +14930,7 @@ export interface ConversationFlowUpdateParams {
 
   /**
    * Body param: Whether to use strict mode for tool calls. Only applicable when
-   * using structured output models.
+   * using certain supported models.
    */
   tool_call_strict_mode?: boolean | null;
 

package/src/resources/index.ts

@@ -29,6 +29,7 @@ export {
   type ChatListResponse,
   type ChatCreateChatCompletionResponse,
   type ChatCreateParams,
+  type ChatUpdateParams,
   type ChatCreateChatCompletionParams,
   type ChatCreateSMSChatParams,
 } from './chat';

package/src/resources/llm.ts

@@ -11,9 +11,7 @@ export class Llm extends APIResource {
    *
    * @example
    * ```ts
-   * const llmResponse = await client.llm.create({
-   *   start_speaker: 'user',
-   * });
+   * const llmResponse = await client.llm.create();
    * ```
    */
   create(body: LlmCreateParams, options?: Core.RequestOptions): Core.APIPromise<LlmResponse> {
@@ -55,7 +53,6 @@ export class Llm extends APIResource {
    * const llmResponse = await client.llm.update(
    *   '16b980523634a6dc504898cda492e939',
    *   {
-   *     start_speaker: 'user',
    *     begin_message:
    *       'Hey I am a virtual assistant calling from Retell Hospital.',
    *   },
@@ -123,12 +120,6 @@ export interface LlmResponse {
    */
   llm_id: string;
 
-  /**
-   * The speaker who starts the conversation. Required. Must be either 'user' or
-   * 'agent'.
-   */
-  start_speaker: 'user' | 'agent';
-
   /**
    * 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
@@ -192,11 +183,15 @@ export interface LlmResponse {
   kb_config?: LlmResponse.KBConfig | null;
 
   /**
-   * A list of knowledge base ids to use for this resource. Set to null to remove all
-   * knowledge bases.
+   * A list of knowledge base ids to use for this resource.
    */
   knowledge_base_ids?: Array<string> | null;
 
+  /**
+   * A list of MCPs to use for this LLM.
+   */
+  mcps?: Array<LlmResponse.Mcp> | null;
+
   /**
    * Select the underlying text LLM. If not set, would default to gpt-4.1.
    */
@@ -218,11 +213,11 @@ export interface LlmResponse {
     | null;
 
   /**
-   * If set to true, will enable fast tier, which uses 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.
+   * 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;
+  model_high_priority?: boolean | null;
 
   /**
    * If set, will control the randomness of the response. Value ranging from [0,1].
@@ -238,6 +233,12 @@ export interface LlmResponse {
    */
   s2s_model?: 'gpt-4o-realtime' | 'gpt-4o-mini-realtime' | 'gpt-realtime' | null;
 
+  /**
+   * The speaker who starts the conversation. Required. Must be either 'user' or
+   * 'agent'.
+   */
+  start_speaker?: 'user' | 'agent';
+
   /**
    * Name of the starting state. Required if states is not empty.
    */
@@ -253,17 +254,15 @@ export interface LlmResponse {
   states?: Array<LlmResponse.State> | null;
 
   /**
-   * Only applicable when model is gpt-4o or gpt-4o mini. If set to true, will use
-   * structured output to make sure tool call arguments follow the json schema. The
-   * time to save a new tool or change to a tool will be longer as additional
-   * processing is needed. Default to false.
+   * Whether to use strict mode for tool calls. Only applicable when using certain
+   * supported models.
    */
-  tool_call_strict_mode?: boolean;
+  tool_call_strict_mode?: boolean | null;
 
   /**
-   * Version of the Retell LLM.
+   * The version of the LLM.
    */
-  version?: unknown;
+  version?: number | null;
 }
 
 export namespace LlmResponse {
@@ -949,6 +948,31 @@ export namespace LlmResponse {
     top_k?: number;
   }
 
+  export interface Mcp {
+    name: string;
+
+    /**
+     * The URL of the MCP server.
+     */
+    url: string;
+
+    /**
+     * Headers to add to the MCP connection request.
+     */
+    headers?: { [key: string]: string };
+
+    /**
+     * Query parameters to append to the MCP connection request URL.
+     */
+    query_params?: { [key: string]: string };
+
+    /**
+     * Maximum time to wait for a connection to be established (in milliseconds).
+     * Default to 120,000 ms (2 minutes).
+     */
+    timeout_ms?: number;
+  }
+
   export interface State {
     /**
      * Name of the state, must be unique for each state. Must be consisted of a-z, A-Z,
@@ -1720,12 +1744,6 @@ export namespace LlmResponse {
 export type LlmListResponse = Array<LlmResponse>;
 
 export interface LlmCreateParams {
-  /**
-   * The speaker who starts the conversation. Required. Must be either 'user' or
-   * 'agent'.
-   */
-  start_speaker: 'user' | 'agent';
-
   /**
    * 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
@@ -1784,11 +1802,15 @@ export interface LlmCreateParams {
   kb_config?: LlmCreateParams.KBConfig | null;
 
   /**
-   * A list of knowledge base ids to use for this resource. Set to null to remove all
-   * knowledge bases.
+   * A list of knowledge base ids to use for this resource.
    */
   knowledge_base_ids?: Array<string> | null;
 
+  /**
+   * A list of MCPs to use for this LLM.
+   */
+  mcps?: Array<LlmCreateParams.Mcp> | null;
+
   /**
    * Select the underlying text LLM. If not set, would default to gpt-4.1.
    */
@@ -1810,11 +1832,11 @@ export interface LlmCreateParams {
     | null;
 
   /**
-   * If set to true, will enable fast tier, which uses 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.
+   * 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;
+  model_high_priority?: boolean | null;
 
   /**
    * If set, will control the randomness of the response. Value ranging from [0,1].
@@ -1830,6 +1852,12 @@ export interface LlmCreateParams {
    */
   s2s_model?: 'gpt-4o-realtime' | 'gpt-4o-mini-realtime' | 'gpt-realtime' | null;
 
+  /**
+   * The speaker who starts the conversation. Required. Must be either 'user' or
+   * 'agent'.
+   */
+  start_speaker?: 'user' | 'agent';
+
   /**
    * Name of the starting state. Required if states is not empty.
    */
@@ -1845,15 +1873,13 @@ export interface LlmCreateParams {
   states?: Array<LlmCreateParams.State> | null;
 
   /**
-   * Only applicable when model is gpt-4o or gpt-4o mini. If set to true, will use
-   * structured output to make sure tool call arguments follow the json schema. The
-   * time to save a new tool or change to a tool will be longer as additional
-   * processing is needed. Default to false.
+   * Whether to use strict mode for tool calls. Only applicable when using certain
+   * supported models.
    */
-  tool_call_strict_mode?: boolean;
+  tool_call_strict_mode?: boolean | null;
 
   /**
-   * Version of the Retell LLM.
+   * The version of the LLM.
    */
   version?: number | null;
 }
@@ -2541,6 +2567,31 @@ export namespace LlmCreateParams {
     top_k?: number;
   }
 
+  export interface Mcp {
+    name: string;
+
+    /**
+     * The URL of the MCP server.
+     */
+    url: string;
+
+    /**
+     * Headers to add to the MCP connection request.
+     */
+    headers?: { [key: string]: string };
+
+    /**
+     * Query parameters to append to the MCP connection request URL.
+     */
+    query_params?: { [key: string]: string };
+
+    /**
+     * Maximum time to wait for a connection to be established (in milliseconds).
+     * Default to 120,000 ms (2 minutes).
+     */
+    timeout_ms?: number;
+  }
+
   export interface State {
     /**
      * Name of the state, must be unique for each state. Must be consisted of a-z, A-Z,
@@ -3317,12 +3368,6 @@ export interface LlmRetrieveParams {
 }
 
 export interface LlmUpdateParams {
-  /**
-   * Body param: The speaker who starts the conversation. Required. Must be either
-   * 'user' or 'agent'.
-   */
-  start_speaker: 'user' | 'agent';
-
   /**
    * Query param: Optional version of the API to use for this request. Default to
    * latest version.
@@ -3390,11 +3435,15 @@ export interface LlmUpdateParams {
   kb_config?: LlmUpdateParams.KBConfig | null;
 
   /**
-   * Body param: A list of knowledge base ids to use for this resource. Set to null
-   * to remove all knowledge bases.
+   * Body param: A list of knowledge base ids to use for this resource.
    */
   knowledge_base_ids?: Array<string> | null;
 
+  /**
+   * Body param: A list of MCPs to use for this LLM.
+   */
+  mcps?: Array<LlmUpdateParams.Mcp> | null;
+
   /**
    * Body param: Select the underlying text LLM. If not set, would default to
    * gpt-4.1.
@@ -3417,11 +3466,11 @@ export interface LlmUpdateParams {
     | null;
 
   /**
-   * Body param: If set to true, will enable fast tier, which uses 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.
+   * Body param: 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;
+  model_high_priority?: boolean | null;
 
   /**
    * Body param: If set, will control the randomness of the response. Value ranging
@@ -3437,6 +3486,12 @@ export interface LlmUpdateParams {
    */
   s2s_model?: 'gpt-4o-realtime' | 'gpt-4o-mini-realtime' | 'gpt-realtime' | null;
 
+  /**
+   * Body param: The speaker who starts the conversation. Required. Must be either
+   * 'user' or 'agent'.
+   */
+  start_speaker?: 'user' | 'agent';
+
   /**
    * Body param: Name of the starting state. Required if states is not empty.
    */
@@ -3452,15 +3507,13 @@ export interface LlmUpdateParams {
   states?: Array<LlmUpdateParams.State> | null;
 
   /**
-   * Body param: Only applicable when model is gpt-4o or gpt-4o mini. If set to true,
-   * will use structured output to make sure tool call arguments follow the json
-   * schema. The time to save a new tool or change to a tool will be longer as
-   * additional processing is needed. Default to false.
+   * Body param: Whether to use strict mode for tool calls. Only applicable when
+   * using certain supported models.
    */
-  tool_call_strict_mode?: boolean;
+  tool_call_strict_mode?: boolean | null;
 
   /**
-   * Body param: Version of the Retell LLM.
+   * Body param: The version of the LLM.
    */
   body_version?: number | null;
 }
@@ -4148,6 +4201,31 @@ export namespace LlmUpdateParams {
     top_k?: number;
   }
 
+  export interface Mcp {
+    name: string;
+
+    /**
+     * The URL of the MCP server.
+     */
+    url: string;
+
+    /**
+     * Headers to add to the MCP connection request.
+     */
+    headers?: { [key: string]: string };
+
+    /**
+     * Query parameters to append to the MCP connection request URL.
+     */
+    query_params?: { [key: string]: string };
+
+    /**
+     * Maximum time to wait for a connection to be established (in milliseconds).
+     * Default to 120,000 ms (2 minutes).
+     */
+    timeout_ms?: number;
+  }
+
   export interface State {
     /**
      * Name of the state, must be unique for each state. Must be consisted of a-z, A-Z,

package/src/version.ts

@@ -1 +1 @@
-export const VERSION = '4.57.0'; // x-release-please-version
+export const VERSION = '4.59.0'; // x-release-please-version

package/version.d.ts

@@ -1,2 +1,2 @@
-export declare const VERSION = "4.57.0";
+export declare const VERSION = "4.59.0";
 //# sourceMappingURL=version.d.ts.map

package/version.js

@@ -1,5 +1,5 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.VERSION = void 0;
-exports.VERSION = '4.57.0'; // x-release-please-version
+exports.VERSION = '4.59.0'; // x-release-please-version
 //# sourceMappingURL=version.js.map

package/version.mjs

@@ -1,2 +1,2 @@
-export const VERSION = '4.57.0'; // x-release-please-version
+export const VERSION = '4.59.0'; // x-release-please-version
 //# sourceMappingURL=version.mjs.map