telnyx 7.22.0 → 7.23.0

package/resources/ai/assistants/assistants.d.ts

@@ -15,6 +15,7 @@ import * as AssistantsToolsAPI from "./tools.js";
 import { ToolAddParams, ToolAddResponse, ToolRemoveParams, ToolRemoveResponse, ToolTestParams, ToolTestResponse, Tools } from "./tools.js";
 import * as VersionsAPI from "./versions.js";
 import { UpdateAssistant, VersionDeleteParams, VersionPromoteParams, VersionRetrieveParams, VersionUpdateParams, Versions } from "./versions.js";
+import * as OpenAIChatAPI from "../openai/chat.js";
 import * as TestsAPI from "./tests/tests.js";
 import { AssistantTest, AssistantTestsDefaultFlatPagination, TelnyxConversationChannel, TestCreateParams, TestListParams, TestUpdateParams, Tests } from "./tests/tests.js";
 import { APIPromise } from "../../../core/api-promise.js";
@@ -371,11 +372,35 @@ export interface AssistantMcpServer {
  * another AI assistant. By default, this will happen transparently to the end
  * user.
  */
-export type AssistantTool = InferenceEmbeddingWebhookToolParams | AssistantTool.ClientSideTool | RetrievalTool | AssistantTool.Handoff | HangupTool | AssistantTool.Transfer | AssistantTool.Invite | AssistantTool.Refer | AssistantTool.SendDtmf | AssistantTool.SendMessage | AssistantTool.SkipTurn | AssistantTool.Pay | AssistantTool.UpdateDynamicVariables;
+export type AssistantTool = AssistantTool.Function | InferenceEmbeddingWebhookToolParams | AssistantTool.ClientSideTool | RetrievalTool | AssistantTool.Handoff | AssistantTool.Hangup | AssistantTool.Transfer | AssistantTool.Invite | AssistantTool.Refer | AssistantTool.SendDtmf | AssistantTool.SendMessage | AssistantTool.SkipTurn | AssistantTool.Pay | AssistantTool.UpdateDynamicVariables;
 export declare namespace AssistantTool {
+    interface Function {
+        function: OpenAIChatAPI.FunctionDefinition;
+        type: 'function';
+        /**
+         * Whether this tool comes from the shared Tools Library. Responses merge shared
+         * tools into `tools` with `shared: true`; inline tools carry `shared: false`.
+         * Read-only: set by the server, not accepted in requests. When updating an
+         * assistant, omit `shared: true` tools from the request `tools` array and manage
+         * them through `tool_ids` instead — re-sending their definitions creates an inline
+         * duplicate (rejected with error code 10015 when the type allows only one instance
+         * per assistant).
+         */
+        shared?: boolean;
+    }
     interface ClientSideTool {
         client_side_tool: ClientSideTool.ClientSideTool;
         type: 'client_side_tool';
+        /**
+         * Whether this tool comes from the shared Tools Library. Responses merge shared
+         * tools into `tools` with `shared: true`; inline tools carry `shared: false`.
+         * Read-only: set by the server, not accepted in requests. When updating an
+         * assistant, omit `shared: true` tools from the request `tools` array and manage
+         * them through `tool_ids` instead — re-sending their definitions creates an inline
+         * duplicate (rejected with error code 10015 when the type allows only one instance
+         * per assistant).
+         */
+        shared?: boolean;
     }
     namespace ClientSideTool {
         interface ClientSideTool {
@@ -423,6 +448,16 @@ export declare namespace AssistantTool {
     interface Handoff {
         handoff: Handoff.Handoff;
         type: 'handoff';
+        /**
+         * Whether this tool comes from the shared Tools Library. Responses merge shared
+         * tools into `tools` with `shared: true`; inline tools carry `shared: false`.
+         * Read-only: set by the server, not accepted in requests. When updating an
+         * assistant, omit `shared: true` tools from the request `tools` array and manage
+         * them through `tool_ids` instead — re-sending their definitions creates an inline
+         * duplicate (rejected with error code 10015 when the type allows only one instance
+         * per assistant).
+         */
+        shared?: boolean;
     }
     namespace Handoff {
         interface Handoff {
@@ -451,9 +486,33 @@ export declare namespace AssistantTool {
             }
         }
     }
+    interface Hangup {
+        hangup: AssistantsAPI.HangupToolParams;
+        type: 'hangup';
+        /**
+         * Whether this tool comes from the shared Tools Library. Responses merge shared
+         * tools into `tools` with `shared: true`; inline tools carry `shared: false`.
+         * Read-only: set by the server, not accepted in requests. When updating an
+         * assistant, omit `shared: true` tools from the request `tools` array and manage
+         * them through `tool_ids` instead — re-sending their definitions creates an inline
+         * duplicate (rejected with error code 10015 when the type allows only one instance
+         * per assistant).
+         */
+        shared?: boolean;
+    }
     interface Transfer {
         transfer: Transfer.Transfer;
         type: 'transfer';
+        /**
+         * Whether this tool comes from the shared Tools Library. Responses merge shared
+         * tools into `tools` with `shared: true`; inline tools carry `shared: false`.
+         * Read-only: set by the server, not accepted in requests. When updating an
+         * assistant, omit `shared: true` tools from the request `tools` array and manage
+         * them through `tool_ids` instead — re-sending their definitions creates an inline
+         * duplicate (rejected with error code 10015 when the type allows only one instance
+         * per assistant).
+         */
+        shared?: boolean;
     }
     namespace Transfer {
         interface Transfer {
@@ -688,6 +747,16 @@ export declare namespace AssistantTool {
     interface Invite {
         invite: Invite.Invite;
         type: 'invite';
+        /**
+         * Whether this tool comes from the shared Tools Library. Responses merge shared
+         * tools into `tools` with `shared: true`; inline tools carry `shared: false`.
+         * Read-only: set by the server, not accepted in requests. When updating an
+         * assistant, omit `shared: true` tools from the request `tools` array and manage
+         * them through `tool_ids` instead — re-sending their definitions creates an inline
+         * duplicate (rejected with error code 10015 when the type allows only one instance
+         * per assistant).
+         */
+        shared?: boolean;
     }
     namespace Invite {
         interface Invite {
@@ -766,6 +835,16 @@ export declare namespace AssistantTool {
     interface Refer {
         refer: Refer.Refer;
         type: 'refer';
+        /**
+         * Whether this tool comes from the shared Tools Library. Responses merge shared
+         * tools into `tools` with `shared: true`; inline tools carry `shared: false`.
+         * Read-only: set by the server, not accepted in requests. When updating an
+         * assistant, omit `shared: true` tools from the request `tools` array and manage
+         * them through `tool_ids` instead — re-sending their definitions creates an inline
+         * duplicate (rejected with error code 10015 when the type allows only one instance
+         * per assistant).
+         */
+        shared?: boolean;
     }
     namespace Refer {
         interface Refer {
@@ -830,6 +909,16 @@ export declare namespace AssistantTool {
             [key: string]: unknown;
         };
         type: 'send_dtmf';
+        /**
+         * Whether this tool comes from the shared Tools Library. Responses merge shared
+         * tools into `tools` with `shared: true`; inline tools carry `shared: false`.
+         * Read-only: set by the server, not accepted in requests. When updating an
+         * assistant, omit `shared: true` tools from the request `tools` array and manage
+         * them through `tool_ids` instead — re-sending their definitions creates an inline
+         * duplicate (rejected with error code 10015 when the type allows only one instance
+         * per assistant).
+         */
+        shared?: boolean;
     }
     /**
      * The send_message tool allows the assistant to send SMS or MMS messages to the
@@ -840,6 +929,16 @@ export declare namespace AssistantTool {
     interface SendMessage {
         send_message: SendMessage.SendMessage;
         type: 'send_message';
+        /**
+         * Whether this tool comes from the shared Tools Library. Responses merge shared
+         * tools into `tools` with `shared: true`; inline tools carry `shared: false`.
+         * Read-only: set by the server, not accepted in requests. When updating an
+         * assistant, omit `shared: true` tools from the request `tools` array and manage
+         * them through `tool_ids` instead — re-sending their definitions creates an inline
+         * duplicate (rejected with error code 10015 when the type allows only one instance
+         * per assistant).
+         */
+        shared?: boolean;
     }
     namespace SendMessage {
         interface SendMessage {
@@ -857,6 +956,16 @@ export declare namespace AssistantTool {
     interface SkipTurn {
         skip_turn: SkipTurn.SkipTurn;
         type: 'skip_turn';
+        /**
+         * Whether this tool comes from the shared Tools Library. Responses merge shared
+         * tools into `tools` with `shared: true`; inline tools carry `shared: false`.
+         * Read-only: set by the server, not accepted in requests. When updating an
+         * assistant, omit `shared: true` tools from the request `tools` array and manage
+         * them through `tool_ids` instead — re-sending their definitions creates an inline
+         * duplicate (rejected with error code 10015 when the type allows only one instance
+         * per assistant).
+         */
+        shared?: boolean;
     }
     namespace SkipTurn {
         interface SkipTurn {
@@ -875,6 +984,16 @@ export declare namespace AssistantTool {
     interface Pay {
         pay: ToolsAPI.PayToolParams;
         type: 'pay';
+        /**
+         * Whether this tool comes from the shared Tools Library. Responses merge shared
+         * tools into `tools` with `shared: true`; inline tools carry `shared: false`.
+         * Read-only: set by the server, not accepted in requests. When updating an
+         * assistant, omit `shared: true` tools from the request `tools` array and manage
+         * them through `tool_ids` instead — re-sending their definitions creates an inline
+         * duplicate (rejected with error code 10015 when the type allows only one instance
+         * per assistant).
+         */
+        shared?: boolean;
     }
     /**
      * The update_dynamic_variables tool lets the assistant write values into the
@@ -889,6 +1008,16 @@ export declare namespace AssistantTool {
          * Configuration for an update_dynamic_variables tool.
          */
         update_dynamic_variables: ToolsAPI.UpdateDynamicVariablesToolParams;
+        /**
+         * Whether this tool comes from the shared Tools Library. Responses merge shared
+         * tools into `tools` with `shared: true`; inline tools carry `shared: false`.
+         * Read-only: set by the server, not accepted in requests. When updating an
+         * assistant, omit `shared: true` tools from the request `tools` array and manage
+         * them through `tool_ids` instead — re-sending their definitions creates an inline
+         * duplicate (rejected with error code 10015 when the type allows only one instance
+         * per assistant).
+         */
+        shared?: boolean;
     }
 }
 export interface AssistantsList {
@@ -1552,10 +1681,10 @@ export interface InferenceEmbedding {
     /**
      * Configuration for post-conversation processing. When enabled, the assistant
      * receives one additional LLM turn after the conversation ends, allowing it to
-     * execute tool calls such as logging to a CRM or sending a summary. The assistant
-     * can execute multiple parallel or sequential tools during this phase.
-     * Telephony-control tools (e.g. hangup, transfer) are unavailable
-     * post-conversation. Beta feature.
+     * execute final tool calls such as sending a summary or updating a record via
+     * webhook or function tools. Integration and MCP server tools are not available
+     * post-conversation; call-control tools (e.g. hangup, transfer) are also
+     * unavailable. Beta feature.
      */
     post_conversation_settings?: PostConversationSettings;
     privacy_settings?: PrivacySettings;
@@ -1570,9 +1699,12 @@ export interface InferenceEmbedding {
     tags?: Array<string>;
     telephony_settings?: TelephonySettings;
     /**
-     * Deprecated for new integrations. Inline tool definitions available to the
-     * assistant. Prefer `tool_ids` to attach shared tools created with the AI Tools
-     * endpoints.
+     * The assistant's tools. Responses merge the assistant's shared Tools Library
+     * tools into this array alongside inline tools, each flagged `shared: true`;
+     * inline tools carry `shared: false`. On update, a sent `tools` array fully
+     * replaces the inline tools only — shared tools stay attached unless `tool_ids`
+     * changes. Each tool type except `function`, `webhook`, and `client_side_tool`
+     * allows at most one instance per assistant across both sources.
      */
     tools?: Array<AssistantTool>;
     transcription?: TranscriptionSettings;
@@ -1612,6 +1744,11 @@ export interface InferenceEmbeddingInterruptionSettings {
      * Whether users can interrupt the assistant while it is speaking.
      */
     enable?: boolean;
+    /**
+     * Interrupt-prediction sensitivity, from 0.0 to 1.0. Set to null or 0.0 to disable
+     * interrupt prediction.
+     */
+    interrupt_prediction_threshold?: number | null;
     /**
      * Controls when the assistant starts speaking after the user stops. These
      * thresholds primarily apply to non turn-taking transcription models. For
@@ -1623,6 +1760,16 @@ export interface InferenceEmbeddingInterruptionSettings {
 export interface InferenceEmbeddingWebhookToolParams {
     type: 'webhook';
     webhook: InferenceEmbeddingWebhookToolParams.Webhook;
+    /**
+     * Whether this tool comes from the shared Tools Library. Responses merge shared
+     * tools into `tools` with `shared: true`; inline tools carry `shared: false`.
+     * Read-only: set by the server, not accepted in requests. When updating an
+     * assistant, omit `shared: true` tools from the request `tools` array and manage
+     * them through `tool_ids` instead — re-sending their definitions creates an inline
+     * duplicate (rejected with error code 10015 when the type allows only one instance
+     * per assistant).
+     */
+    shared?: boolean;
 }
 export declare namespace InferenceEmbeddingWebhookToolParams {
     interface Webhook {
@@ -1921,10 +2068,10 @@ export type ObservabilityStatus = 'enabled' | 'disabled';
 /**
  * Configuration for post-conversation processing. When enabled, the assistant
  * receives one additional LLM turn after the conversation ends, allowing it to
- * execute tool calls such as logging to a CRM or sending a summary. The assistant
- * can execute multiple parallel or sequential tools during this phase.
- * Telephony-control tools (e.g. hangup, transfer) are unavailable
- * post-conversation. Beta feature.
+ * execute final tool calls such as sending a summary or updating a record via
+ * webhook or function tools. Integration and MCP server tools are not available
+ * post-conversation; call-control tools (e.g. hangup, transfer) are also
+ * unavailable. Beta feature.
  */
 export interface PostConversationSettings {
     /**
@@ -1937,10 +2084,10 @@ export interface PostConversationSettings {
 /**
  * Configuration for post-conversation processing. When enabled, the assistant
  * receives one additional LLM turn after the conversation ends, allowing it to
- * execute tool calls such as logging to a CRM or sending a summary. The assistant
- * can execute multiple parallel or sequential tools during this phase.
- * Telephony-control tools (e.g. hangup, transfer) are unavailable
- * post-conversation. Beta feature.
+ * execute final tool calls such as sending a summary or updating a record via
+ * webhook or function tools. Integration and MCP server tools are not available
+ * post-conversation; call-control tools (e.g. hangup, transfer) are also
+ * unavailable. Beta feature.
  */
 export interface PostConversationSettingsReq {
     /**
@@ -1960,6 +2107,21 @@ export interface PrivacySettings {
      * force regardless of your selection here.
      */
     data_retention?: boolean;
+    /**
+     * Requires every model call made for a web chat turn to be received and served
+     * inside your organization's data-locality region, rather than only stored there.
+     * Applies to web chat only — voice and messaging assistants are unaffected.
+     * Enabling it requires a data-locality region with in-region inference (USA, EU,
+     * AUS, UAE; see
+     * [Inference regions](https://developers.telnyx.com/docs/inference/models/regions))
+     * and Telnyx-hosted models for the assistant, its fallback, and any
+     * conversation-flow node that overrides the model; the request is rejected
+     * otherwise. Once enabled, send chat requests to your region's API hostname: a
+     * request entering the platform in another region is rejected rather than
+     * forwarded, because forwarding it would already have moved the content across the
+     * border. Defaults to false.
+     */
+    in_transit_data_locality?: boolean;
 }
 /**
  * Whether to auto-publish the assistant's instructions as a Langfuse prompt.
@@ -1972,6 +2134,16 @@ export type PromptSyncStatus = 'enabled' | 'disabled';
 export interface RetrievalTool {
     retrieval: ChatAPI.BucketIDs;
     type: 'retrieval';
+    /**
+     * Whether this tool comes from the shared Tools Library. Responses merge shared
+     * tools into `tools` with `shared: true`; inline tools carry `shared: false`.
+     * Read-only: set by the server, not accepted in requests. When updating an
+     * assistant, omit `shared: true` tools from the request `tools` array and manage
+     * them through `tool_ids` instead — re-sending their definitions creates an inline
+     * duplicate (rejected with error code 10015 when the type allows only one instance
+     * per assistant).
+     */
+    shared?: boolean;
 }
 /**
  * A standalone scripted-message step in a flow, as returned by the API.
@@ -2084,13 +2256,16 @@ export interface TelephonySettings {
      */
     fallback_destination?: string;
     /**
-     * The noise suppression engine to use. Use 'disabled' to turn off noise
-     * suppression.
+     * The noise suppression engine to use. 'aicoustics' is STT-optimized and
+     * recommended for AI assistants (configure through noise_suppression_config). Use
+     * 'disabled' to turn off noise suppression.
      */
-    noise_suppression?: 'krisp' | 'deepfilternet' | 'disabled';
+    noise_suppression?: 'aicoustics' | 'krisp' | 'deepfilternet' | 'disabled';
     /**
-     * Configuration for noise suppression. Only applicable when noise_suppression is
-     * 'deepfilternet'.
+     * Configuration for noise suppression. Applicable fields depend on the engine:
+     * 'attenuation_limit' and 'mode' only when noise_suppression is 'deepfilternet';
+     * 'family', 'size' and 'enhancement_level' only when noise_suppression is
+     * 'aicoustics'.
      */
     noise_suppression_config?: TelephonySettings.NoiseSuppressionConfig;
     /**
@@ -2146,18 +2321,38 @@ export interface TelephonySettings {
 }
 export declare namespace TelephonySettings {
     /**
-     * Configuration for noise suppression. Only applicable when noise_suppression is
-     * 'deepfilternet'.
+     * Configuration for noise suppression. Applicable fields depend on the engine:
+     * 'attenuation_limit' and 'mode' only when noise_suppression is 'deepfilternet';
+     * 'family', 'size' and 'enhancement_level' only when noise_suppression is
+     * 'aicoustics'.
      */
     interface NoiseSuppressionConfig {
         /**
-         * Attenuation limit for noise suppression. Range: 0-100.
+         * Attenuation limit for noise suppression. Range: 0-100. Only applicable when
+         * noise_suppression is 'deepfilternet'.
          */
         attenuation_limit?: number;
         /**
-         * Mode for noise suppression configuration.
+         * AiCoustics enhancement intensity. Range: 0-1. Only applicable when
+         * noise_suppression is 'aicoustics'.
+         */
+        enhancement_level?: number;
+        /**
+         * AiCoustics model family optimized for Voice AI and STT. Only applicable when
+         * noise_suppression is 'aicoustics'.
+         */
+        family?: 'quail';
+        /**
+         * Mode for noise suppression configuration. Only applicable when noise_suppression
+         * is 'deepfilternet'.
          */
         mode?: 'advanced';
+        /**
+         * AiCoustics model size. 'vf' tracks the latest model release; 'vf_2_0_l' is
+         * pinned to version 2.0 for consistent, predictable behavior. Only applicable when
+         * noise_suppression is 'aicoustics'.
+         */
+        size?: 'vf' | 'vf_2_0_l';
     }
     /**
      * Configuration for call recording format and channel settings.
@@ -2366,21 +2561,24 @@ export interface TranscriptionSettings {
      * - `deepgram/nova-3` is multilingual with automatic language detection.
      * - `deepgram/nova-2` is Deepgram's previous-generation multilingual model.
      * - `azure/fast` is a multilingual Azure transcription model.
-     * - `assemblyai/universal-streaming` is a multilingual streaming model with
-     *   configurable turn detection.
+     * - `assemblyai/universal-3-5-pro` is a multilingual streaming model with
+     *   configurable turn detection. The legacy alias `assemblyai/universal-streaming`
+     *   is still accepted and resolves to the same model.
      * - `xai/grok-stt` is a multilingual Grok STT model.
      * - `soniox/stt-rt-v4` and `soniox/stt-rt-v5` are multilingual streaming models
      *   with automatic language detection, configurable endpointing, term biasing
      *   (`context`), and `language_hints`.
      * - `nvidia/parakeet-v3` is a multilingual transcription model with automatic
      *   language detection.
+     * - `omi-health/omi-med-stt-v1` is an English-only medical transcription model
+     *   (Parakeet-based).
      * - `humain/realtime` is a streaming model with native Arabic and Arabic/English
      *   code-switching support.
      * - `reson8/turns` is a turn-based streaming model covering 10 European languages
      *   with automatic language detection.
      * - `cohere/ar-stt` is a non-streaming Arabic and English transcription model.
      */
-    model?: 'deepgram/flux' | 'deepgram/nova-3' | 'deepgram/nova-2' | 'azure/fast' | 'assemblyai/universal-streaming' | 'xai/grok-stt' | 'soniox/stt-rt-v4' | 'soniox/stt-rt-v5' | 'nvidia/parakeet-v3' | 'humain/realtime' | 'reson8/turns' | 'cohere/ar-stt' | 'distil-whisper/distil-large-v2' | 'openai/whisper-large-v3-turbo';
+    model?: 'deepgram/flux' | 'deepgram/nova-3' | 'deepgram/nova-2' | 'azure/fast' | 'assemblyai/universal-3-5-pro' | 'assemblyai/universal-streaming' | 'xai/grok-stt' | 'soniox/stt-rt-v4' | 'soniox/stt-rt-v5' | 'nvidia/parakeet-v3' | 'omi-health/omi-med-stt-v1' | 'humain/realtime' | 'reson8/turns' | 'cohere/ar-stt' | 'distil-whisper/distil-large-v2' | 'openai/whisper-large-v3-turbo';
     /**
      * Region on third party cloud providers (currently Azure) if using one of their
      * models. Some regions require `api_key_ref`.
@@ -2412,9 +2610,9 @@ export interface TranscriptionSettingsConfig {
      */
     enable_endpoint_detection?: boolean;
     /**
-     * Available only for assemblyai/universal-streaming. Confidence level required to
-     * trigger an end of turn. Higher values require more certainty before ending a
-     * turn.
+     * Available only for assemblyai/universal-3-5-pro (and its legacy alias
+     * assemblyai/universal-streaming). Confidence level required to trigger an end of
+     * turn. Higher values require more certainty before ending a turn.
      */
     end_of_turn_confidence_threshold?: number;
     /**
@@ -2455,14 +2653,15 @@ export interface TranscriptionSettingsConfig {
      */
     max_endpoint_delay_ms?: number;
     /**
-     * Available only for assemblyai/universal-streaming. Maximum duration of silence
-     * in milliseconds before forcing an end of turn.
+     * Available only for assemblyai/universal-3-5-pro (and its legacy alias
+     * assemblyai/universal-streaming). Maximum duration of silence in milliseconds
+     * before forcing an end of turn.
      */
     max_turn_silence?: number;
     /**
-     * Available only for assemblyai/universal-streaming. Minimum duration of silence
-     * in milliseconds before a turn can end. Must be less than or equal to
-     * max_turn_silence.
+     * Available only for assemblyai/universal-3-5-pro (and its legacy alias
+     * assemblyai/universal-streaming). Minimum duration of silence in milliseconds
+     * before a turn can end. Must be less than or equal to max_turn_silence.
      */
     min_turn_silence?: number;
     numerals?: boolean;
@@ -2934,10 +3133,10 @@ export interface AssistantCreateParams {
     /**
      * Body param: Configuration for post-conversation processing. When enabled, the
      * assistant receives one additional LLM turn after the conversation ends, allowing
-     * it to execute tool calls such as logging to a CRM or sending a summary. The
-     * assistant can execute multiple parallel or sequential tools during this phase.
-     * Telephony-control tools (e.g. hangup, transfer) are unavailable
-     * post-conversation. Beta feature.
+     * it to execute final tool calls such as sending a summary or updating a record
+     * via webhook or function tools. Integration and MCP server tools are not
+     * available post-conversation; call-control tools (e.g. hangup, transfer) are also
+     * unavailable. Beta feature.
      */
     post_conversation_settings?: PostConversationSettingsReq;
     /**
@@ -3142,10 +3341,10 @@ export interface AssistantUpdateParams {
     /**
      * Configuration for post-conversation processing. When enabled, the assistant
      * receives one additional LLM turn after the conversation ends, allowing it to
-     * execute tool calls such as logging to a CRM or sending a summary. The assistant
-     * can execute multiple parallel or sequential tools during this phase.
-     * Telephony-control tools (e.g. hangup, transfer) are unavailable
-     * post-conversation. Beta feature.
+     * execute final tool calls such as sending a summary or updating a record via
+     * webhook or function tools. Integration and MCP server tools are not available
+     * post-conversation; call-control tools (e.g. hangup, transfer) are also
+     * unavailable. Beta feature.
      */
     post_conversation_settings?: PostConversationSettingsReq;
     privacy_settings?: PrivacySettings;
@@ -3162,13 +3361,24 @@ export interface AssistantUpdateParams {
     telephony_settings?: TelephonySettings;
     /**
      * IDs of shared tools to attach to the assistant. New integrations should prefer
-     * `tool_ids` over inline `tools`.
+     * `tool_ids` over inline `tools`. On update, a sent `tool_ids` array fully
+     * replaces the assistant's attached shared tools; omit the field to leave them
+     * unchanged. Single-instance tool types are counted across inline `tools` and
+     * `tool_ids` combined, so attaching a shared tool of such a type when an instance
+     * already exists returns HTTP 400 with error code 10015.
      */
     tool_ids?: Array<string>;
     /**
      * Deprecated for new integrations. Inline tool definitions available to the
      * assistant. Prefer `tool_ids` to attach shared tools created with the AI Tools
-     * endpoints.
+     * endpoints. On update, a sent `tools` array fully replaces the assistant's inline
+     * tools; omit the field to leave the inline tools unchanged. Each tool type except
+     * `function`, `webhook`, and `client_side_tool` allows at most one instance per
+     * assistant, counted across inline `tools` and shared `tool_ids` combined —
+     * sending a duplicate of such a type returns HTTP 400 with error code 10015.
+     * Responses merge shared tools into `tools` with `shared: true`; when updating,
+     * omit those tools from the `tools` array and manage them through `tool_ids`
+     * instead.
      */
     tools?: Array<AssistantTool>;
     transcription?: TranscriptionSettings;