telnyx 6.64.0 → 6.65.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/CHANGELOG.md +8 -0
- package/client.d.mts +10 -11
- package/client.d.mts.map +1 -1
- package/client.d.ts +10 -11
- package/client.d.ts.map +1 -1
- package/client.js.map +1 -1
- package/client.mjs.map +1 -1
- package/package.json +1 -1
- package/resources/ai/ai.d.mts +116 -114
- package/resources/ai/ai.d.mts.map +1 -1
- package/resources/ai/ai.d.ts +116 -114
- package/resources/ai/ai.d.ts.map +1 -1
- package/resources/ai/ai.js.map +1 -1
- package/resources/ai/ai.mjs.map +1 -1
- package/resources/ai/assistants/assistants.d.mts +332 -112
- package/resources/ai/assistants/assistants.d.mts.map +1 -1
- package/resources/ai/assistants/assistants.d.ts +332 -112
- package/resources/ai/assistants/assistants.d.ts.map +1 -1
- package/resources/ai/assistants/assistants.js.map +1 -1
- package/resources/ai/assistants/assistants.mjs.map +1 -1
- package/resources/ai/assistants/canary-deploys.d.mts +241 -70
- package/resources/ai/assistants/canary-deploys.d.mts.map +1 -1
- package/resources/ai/assistants/canary-deploys.d.ts +241 -70
- package/resources/ai/assistants/canary-deploys.d.ts.map +1 -1
- package/resources/ai/assistants/index.d.mts +2 -2
- package/resources/ai/assistants/index.d.mts.map +1 -1
- package/resources/ai/assistants/index.d.ts +2 -2
- package/resources/ai/assistants/index.d.ts.map +1 -1
- package/resources/ai/assistants/index.js.map +1 -1
- package/resources/ai/assistants/index.mjs.map +1 -1
- package/resources/ai/assistants/versions.d.mts +220 -6
- package/resources/ai/assistants/versions.d.mts.map +1 -1
- package/resources/ai/assistants/versions.d.ts +220 -6
- package/resources/ai/assistants/versions.d.ts.map +1 -1
- package/resources/ai/index.d.mts +2 -2
- package/resources/ai/index.d.mts.map +1 -1
- package/resources/ai/index.d.ts +2 -2
- package/resources/ai/index.d.ts.map +1 -1
- package/resources/ai/index.js.map +1 -1
- package/resources/ai/index.mjs.map +1 -1
- package/resources/ai/openai/openai.d.mts +113 -2
- package/resources/ai/openai/openai.d.mts.map +1 -1
- package/resources/ai/openai/openai.d.ts +113 -2
- package/resources/ai/openai/openai.d.ts.map +1 -1
- package/resources/ai/openai/openai.js.map +1 -1
- package/resources/ai/openai/openai.mjs.map +1 -1
- package/resources/calls/actions.d.mts +398 -41
- package/resources/calls/actions.d.mts.map +1 -1
- package/resources/calls/actions.d.ts +398 -41
- package/resources/calls/actions.d.ts.map +1 -1
- package/resources/calls/actions.js +46 -0
- package/resources/calls/actions.js.map +1 -1
- package/resources/calls/actions.mjs +46 -0
- package/resources/calls/actions.mjs.map +1 -1
- package/resources/calls/calls.d.mts +2 -2
- package/resources/calls/calls.d.mts.map +1 -1
- package/resources/calls/calls.d.ts +2 -2
- package/resources/calls/calls.d.ts.map +1 -1
- package/resources/calls/calls.js.map +1 -1
- package/resources/calls/calls.mjs.map +1 -1
- package/resources/calls/index.d.mts +1 -1
- package/resources/calls/index.d.mts.map +1 -1
- package/resources/calls/index.d.ts +1 -1
- package/resources/calls/index.d.ts.map +1 -1
- package/resources/calls/index.js.map +1 -1
- package/resources/calls/index.mjs.map +1 -1
- package/resources/conferences/actions.d.mts +11 -1
- package/resources/conferences/actions.d.mts.map +1 -1
- package/resources/conferences/actions.d.ts +11 -1
- package/resources/conferences/actions.d.ts.map +1 -1
- package/resources/index.d.mts +5 -5
- package/resources/index.d.mts.map +1 -1
- package/resources/index.d.ts +5 -5
- package/resources/index.d.ts.map +1 -1
- package/resources/index.js.map +1 -1
- package/resources/index.mjs.map +1 -1
- package/resources/networks/networks.d.mts +2 -25
- package/resources/networks/networks.d.mts.map +1 -1
- package/resources/networks/networks.d.ts +2 -25
- package/resources/networks/networks.d.ts.map +1 -1
- package/resources/networks/networks.js.map +1 -1
- package/resources/networks/networks.mjs.map +1 -1
- package/resources/public-internet-gateways.d.mts +50 -40
- package/resources/public-internet-gateways.d.mts.map +1 -1
- package/resources/public-internet-gateways.d.ts +50 -40
- package/resources/public-internet-gateways.d.ts.map +1 -1
- package/resources/public-internet-gateways.js +1 -1
- package/resources/public-internet-gateways.js.map +1 -1
- package/resources/public-internet-gateways.mjs +1 -1
- package/resources/public-internet-gateways.mjs.map +1 -1
- package/resources/shared.d.mts +0 -10
- package/resources/shared.d.mts.map +1 -1
- package/resources/shared.d.ts +0 -10
- package/resources/shared.d.ts.map +1 -1
- package/resources/uac-connections/index.d.mts +1 -1
- package/resources/uac-connections/index.d.mts.map +1 -1
- package/resources/uac-connections/index.d.ts +1 -1
- package/resources/uac-connections/index.d.ts.map +1 -1
- package/resources/uac-connections/index.js.map +1 -1
- package/resources/uac-connections/index.mjs.map +1 -1
- package/resources/uac-connections/uac-connections.d.mts +1861 -211
- package/resources/uac-connections/uac-connections.d.mts.map +1 -1
- package/resources/uac-connections/uac-connections.d.ts +1861 -211
- package/resources/uac-connections/uac-connections.d.ts.map +1 -1
- package/resources/uac-connections/uac-connections.js +1 -1
- package/resources/uac-connections/uac-connections.js.map +1 -1
- package/resources/uac-connections/uac-connections.mjs +1 -1
- package/resources/uac-connections/uac-connections.mjs.map +1 -1
- package/resources/virtual-cross-connects.d.mts +504 -48
- package/resources/virtual-cross-connects.d.mts.map +1 -1
- package/resources/virtual-cross-connects.d.ts +504 -48
- package/resources/virtual-cross-connects.d.ts.map +1 -1
- package/resources/virtual-cross-connects.js +1 -1
- package/resources/virtual-cross-connects.js.map +1 -1
- package/resources/virtual-cross-connects.mjs +1 -1
- package/resources/virtual-cross-connects.mjs.map +1 -1
- package/resources/wireguard-interfaces.d.mts +127 -43
- package/resources/wireguard-interfaces.d.mts.map +1 -1
- package/resources/wireguard-interfaces.d.ts +127 -43
- package/resources/wireguard-interfaces.d.ts.map +1 -1
- package/resources/wireguard-interfaces.js +2 -5
- package/resources/wireguard-interfaces.js.map +1 -1
- package/resources/wireguard-interfaces.mjs +2 -5
- package/resources/wireguard-interfaces.mjs.map +1 -1
- package/src/client.ts +16 -27
- package/src/resources/ai/ai.ts +130 -139
- package/src/resources/ai/assistants/assistants.ts +362 -133
- package/src/resources/ai/assistants/canary-deploys.ts +266 -75
- package/src/resources/ai/assistants/index.ts +0 -10
- package/src/resources/ai/assistants/versions.ts +244 -6
- package/src/resources/ai/index.ts +0 -6
- package/src/resources/ai/openai/openai.ts +131 -2
- package/src/resources/calls/actions.ts +543 -76
- package/src/resources/calls/calls.ts +8 -4
- package/src/resources/calls/index.ts +4 -2
- package/src/resources/conferences/actions.ts +13 -1
- package/src/resources/index.ts +8 -13
- package/src/resources/networks/networks.ts +4 -31
- package/src/resources/public-internet-gateways.ts +55 -46
- package/src/resources/shared.ts +0 -12
- package/src/resources/uac-connections/index.ts +2 -6
- package/src/resources/uac-connections/uac-connections.ts +2377 -378
- package/src/resources/virtual-cross-connects.ts +595 -54
- package/src/resources/wireguard-interfaces.ts +158 -53
- package/src/version.ts +1 -1
- package/version.d.mts +1 -1
- package/version.d.ts +1 -1
- package/version.js +1 -1
- package/version.mjs +1 -1
|
@@ -10,11 +10,6 @@ import {
|
|
|
10
10
|
CanaryDeployResponse,
|
|
11
11
|
CanaryDeployUpdateParams,
|
|
12
12
|
CanaryDeploys,
|
|
13
|
-
Clause,
|
|
14
|
-
RolloutSlot,
|
|
15
|
-
RuleInput,
|
|
16
|
-
RuleOutput,
|
|
17
|
-
Serve,
|
|
18
13
|
} from './canary-deploys';
|
|
19
14
|
import * as ScheduledEventsAPI from './scheduled-events';
|
|
20
15
|
import {
|
|
@@ -300,47 +295,6 @@ export interface Assistant {
|
|
|
300
295
|
>;
|
|
301
296
|
}
|
|
302
297
|
|
|
303
|
-
/**
|
|
304
|
-
* Reference to a connected integration attached to an assistant. Discover
|
|
305
|
-
* available integrations with `/ai/integrations` and connected integrations with
|
|
306
|
-
* `/ai/integrations/connections`.
|
|
307
|
-
*/
|
|
308
|
-
export interface AssistantIntegration {
|
|
309
|
-
/**
|
|
310
|
-
* Catalog integration ID to attach. This is the `id` from the integrations catalog
|
|
311
|
-
* at `/ai/integrations` (the same value also appears as `integration_id` on
|
|
312
|
-
* entries returned by `/ai/integrations/connections`). It is **not** the
|
|
313
|
-
* connection-level `id` from `/ai/integrations/connections`.
|
|
314
|
-
*/
|
|
315
|
-
integration_id: string;
|
|
316
|
-
|
|
317
|
-
/**
|
|
318
|
-
* Optional per-assistant allowlist of integration tool names. When omitted or
|
|
319
|
-
* empty, all tools allowed by the connected integration are available to the
|
|
320
|
-
* assistant.
|
|
321
|
-
*/
|
|
322
|
-
allowed_list?: Array<string>;
|
|
323
|
-
}
|
|
324
|
-
|
|
325
|
-
/**
|
|
326
|
-
* Reference to an MCP server attached to an assistant. Create and manage MCP
|
|
327
|
-
* servers with the `/ai/mcp_servers` endpoints, then attach them to assistants by
|
|
328
|
-
* ID.
|
|
329
|
-
*/
|
|
330
|
-
export interface AssistantMcpServer {
|
|
331
|
-
/**
|
|
332
|
-
* ID of the MCP server to attach. This must be the `id` of an MCP server returned
|
|
333
|
-
* by the `/ai/mcp_servers` endpoints.
|
|
334
|
-
*/
|
|
335
|
-
id: string;
|
|
336
|
-
|
|
337
|
-
/**
|
|
338
|
-
* Optional per-assistant allowlist of MCP tool names. When omitted, the assistant
|
|
339
|
-
* uses the MCP server's configured `allowed_tools`.
|
|
340
|
-
*/
|
|
341
|
-
allowed_tools?: Array<string>;
|
|
342
|
-
}
|
|
343
|
-
|
|
344
298
|
/**
|
|
345
299
|
* The handoff tool allows the assistant to hand off control of the conversation to
|
|
346
300
|
* another AI assistant. By default, this will happen transparently to the end
|
|
@@ -420,7 +374,7 @@ export namespace AssistantTool {
|
|
|
420
374
|
* variable string like `{{ targets }}` where `targets` is returned by the dynamic
|
|
421
375
|
* variables webhook and resolves to an array of target objects at runtime.
|
|
422
376
|
*/
|
|
423
|
-
targets: Array<Transfer.
|
|
377
|
+
targets: Array<Transfer.UnionMember0> | string;
|
|
424
378
|
|
|
425
379
|
/**
|
|
426
380
|
* Custom headers to be added to the SIP INVITE for the transfer command.
|
|
@@ -450,7 +404,7 @@ export namespace AssistantTool {
|
|
|
450
404
|
}
|
|
451
405
|
|
|
452
406
|
export namespace Transfer {
|
|
453
|
-
export interface
|
|
407
|
+
export interface UnionMember0 {
|
|
454
408
|
/**
|
|
455
409
|
* The destination number or SIP URI of the call.
|
|
456
410
|
*/
|
|
@@ -627,7 +581,7 @@ export namespace AssistantTool {
|
|
|
627
581
|
* omitted or null, the invite tool can still be configured and targets may be
|
|
628
582
|
* supplied dynamically at runtime.
|
|
629
583
|
*/
|
|
630
|
-
targets?: Array<Invite.
|
|
584
|
+
targets?: Array<Invite.UnionMember0> | string | null;
|
|
631
585
|
|
|
632
586
|
/**
|
|
633
587
|
* Configuration for voicemail detection (AMD - Answering Machine Detection) on the
|
|
@@ -649,7 +603,7 @@ export namespace AssistantTool {
|
|
|
649
603
|
value?: string;
|
|
650
604
|
}
|
|
651
605
|
|
|
652
|
-
export interface
|
|
606
|
+
export interface UnionMember0 {
|
|
653
607
|
/**
|
|
654
608
|
* The destination number or SIP URI of the call.
|
|
655
609
|
*/
|
|
@@ -1057,7 +1011,7 @@ export interface InferenceEmbedding {
|
|
|
1057
1011
|
* `/ai/integrations/connections`. Each item references a catalog integration by
|
|
1058
1012
|
* `integration_id`.
|
|
1059
1013
|
*/
|
|
1060
|
-
integrations?: Array<
|
|
1014
|
+
integrations?: Array<InferenceEmbedding.Integration>;
|
|
1061
1015
|
|
|
1062
1016
|
/**
|
|
1063
1017
|
* Settings for interruptions and how the assistant decides the user has finished
|
|
@@ -1067,7 +1021,7 @@ export interface InferenceEmbedding {
|
|
|
1067
1021
|
* `transcription.settings` (`eot_threshold`, `eot_timeout_ms`,
|
|
1068
1022
|
* `eager_eot_threshold`).
|
|
1069
1023
|
*/
|
|
1070
|
-
interruption_settings?:
|
|
1024
|
+
interruption_settings?: InferenceEmbedding.InterruptionSettings;
|
|
1071
1025
|
|
|
1072
1026
|
/**
|
|
1073
1027
|
* This is only needed when using third-party inference providers selected by
|
|
@@ -1083,7 +1037,7 @@ export interface InferenceEmbedding {
|
|
|
1083
1037
|
* MCP servers attached to the assistant. Create MCP servers with
|
|
1084
1038
|
* `/ai/mcp_servers`, then reference them by `id` here.
|
|
1085
1039
|
*/
|
|
1086
|
-
mcp_servers?: Array<
|
|
1040
|
+
mcp_servers?: Array<InferenceEmbedding.McpServer>;
|
|
1087
1041
|
|
|
1088
1042
|
messaging_settings?: MessagingSettings;
|
|
1089
1043
|
|
|
@@ -1147,32 +1101,123 @@ export interface InferenceEmbedding {
|
|
|
1147
1101
|
widget_settings?: WidgetSettings;
|
|
1148
1102
|
}
|
|
1149
1103
|
|
|
1150
|
-
|
|
1151
|
-
* Settings for interruptions and how the assistant decides the user has finished
|
|
1152
|
-
* speaking. These timings are most relevant when using non turn-taking
|
|
1153
|
-
* transcription models. For turn-taking models like `deepgram/flux`, end-of-turn
|
|
1154
|
-
* behavior is controlled by the transcription end-of-turn settings under
|
|
1155
|
-
* `transcription.settings` (`eot_threshold`, `eot_timeout_ms`,
|
|
1156
|
-
* `eager_eot_threshold`).
|
|
1157
|
-
*/
|
|
1158
|
-
export interface InferenceEmbeddingInterruptionSettings {
|
|
1104
|
+
export namespace InferenceEmbedding {
|
|
1159
1105
|
/**
|
|
1160
|
-
*
|
|
1106
|
+
* Reference to a connected integration attached to an assistant. Discover
|
|
1107
|
+
* available integrations with `/ai/integrations` and connected integrations with
|
|
1108
|
+
* `/ai/integrations/connections`.
|
|
1161
1109
|
*/
|
|
1162
|
-
|
|
1110
|
+
export interface Integration {
|
|
1111
|
+
/**
|
|
1112
|
+
* Catalog integration ID to attach. This is the `id` from the integrations catalog
|
|
1113
|
+
* at `/ai/integrations` (the same value also appears as `integration_id` on
|
|
1114
|
+
* entries returned by `/ai/integrations/connections`). It is **not** the
|
|
1115
|
+
* connection-level `id` from `/ai/integrations/connections`.
|
|
1116
|
+
*/
|
|
1117
|
+
integration_id: string;
|
|
1118
|
+
|
|
1119
|
+
/**
|
|
1120
|
+
* Optional per-assistant allowlist of integration tool names. When omitted or
|
|
1121
|
+
* empty, all tools allowed by the connected integration are available to the
|
|
1122
|
+
* assistant.
|
|
1123
|
+
*/
|
|
1124
|
+
allowed_list?: Array<string>;
|
|
1125
|
+
}
|
|
1163
1126
|
|
|
1164
1127
|
/**
|
|
1165
|
-
*
|
|
1128
|
+
* Settings for interruptions and how the assistant decides the user has finished
|
|
1129
|
+
* speaking. These timings are most relevant when using non turn-taking
|
|
1130
|
+
* transcription models. For turn-taking models like `deepgram/flux`, end-of-turn
|
|
1131
|
+
* behavior is controlled by the transcription end-of-turn settings under
|
|
1132
|
+
* `transcription.settings` (`eot_threshold`, `eot_timeout_ms`,
|
|
1133
|
+
* `eager_eot_threshold`).
|
|
1166
1134
|
*/
|
|
1167
|
-
|
|
1135
|
+
export interface InterruptionSettings {
|
|
1136
|
+
/**
|
|
1137
|
+
* When true, disables user interruptions while the assistant greeting is playing.
|
|
1138
|
+
*/
|
|
1139
|
+
disable_greeting_interruption?: boolean;
|
|
1140
|
+
|
|
1141
|
+
/**
|
|
1142
|
+
* Whether users can interrupt the assistant while it is speaking.
|
|
1143
|
+
*/
|
|
1144
|
+
enable?: boolean;
|
|
1145
|
+
|
|
1146
|
+
/**
|
|
1147
|
+
* Controls when the assistant starts speaking after the user stops. These
|
|
1148
|
+
* thresholds primarily apply to non turn-taking transcription models. For
|
|
1149
|
+
* turn-taking models like `deepgram/flux`, end-of-turn detection is driven by the
|
|
1150
|
+
* transcription end-of-turn settings under `transcription.settings` instead.
|
|
1151
|
+
*/
|
|
1152
|
+
start_speaking_plan?: InterruptionSettings.StartSpeakingPlan;
|
|
1153
|
+
}
|
|
1154
|
+
|
|
1155
|
+
export namespace InterruptionSettings {
|
|
1156
|
+
/**
|
|
1157
|
+
* Controls when the assistant starts speaking after the user stops. These
|
|
1158
|
+
* thresholds primarily apply to non turn-taking transcription models. For
|
|
1159
|
+
* turn-taking models like `deepgram/flux`, end-of-turn detection is driven by the
|
|
1160
|
+
* transcription end-of-turn settings under `transcription.settings` instead.
|
|
1161
|
+
*/
|
|
1162
|
+
export interface StartSpeakingPlan {
|
|
1163
|
+
/**
|
|
1164
|
+
* Endpointing thresholds used to decide when the user has finished speaking.
|
|
1165
|
+
* Applies to non turn-taking transcription models. For `deepgram/flux`, use
|
|
1166
|
+
* `transcription.settings.eot_threshold` / `eot_timeout_ms` /
|
|
1167
|
+
* `eager_eot_threshold`.
|
|
1168
|
+
*/
|
|
1169
|
+
transcription_endpointing_plan?: StartSpeakingPlan.TranscriptionEndpointingPlan;
|
|
1170
|
+
|
|
1171
|
+
/**
|
|
1172
|
+
* Minimum seconds to wait before the assistant starts speaking.
|
|
1173
|
+
*/
|
|
1174
|
+
wait_seconds?: number;
|
|
1175
|
+
}
|
|
1176
|
+
|
|
1177
|
+
export namespace StartSpeakingPlan {
|
|
1178
|
+
/**
|
|
1179
|
+
* Endpointing thresholds used to decide when the user has finished speaking.
|
|
1180
|
+
* Applies to non turn-taking transcription models. For `deepgram/flux`, use
|
|
1181
|
+
* `transcription.settings.eot_threshold` / `eot_timeout_ms` /
|
|
1182
|
+
* `eager_eot_threshold`.
|
|
1183
|
+
*/
|
|
1184
|
+
export interface TranscriptionEndpointingPlan {
|
|
1185
|
+
/**
|
|
1186
|
+
* Seconds to wait after the transcript ends without punctuation.
|
|
1187
|
+
*/
|
|
1188
|
+
on_no_punctuation_seconds?: number;
|
|
1189
|
+
|
|
1190
|
+
/**
|
|
1191
|
+
* Seconds to wait after the transcript ends with a number.
|
|
1192
|
+
*/
|
|
1193
|
+
on_number_seconds?: number;
|
|
1194
|
+
|
|
1195
|
+
/**
|
|
1196
|
+
* Seconds to wait after the transcript ends with punctuation.
|
|
1197
|
+
*/
|
|
1198
|
+
on_punctuation_seconds?: number;
|
|
1199
|
+
}
|
|
1200
|
+
}
|
|
1201
|
+
}
|
|
1168
1202
|
|
|
1169
1203
|
/**
|
|
1170
|
-
*
|
|
1171
|
-
*
|
|
1172
|
-
*
|
|
1173
|
-
* transcription end-of-turn settings under `transcription.settings` instead.
|
|
1204
|
+
* Reference to an MCP server attached to an assistant. Create and manage MCP
|
|
1205
|
+
* servers with the `/ai/mcp_servers` endpoints, then attach them to assistants by
|
|
1206
|
+
* ID.
|
|
1174
1207
|
*/
|
|
1175
|
-
|
|
1208
|
+
export interface McpServer {
|
|
1209
|
+
/**
|
|
1210
|
+
* ID of the MCP server to attach. This must be the `id` of an MCP server returned
|
|
1211
|
+
* by the `/ai/mcp_servers` endpoints.
|
|
1212
|
+
*/
|
|
1213
|
+
id: string;
|
|
1214
|
+
|
|
1215
|
+
/**
|
|
1216
|
+
* Optional per-assistant allowlist of MCP tool names. When omitted, the assistant
|
|
1217
|
+
* uses the MCP server's configured `allowed_tools`.
|
|
1218
|
+
*/
|
|
1219
|
+
allowed_tools?: Array<string>;
|
|
1220
|
+
}
|
|
1176
1221
|
}
|
|
1177
1222
|
|
|
1178
1223
|
export interface InferenceEmbeddingWebhookToolParams {
|
|
@@ -1479,27 +1524,6 @@ export interface RetrievalTool {
|
|
|
1479
1524
|
type: 'retrieval';
|
|
1480
1525
|
}
|
|
1481
1526
|
|
|
1482
|
-
/**
|
|
1483
|
-
* Controls when the assistant starts speaking after the user stops. These
|
|
1484
|
-
* thresholds primarily apply to non turn-taking transcription models. For
|
|
1485
|
-
* turn-taking models like `deepgram/flux`, end-of-turn detection is driven by the
|
|
1486
|
-
* transcription end-of-turn settings under `transcription.settings` instead.
|
|
1487
|
-
*/
|
|
1488
|
-
export interface StartSpeakingPlan {
|
|
1489
|
-
/**
|
|
1490
|
-
* Endpointing thresholds used to decide when the user has finished speaking.
|
|
1491
|
-
* Applies to non turn-taking transcription models. For `deepgram/flux`, use
|
|
1492
|
-
* `transcription.settings.eot_threshold` / `eot_timeout_ms` /
|
|
1493
|
-
* `eager_eot_threshold`.
|
|
1494
|
-
*/
|
|
1495
|
-
transcription_endpointing_plan?: TranscriptionEndpointingPlan;
|
|
1496
|
-
|
|
1497
|
-
/**
|
|
1498
|
-
* Minimum seconds to wait before the assistant starts speaking.
|
|
1499
|
-
*/
|
|
1500
|
-
wait_seconds?: number;
|
|
1501
|
-
}
|
|
1502
|
-
|
|
1503
1527
|
export interface TelephonySettings {
|
|
1504
1528
|
/**
|
|
1505
1529
|
* Default Texml App used for voice calls with your assistant. This will be created
|
|
@@ -1663,29 +1687,6 @@ export namespace TelephonySettings {
|
|
|
1663
1687
|
}
|
|
1664
1688
|
}
|
|
1665
1689
|
|
|
1666
|
-
/**
|
|
1667
|
-
* Endpointing thresholds used to decide when the user has finished speaking.
|
|
1668
|
-
* Applies to non turn-taking transcription models. For `deepgram/flux`, use
|
|
1669
|
-
* `transcription.settings.eot_threshold` / `eot_timeout_ms` /
|
|
1670
|
-
* `eager_eot_threshold`.
|
|
1671
|
-
*/
|
|
1672
|
-
export interface TranscriptionEndpointingPlan {
|
|
1673
|
-
/**
|
|
1674
|
-
* Seconds to wait after the transcript ends without punctuation.
|
|
1675
|
-
*/
|
|
1676
|
-
on_no_punctuation_seconds?: number;
|
|
1677
|
-
|
|
1678
|
-
/**
|
|
1679
|
-
* Seconds to wait after the transcript ends with a number.
|
|
1680
|
-
*/
|
|
1681
|
-
on_number_seconds?: number;
|
|
1682
|
-
|
|
1683
|
-
/**
|
|
1684
|
-
* Seconds to wait after the transcript ends with punctuation.
|
|
1685
|
-
*/
|
|
1686
|
-
on_punctuation_seconds?: number;
|
|
1687
|
-
}
|
|
1688
|
-
|
|
1689
1690
|
export interface TranscriptionSettings {
|
|
1690
1691
|
/**
|
|
1691
1692
|
* Integration secret identifier for the transcription provider API key. Currently
|
|
@@ -1808,11 +1809,11 @@ export namespace TransferTool {
|
|
|
1808
1809
|
* variable string like `{{ targets }}` where `targets` is returned by the dynamic
|
|
1809
1810
|
* variables webhook and resolves to an array of target objects at runtime.
|
|
1810
1811
|
*/
|
|
1811
|
-
targets: Array<Transfer.
|
|
1812
|
+
targets: Array<Transfer.UnionMember0> | string;
|
|
1812
1813
|
}
|
|
1813
1814
|
|
|
1814
1815
|
export namespace Transfer {
|
|
1815
|
-
export interface
|
|
1816
|
+
export interface UnionMember0 {
|
|
1816
1817
|
/**
|
|
1817
1818
|
* The destination number or SIP URI of the call.
|
|
1818
1819
|
*/
|
|
@@ -2275,7 +2276,7 @@ export interface AssistantCreateParams {
|
|
|
2275
2276
|
* `/ai/integrations/connections`. Each item references a catalog integration by
|
|
2276
2277
|
* `integration_id`.
|
|
2277
2278
|
*/
|
|
2278
|
-
integrations?: Array<
|
|
2279
|
+
integrations?: Array<AssistantCreateParams.Integration>;
|
|
2279
2280
|
|
|
2280
2281
|
/**
|
|
2281
2282
|
* Settings for interruptions and how the assistant decides the user has finished
|
|
@@ -2285,7 +2286,7 @@ export interface AssistantCreateParams {
|
|
|
2285
2286
|
* `transcription.settings` (`eot_threshold`, `eot_timeout_ms`,
|
|
2286
2287
|
* `eager_eot_threshold`).
|
|
2287
2288
|
*/
|
|
2288
|
-
interruption_settings?:
|
|
2289
|
+
interruption_settings?: AssistantCreateParams.InterruptionSettings;
|
|
2289
2290
|
|
|
2290
2291
|
/**
|
|
2291
2292
|
* This is only needed when using third-party inference providers selected by
|
|
@@ -2301,7 +2302,7 @@ export interface AssistantCreateParams {
|
|
|
2301
2302
|
* MCP servers attached to the assistant. Create MCP servers with
|
|
2302
2303
|
* `/ai/mcp_servers`, then reference them by `id` here.
|
|
2303
2304
|
*/
|
|
2304
|
-
mcp_servers?: Array<
|
|
2305
|
+
mcp_servers?: Array<AssistantCreateParams.McpServer>;
|
|
2305
2306
|
|
|
2306
2307
|
messaging_settings?: MessagingSettings;
|
|
2307
2308
|
|
|
@@ -2359,6 +2360,125 @@ export interface AssistantCreateParams {
|
|
|
2359
2360
|
widget_settings?: WidgetSettings;
|
|
2360
2361
|
}
|
|
2361
2362
|
|
|
2363
|
+
export namespace AssistantCreateParams {
|
|
2364
|
+
/**
|
|
2365
|
+
* Reference to a connected integration attached to an assistant. Discover
|
|
2366
|
+
* available integrations with `/ai/integrations` and connected integrations with
|
|
2367
|
+
* `/ai/integrations/connections`.
|
|
2368
|
+
*/
|
|
2369
|
+
export interface Integration {
|
|
2370
|
+
/**
|
|
2371
|
+
* Catalog integration ID to attach. This is the `id` from the integrations catalog
|
|
2372
|
+
* at `/ai/integrations` (the same value also appears as `integration_id` on
|
|
2373
|
+
* entries returned by `/ai/integrations/connections`). It is **not** the
|
|
2374
|
+
* connection-level `id` from `/ai/integrations/connections`.
|
|
2375
|
+
*/
|
|
2376
|
+
integration_id: string;
|
|
2377
|
+
|
|
2378
|
+
/**
|
|
2379
|
+
* Optional per-assistant allowlist of integration tool names. When omitted or
|
|
2380
|
+
* empty, all tools allowed by the connected integration are available to the
|
|
2381
|
+
* assistant.
|
|
2382
|
+
*/
|
|
2383
|
+
allowed_list?: Array<string>;
|
|
2384
|
+
}
|
|
2385
|
+
|
|
2386
|
+
/**
|
|
2387
|
+
* Settings for interruptions and how the assistant decides the user has finished
|
|
2388
|
+
* speaking. These timings are most relevant when using non turn-taking
|
|
2389
|
+
* transcription models. For turn-taking models like `deepgram/flux`, end-of-turn
|
|
2390
|
+
* behavior is controlled by the transcription end-of-turn settings under
|
|
2391
|
+
* `transcription.settings` (`eot_threshold`, `eot_timeout_ms`,
|
|
2392
|
+
* `eager_eot_threshold`).
|
|
2393
|
+
*/
|
|
2394
|
+
export interface InterruptionSettings {
|
|
2395
|
+
/**
|
|
2396
|
+
* When true, disables user interruptions while the assistant greeting is playing.
|
|
2397
|
+
*/
|
|
2398
|
+
disable_greeting_interruption?: boolean;
|
|
2399
|
+
|
|
2400
|
+
/**
|
|
2401
|
+
* Whether users can interrupt the assistant while it is speaking.
|
|
2402
|
+
*/
|
|
2403
|
+
enable?: boolean;
|
|
2404
|
+
|
|
2405
|
+
/**
|
|
2406
|
+
* Controls when the assistant starts speaking after the user stops. These
|
|
2407
|
+
* thresholds primarily apply to non turn-taking transcription models. For
|
|
2408
|
+
* turn-taking models like `deepgram/flux`, end-of-turn detection is driven by the
|
|
2409
|
+
* transcription end-of-turn settings under `transcription.settings` instead.
|
|
2410
|
+
*/
|
|
2411
|
+
start_speaking_plan?: InterruptionSettings.StartSpeakingPlan;
|
|
2412
|
+
}
|
|
2413
|
+
|
|
2414
|
+
export namespace InterruptionSettings {
|
|
2415
|
+
/**
|
|
2416
|
+
* Controls when the assistant starts speaking after the user stops. These
|
|
2417
|
+
* thresholds primarily apply to non turn-taking transcription models. For
|
|
2418
|
+
* turn-taking models like `deepgram/flux`, end-of-turn detection is driven by the
|
|
2419
|
+
* transcription end-of-turn settings under `transcription.settings` instead.
|
|
2420
|
+
*/
|
|
2421
|
+
export interface StartSpeakingPlan {
|
|
2422
|
+
/**
|
|
2423
|
+
* Endpointing thresholds used to decide when the user has finished speaking.
|
|
2424
|
+
* Applies to non turn-taking transcription models. For `deepgram/flux`, use
|
|
2425
|
+
* `transcription.settings.eot_threshold` / `eot_timeout_ms` /
|
|
2426
|
+
* `eager_eot_threshold`.
|
|
2427
|
+
*/
|
|
2428
|
+
transcription_endpointing_plan?: StartSpeakingPlan.TranscriptionEndpointingPlan;
|
|
2429
|
+
|
|
2430
|
+
/**
|
|
2431
|
+
* Minimum seconds to wait before the assistant starts speaking.
|
|
2432
|
+
*/
|
|
2433
|
+
wait_seconds?: number;
|
|
2434
|
+
}
|
|
2435
|
+
|
|
2436
|
+
export namespace StartSpeakingPlan {
|
|
2437
|
+
/**
|
|
2438
|
+
* Endpointing thresholds used to decide when the user has finished speaking.
|
|
2439
|
+
* Applies to non turn-taking transcription models. For `deepgram/flux`, use
|
|
2440
|
+
* `transcription.settings.eot_threshold` / `eot_timeout_ms` /
|
|
2441
|
+
* `eager_eot_threshold`.
|
|
2442
|
+
*/
|
|
2443
|
+
export interface TranscriptionEndpointingPlan {
|
|
2444
|
+
/**
|
|
2445
|
+
* Seconds to wait after the transcript ends without punctuation.
|
|
2446
|
+
*/
|
|
2447
|
+
on_no_punctuation_seconds?: number;
|
|
2448
|
+
|
|
2449
|
+
/**
|
|
2450
|
+
* Seconds to wait after the transcript ends with a number.
|
|
2451
|
+
*/
|
|
2452
|
+
on_number_seconds?: number;
|
|
2453
|
+
|
|
2454
|
+
/**
|
|
2455
|
+
* Seconds to wait after the transcript ends with punctuation.
|
|
2456
|
+
*/
|
|
2457
|
+
on_punctuation_seconds?: number;
|
|
2458
|
+
}
|
|
2459
|
+
}
|
|
2460
|
+
}
|
|
2461
|
+
|
|
2462
|
+
/**
|
|
2463
|
+
* Reference to an MCP server attached to an assistant. Create and manage MCP
|
|
2464
|
+
* servers with the `/ai/mcp_servers` endpoints, then attach them to assistants by
|
|
2465
|
+
* ID.
|
|
2466
|
+
*/
|
|
2467
|
+
export interface McpServer {
|
|
2468
|
+
/**
|
|
2469
|
+
* ID of the MCP server to attach. This must be the `id` of an MCP server returned
|
|
2470
|
+
* by the `/ai/mcp_servers` endpoints.
|
|
2471
|
+
*/
|
|
2472
|
+
id: string;
|
|
2473
|
+
|
|
2474
|
+
/**
|
|
2475
|
+
* Optional per-assistant allowlist of MCP tool names. When omitted, the assistant
|
|
2476
|
+
* uses the MCP server's configured `allowed_tools`.
|
|
2477
|
+
*/
|
|
2478
|
+
allowed_tools?: Array<string>;
|
|
2479
|
+
}
|
|
2480
|
+
}
|
|
2481
|
+
|
|
2362
2482
|
export interface AssistantRetrieveParams {
|
|
2363
2483
|
call_control_id?: string;
|
|
2364
2484
|
|
|
@@ -2427,7 +2547,7 @@ export interface AssistantUpdateParams {
|
|
|
2427
2547
|
* `/ai/integrations/connections`. Each item references a catalog integration by
|
|
2428
2548
|
* `integration_id`.
|
|
2429
2549
|
*/
|
|
2430
|
-
integrations?: Array<
|
|
2550
|
+
integrations?: Array<AssistantUpdateParams.Integration>;
|
|
2431
2551
|
|
|
2432
2552
|
/**
|
|
2433
2553
|
* Settings for interruptions and how the assistant decides the user has finished
|
|
@@ -2437,7 +2557,7 @@ export interface AssistantUpdateParams {
|
|
|
2437
2557
|
* `transcription.settings` (`eot_threshold`, `eot_timeout_ms`,
|
|
2438
2558
|
* `eager_eot_threshold`).
|
|
2439
2559
|
*/
|
|
2440
|
-
interruption_settings?:
|
|
2560
|
+
interruption_settings?: AssistantUpdateParams.InterruptionSettings;
|
|
2441
2561
|
|
|
2442
2562
|
/**
|
|
2443
2563
|
* This is only needed when using third-party inference providers selected by
|
|
@@ -2453,7 +2573,7 @@ export interface AssistantUpdateParams {
|
|
|
2453
2573
|
* MCP servers attached to the assistant. Create MCP servers with
|
|
2454
2574
|
* `/ai/mcp_servers`, then reference them by `id` here.
|
|
2455
2575
|
*/
|
|
2456
|
-
mcp_servers?: Array<
|
|
2576
|
+
mcp_servers?: Array<AssistantUpdateParams.McpServer>;
|
|
2457
2577
|
|
|
2458
2578
|
messaging_settings?: MessagingSettings;
|
|
2459
2579
|
|
|
@@ -2524,6 +2644,125 @@ export interface AssistantUpdateParams {
|
|
|
2524
2644
|
widget_settings?: WidgetSettings;
|
|
2525
2645
|
}
|
|
2526
2646
|
|
|
2647
|
+
export namespace AssistantUpdateParams {
|
|
2648
|
+
/**
|
|
2649
|
+
* Reference to a connected integration attached to an assistant. Discover
|
|
2650
|
+
* available integrations with `/ai/integrations` and connected integrations with
|
|
2651
|
+
* `/ai/integrations/connections`.
|
|
2652
|
+
*/
|
|
2653
|
+
export interface Integration {
|
|
2654
|
+
/**
|
|
2655
|
+
* Catalog integration ID to attach. This is the `id` from the integrations catalog
|
|
2656
|
+
* at `/ai/integrations` (the same value also appears as `integration_id` on
|
|
2657
|
+
* entries returned by `/ai/integrations/connections`). It is **not** the
|
|
2658
|
+
* connection-level `id` from `/ai/integrations/connections`.
|
|
2659
|
+
*/
|
|
2660
|
+
integration_id: string;
|
|
2661
|
+
|
|
2662
|
+
/**
|
|
2663
|
+
* Optional per-assistant allowlist of integration tool names. When omitted or
|
|
2664
|
+
* empty, all tools allowed by the connected integration are available to the
|
|
2665
|
+
* assistant.
|
|
2666
|
+
*/
|
|
2667
|
+
allowed_list?: Array<string>;
|
|
2668
|
+
}
|
|
2669
|
+
|
|
2670
|
+
/**
|
|
2671
|
+
* Settings for interruptions and how the assistant decides the user has finished
|
|
2672
|
+
* speaking. These timings are most relevant when using non turn-taking
|
|
2673
|
+
* transcription models. For turn-taking models like `deepgram/flux`, end-of-turn
|
|
2674
|
+
* behavior is controlled by the transcription end-of-turn settings under
|
|
2675
|
+
* `transcription.settings` (`eot_threshold`, `eot_timeout_ms`,
|
|
2676
|
+
* `eager_eot_threshold`).
|
|
2677
|
+
*/
|
|
2678
|
+
export interface InterruptionSettings {
|
|
2679
|
+
/**
|
|
2680
|
+
* When true, disables user interruptions while the assistant greeting is playing.
|
|
2681
|
+
*/
|
|
2682
|
+
disable_greeting_interruption?: boolean;
|
|
2683
|
+
|
|
2684
|
+
/**
|
|
2685
|
+
* Whether users can interrupt the assistant while it is speaking.
|
|
2686
|
+
*/
|
|
2687
|
+
enable?: boolean;
|
|
2688
|
+
|
|
2689
|
+
/**
|
|
2690
|
+
* Controls when the assistant starts speaking after the user stops. These
|
|
2691
|
+
* thresholds primarily apply to non turn-taking transcription models. For
|
|
2692
|
+
* turn-taking models like `deepgram/flux`, end-of-turn detection is driven by the
|
|
2693
|
+
* transcription end-of-turn settings under `transcription.settings` instead.
|
|
2694
|
+
*/
|
|
2695
|
+
start_speaking_plan?: InterruptionSettings.StartSpeakingPlan;
|
|
2696
|
+
}
|
|
2697
|
+
|
|
2698
|
+
export namespace InterruptionSettings {
|
|
2699
|
+
/**
|
|
2700
|
+
* Controls when the assistant starts speaking after the user stops. These
|
|
2701
|
+
* thresholds primarily apply to non turn-taking transcription models. For
|
|
2702
|
+
* turn-taking models like `deepgram/flux`, end-of-turn detection is driven by the
|
|
2703
|
+
* transcription end-of-turn settings under `transcription.settings` instead.
|
|
2704
|
+
*/
|
|
2705
|
+
export interface StartSpeakingPlan {
|
|
2706
|
+
/**
|
|
2707
|
+
* Endpointing thresholds used to decide when the user has finished speaking.
|
|
2708
|
+
* Applies to non turn-taking transcription models. For `deepgram/flux`, use
|
|
2709
|
+
* `transcription.settings.eot_threshold` / `eot_timeout_ms` /
|
|
2710
|
+
* `eager_eot_threshold`.
|
|
2711
|
+
*/
|
|
2712
|
+
transcription_endpointing_plan?: StartSpeakingPlan.TranscriptionEndpointingPlan;
|
|
2713
|
+
|
|
2714
|
+
/**
|
|
2715
|
+
* Minimum seconds to wait before the assistant starts speaking.
|
|
2716
|
+
*/
|
|
2717
|
+
wait_seconds?: number;
|
|
2718
|
+
}
|
|
2719
|
+
|
|
2720
|
+
export namespace StartSpeakingPlan {
|
|
2721
|
+
/**
|
|
2722
|
+
* Endpointing thresholds used to decide when the user has finished speaking.
|
|
2723
|
+
* Applies to non turn-taking transcription models. For `deepgram/flux`, use
|
|
2724
|
+
* `transcription.settings.eot_threshold` / `eot_timeout_ms` /
|
|
2725
|
+
* `eager_eot_threshold`.
|
|
2726
|
+
*/
|
|
2727
|
+
export interface TranscriptionEndpointingPlan {
|
|
2728
|
+
/**
|
|
2729
|
+
* Seconds to wait after the transcript ends without punctuation.
|
|
2730
|
+
*/
|
|
2731
|
+
on_no_punctuation_seconds?: number;
|
|
2732
|
+
|
|
2733
|
+
/**
|
|
2734
|
+
* Seconds to wait after the transcript ends with a number.
|
|
2735
|
+
*/
|
|
2736
|
+
on_number_seconds?: number;
|
|
2737
|
+
|
|
2738
|
+
/**
|
|
2739
|
+
* Seconds to wait after the transcript ends with punctuation.
|
|
2740
|
+
*/
|
|
2741
|
+
on_punctuation_seconds?: number;
|
|
2742
|
+
}
|
|
2743
|
+
}
|
|
2744
|
+
}
|
|
2745
|
+
|
|
2746
|
+
/**
|
|
2747
|
+
* Reference to an MCP server attached to an assistant. Create and manage MCP
|
|
2748
|
+
* servers with the `/ai/mcp_servers` endpoints, then attach them to assistants by
|
|
2749
|
+
* ID.
|
|
2750
|
+
*/
|
|
2751
|
+
export interface McpServer {
|
|
2752
|
+
/**
|
|
2753
|
+
* ID of the MCP server to attach. This must be the `id` of an MCP server returned
|
|
2754
|
+
* by the `/ai/mcp_servers` endpoints.
|
|
2755
|
+
*/
|
|
2756
|
+
id: string;
|
|
2757
|
+
|
|
2758
|
+
/**
|
|
2759
|
+
* Optional per-assistant allowlist of MCP tool names. When omitted, the assistant
|
|
2760
|
+
* uses the MCP server's configured `allowed_tools`.
|
|
2761
|
+
*/
|
|
2762
|
+
allowed_tools?: Array<string>;
|
|
2763
|
+
}
|
|
2764
|
+
}
|
|
2765
|
+
|
|
2527
2766
|
export interface AssistantChatParams {
|
|
2528
2767
|
/**
|
|
2529
2768
|
* The message content sent by the client to the assistant
|
|
@@ -2583,8 +2822,6 @@ Assistants.Tags = Tags;
|
|
|
2583
2822
|
export declare namespace Assistants {
|
|
2584
2823
|
export {
|
|
2585
2824
|
type Assistant as Assistant,
|
|
2586
|
-
type AssistantIntegration as AssistantIntegration,
|
|
2587
|
-
type AssistantMcpServer as AssistantMcpServer,
|
|
2588
2825
|
type AssistantTool as AssistantTool,
|
|
2589
2826
|
type AssistantsList as AssistantsList,
|
|
2590
2827
|
type AudioVisualizerConfig as AudioVisualizerConfig,
|
|
@@ -2597,7 +2834,6 @@ export declare namespace Assistants {
|
|
|
2597
2834
|
type HangupToolParams as HangupToolParams,
|
|
2598
2835
|
type ImportMetadata as ImportMetadata,
|
|
2599
2836
|
type InferenceEmbedding as InferenceEmbedding,
|
|
2600
|
-
type InferenceEmbeddingInterruptionSettings as InferenceEmbeddingInterruptionSettings,
|
|
2601
2837
|
type InferenceEmbeddingWebhookToolParams as InferenceEmbeddingWebhookToolParams,
|
|
2602
2838
|
type InsightSettings as InsightSettings,
|
|
2603
2839
|
type MessagingSettings as MessagingSettings,
|
|
@@ -2607,9 +2843,7 @@ export declare namespace Assistants {
|
|
|
2607
2843
|
type PostConversationSettingsReq as PostConversationSettingsReq,
|
|
2608
2844
|
type PrivacySettings as PrivacySettings,
|
|
2609
2845
|
type RetrievalTool as RetrievalTool,
|
|
2610
|
-
type StartSpeakingPlan as StartSpeakingPlan,
|
|
2611
2846
|
type TelephonySettings as TelephonySettings,
|
|
2612
|
-
type TranscriptionEndpointingPlan as TranscriptionEndpointingPlan,
|
|
2613
2847
|
type TranscriptionSettings as TranscriptionSettings,
|
|
2614
2848
|
type TranscriptionSettingsConfig as TranscriptionSettingsConfig,
|
|
2615
2849
|
type TransferTool as TransferTool,
|
|
@@ -2642,11 +2876,6 @@ export declare namespace Assistants {
|
|
|
2642
2876
|
CanaryDeploys as CanaryDeploys,
|
|
2643
2877
|
type CanaryDeploy as CanaryDeploy,
|
|
2644
2878
|
type CanaryDeployResponse as CanaryDeployResponse,
|
|
2645
|
-
type Clause as Clause,
|
|
2646
|
-
type RolloutSlot as RolloutSlot,
|
|
2647
|
-
type RuleInput as RuleInput,
|
|
2648
|
-
type RuleOutput as RuleOutput,
|
|
2649
|
-
type Serve as Serve,
|
|
2650
2879
|
type CanaryDeployCreateParams as CanaryDeployCreateParams,
|
|
2651
2880
|
type CanaryDeployUpdateParams as CanaryDeployUpdateParams,
|
|
2652
2881
|
};
|