telnyx 6.55.0 → 6.56.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 +26 -0
- package/client.d.mts +11 -10
- package/client.d.mts.map +1 -1
- package/client.d.ts +11 -10
- package/client.d.ts.map +1 -1
- package/client.js.map +1 -1
- package/client.mjs +1 -1
- package/client.mjs.map +1 -1
- package/package.json +1 -1
- package/resources/ai/ai.d.mts +10 -12
- package/resources/ai/ai.d.mts.map +1 -1
- package/resources/ai/ai.d.ts +10 -12
- 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 +112 -320
- package/resources/ai/assistants/assistants.d.mts.map +1 -1
- package/resources/ai/assistants/assistants.d.ts +112 -320
- 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 +70 -241
- package/resources/ai/assistants/canary-deploys.d.mts.map +1 -1
- package/resources/ai/assistants/canary-deploys.d.ts +70 -241
- 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 +6 -212
- package/resources/ai/assistants/versions.d.mts.map +1 -1
- package/resources/ai/assistants/versions.d.ts +6 -212
- 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 +1 -1
- package/resources/ai/index.mjs.map +1 -1
- package/resources/ai/openai/openai.d.mts +2 -9
- package/resources/ai/openai/openai.d.mts.map +1 -1
- package/resources/ai/openai/openai.d.ts +2 -9
- 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 +41 -119
- package/resources/calls/actions.d.mts.map +1 -1
- package/resources/calls/actions.d.ts +41 -119
- package/resources/calls/actions.d.ts.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 +1 -11
- package/resources/conferences/actions.d.mts.map +1 -1
- package/resources/conferences/actions.d.ts +1 -11
- 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 +1 -1
- package/resources/index.mjs.map +1 -1
- package/resources/networks/networks.d.mts +25 -2
- package/resources/networks/networks.d.mts.map +1 -1
- package/resources/networks/networks.d.ts +25 -2
- 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 +40 -50
- package/resources/public-internet-gateways.d.mts.map +1 -1
- package/resources/public-internet-gateways.d.ts +40 -50
- 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 +10 -0
- package/resources/shared.d.mts.map +1 -1
- package/resources/shared.d.ts +10 -0
- 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 +211 -1861
- package/resources/uac-connections/uac-connections.d.mts.map +1 -1
- package/resources/uac-connections/uac-connections.d.ts +211 -1861
- 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 +48 -504
- package/resources/virtual-cross-connects.d.mts.map +1 -1
- package/resources/virtual-cross-connects.d.ts +48 -504
- 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 +43 -127
- package/resources/wireguard-interfaces.d.mts.map +1 -1
- package/resources/wireguard-interfaces.d.ts +43 -127
- package/resources/wireguard-interfaces.d.ts.map +1 -1
- package/resources/wireguard-interfaces.js +5 -2
- package/resources/wireguard-interfaces.js.map +1 -1
- package/resources/wireguard-interfaces.mjs +5 -2
- package/resources/wireguard-interfaces.mjs.map +1 -1
- package/src/client.ts +33 -17
- package/src/resources/ai/ai.ts +20 -11
- package/src/resources/ai/assistants/assistants.ts +133 -347
- package/src/resources/ai/assistants/canary-deploys.ts +75 -266
- package/src/resources/ai/assistants/index.ts +10 -0
- package/src/resources/ai/assistants/versions.ts +6 -234
- package/src/resources/ai/index.ts +12 -1
- package/src/resources/ai/openai/openai.ts +2 -13
- package/src/resources/calls/actions.ts +76 -192
- package/src/resources/calls/calls.ts +4 -0
- package/src/resources/calls/index.ts +2 -0
- package/src/resources/conferences/actions.ts +1 -13
- package/src/resources/index.ts +19 -9
- package/src/resources/networks/networks.ts +31 -4
- package/src/resources/public-internet-gateways.ts +46 -55
- package/src/resources/shared.ts +12 -0
- package/src/resources/uac-connections/index.ts +6 -2
- package/src/resources/uac-connections/uac-connections.ts +397 -2396
- package/src/resources/virtual-cross-connects.ts +54 -595
- package/src/resources/wireguard-interfaces.ts +53 -158
- 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
package/resources/ai/ai.js.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"ai.js","sourceRoot":"","sources":["../../src/resources/ai/ai.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;;AAEtF,qDAAkD;AAClD,6DAAoC;AACpC,sCAAgF;AAChF,2DAAkC;AAClC,oCAAmG;AACnG,mEAA0C;AAC1C,4CAWoB;AACpB,wEAA+C;AAC/C,kDAUuB;AACvB,6DAAoC;AACpC,sCAWiB;AACjB,kFAAyD;AACzD,
|
|
1
|
+
{"version":3,"file":"ai.js","sourceRoot":"","sources":["../../src/resources/ai/ai.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;;AAEtF,qDAAkD;AAClD,6DAAoC;AACpC,sCAAgF;AAChF,2DAAkC;AAClC,oCAAmG;AACnG,mEAA0C;AAC1C,4CAWoB;AACpB,wEAA+C;AAC/C,kDAUuB;AACvB,6DAAoC;AACpC,sCAWiB;AACjB,kFAAyD;AACzD,2DA8CiC;AACjC,2FAAkE;AAClE,oEAWuC;AACvC,kFAAyD;AACzD,2DAWiC;AACjC,oFAA2D;AAC3D,8DAAuD;AACvD,wFAA+D;AAC/D,iEAIqC;AACrC,4EAAmD;AACnD,qDAY6B;AAC7B,sEAA6C;AAC7C,+CAAmE;AAInE;;GAEG;AACH,MAAa,EAAG,SAAQ,sBAAW;IAAnC;;QACE,eAAU,GAA6B,IAAI,aAAa,CAAC,UAAU,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;QAClF,UAAK,GAAmB,IAAI,QAAQ,CAAC,KAAK,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;QACzD,SAAI,GAAiB,IAAI,OAAO,CAAC,IAAI,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;QACpD,aAAQ,GAAyB,IAAI,WAAW,CAAC,QAAQ,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;QACxE,kBAAa,GAAmC,IAAI,gBAAgB,CAAC,aAAa,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;QACjG,eAAU,GAA6B,IAAI,aAAa,CAAC,UAAU,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;QAClF,eAAU,GAA6B,IAAI,aAAa,CAAC,UAAU,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;QAClF,iBAAY,GAAiC,IAAI,eAAe,CAAC,YAAY,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;QAC5F,eAAU,GAA6B,IAAI,aAAa,CAAC,UAAU,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;QAClF,aAAQ,GAAyB,IAAI,WAAW,CAAC,QAAQ,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;QACxE,WAAM,GAAqB,IAAI,SAAS,CAAC,MAAM,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;QAC9D,UAAK,GAAmB,IAAI,QAAQ,CAAC,KAAK,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;IAuC3D,CAAC;IArCC;;;;;;;;OAQG;IACH,cAAc,CAAC,OAAwB;QACrC,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,YAAY,EAAE,OAAO,CAAC,CAAC;IACjD,CAAC;IAED;;;;;;;;;;;;;;;;;;;;OAoBG;IACH,SAAS,CAAC,IAAuB,EAAE,OAAwB;QACzD,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,eAAe,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAClE,CAAC;CACF;AAnDD,gBAmDC;AA6CD,EAAE,CAAC,UAAU,GAAG,uBAAU,CAAC;AAC3B,EAAE,CAAC,KAAK,GAAG,aAAK,CAAC;AACjB,EAAE,CAAC,IAAI,GAAG,WAAI,CAAC;AACf,EAAE,CAAC,QAAQ,GAAG,mBAAQ,CAAC;AACvB,EAAE,CAAC,aAAa,GAAG,6BAAa,CAAC;AACjC,EAAE,CAAC,UAAU,GAAG,uBAAU,CAAC;AAC3B,EAAE,CAAC,UAAU,GAAG,wBAAU,CAAC;AAC3B,EAAE,CAAC,YAAY,GAAG,2BAAY,CAAC;AAC/B,EAAE,CAAC,UAAU,GAAG,wBAAU,CAAC;AAC3B,EAAE,CAAC,QAAQ,GAAG,mBAAQ,CAAC;AACvB,EAAE,CAAC,MAAM,GAAG,eAAM,CAAC;AACnB,EAAE,CAAC,KAAK,GAAG,aAAK,CAAC"}
|
package/resources/ai/ai.mjs.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"ai.mjs","sourceRoot":"","sources":["../../src/resources/ai/ai.ts"],"names":[],"mappings":"AAAA,sFAAsF;OAE/E,EAAE,WAAW,EAAE;OACf,KAAK,QAAQ;OACb,EAAE,KAAK,EAAkD;OACzD,KAAK,OAAO;OACZ,EAAa,IAAI,EAA4D;OAC7E,KAAK,WAAW;OAChB,EASL,QAAQ,GAET;OACM,KAAK,aAAa;OAClB,EASL,UAAU,GACX;OACM,KAAK,QAAQ;OACb,EAUL,KAAK,GACN;OACM,KAAK,aAAa;OAClB,
|
|
1
|
+
{"version":3,"file":"ai.mjs","sourceRoot":"","sources":["../../src/resources/ai/ai.ts"],"names":[],"mappings":"AAAA,sFAAsF;OAE/E,EAAE,WAAW,EAAE;OACf,KAAK,QAAQ;OACb,EAAE,KAAK,EAAkD;OACzD,KAAK,OAAO;OACZ,EAAa,IAAI,EAA4D;OAC7E,KAAK,WAAW;OAChB,EASL,QAAQ,GAET;OACM,KAAK,aAAa;OAClB,EASL,UAAU,GACX;OACM,KAAK,QAAQ;OACb,EAUL,KAAK,GACN;OACM,KAAK,aAAa;OAClB,EAeL,UAAU,GA+BX;OACM,KAAK,gBAAgB;OACrB,EAUL,aAAa,GACd;OACM,KAAK,aAAa;OAClB,EAUL,UAAU,GACX;OACM,KAAK,aAAa;OAClB,EAAE,UAAU,EAAE;OACd,KAAK,eAAe;OACpB,EAGL,YAAY,GACb;OACM,KAAK,WAAW;OAChB,EAWL,QAAQ,GACT;OACM,KAAK,SAAS;OACd,EAAE,MAAM,EAA4B;AAI3C;;GAEG;AACH,MAAM,OAAO,EAAG,SAAQ,WAAW;IAAnC;;QACE,eAAU,GAA6B,IAAI,aAAa,CAAC,UAAU,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;QAClF,UAAK,GAAmB,IAAI,QAAQ,CAAC,KAAK,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;QACzD,SAAI,GAAiB,IAAI,OAAO,CAAC,IAAI,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;QACpD,aAAQ,GAAyB,IAAI,WAAW,CAAC,QAAQ,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;QACxE,kBAAa,GAAmC,IAAI,gBAAgB,CAAC,aAAa,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;QACjG,eAAU,GAA6B,IAAI,aAAa,CAAC,UAAU,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;QAClF,eAAU,GAA6B,IAAI,aAAa,CAAC,UAAU,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;QAClF,iBAAY,GAAiC,IAAI,eAAe,CAAC,YAAY,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;QAC5F,eAAU,GAA6B,IAAI,aAAa,CAAC,UAAU,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;QAClF,aAAQ,GAAyB,IAAI,WAAW,CAAC,QAAQ,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;QACxE,WAAM,GAAqB,IAAI,SAAS,CAAC,MAAM,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;QAC9D,UAAK,GAAmB,IAAI,QAAQ,CAAC,KAAK,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;IAuC3D,CAAC;IArCC;;;;;;;;OAQG;IACH,cAAc,CAAC,OAAwB;QACrC,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,YAAY,EAAE,OAAO,CAAC,CAAC;IACjD,CAAC;IAED;;;;;;;;;;;;;;;;;;;;OAoBG;IACH,SAAS,CAAC,IAAuB,EAAE,OAAwB;QACzD,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,eAAe,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAClE,CAAC;CACF;AA6CD,EAAE,CAAC,UAAU,GAAG,UAAU,CAAC;AAC3B,EAAE,CAAC,KAAK,GAAG,KAAK,CAAC;AACjB,EAAE,CAAC,IAAI,GAAG,IAAI,CAAC;AACf,EAAE,CAAC,QAAQ,GAAG,QAAQ,CAAC;AACvB,EAAE,CAAC,aAAa,GAAG,aAAa,CAAC;AACjC,EAAE,CAAC,UAAU,GAAG,UAAU,CAAC;AAC3B,EAAE,CAAC,UAAU,GAAG,UAAU,CAAC;AAC3B,EAAE,CAAC,YAAY,GAAG,YAAY,CAAC;AAC/B,EAAE,CAAC,UAAU,GAAG,UAAU,CAAC;AAC3B,EAAE,CAAC,QAAQ,GAAG,QAAQ,CAAC;AACvB,EAAE,CAAC,MAAM,GAAG,MAAM,CAAC;AACnB,EAAE,CAAC,KAAK,GAAG,KAAK,CAAC"}
|
|
@@ -2,7 +2,7 @@ import { APIResource } from "../../../core/resource.mjs";
|
|
|
2
2
|
import * as Shared from "../../shared.mjs";
|
|
3
3
|
import * as ChatAPI from "../chat.mjs";
|
|
4
4
|
import * as CanaryDeploysAPI from "./canary-deploys.mjs";
|
|
5
|
-
import { CanaryDeploy, CanaryDeployCreateParams, CanaryDeployResponse, CanaryDeployUpdateParams, CanaryDeploys } from "./canary-deploys.mjs";
|
|
5
|
+
import { CanaryDeploy, CanaryDeployCreateParams, CanaryDeployResponse, CanaryDeployUpdateParams, CanaryDeploys, Clause, RolloutSlot, RuleInput, RuleOutput, Serve } from "./canary-deploys.mjs";
|
|
6
6
|
import * as ScheduledEventsAPI from "./scheduled-events.mjs";
|
|
7
7
|
import { ConversationChannelType, EventStatus, ScheduledEventCreateParams, ScheduledEventDeleteParams, ScheduledEventListParams, ScheduledEventListResponse, ScheduledEventListResponsesDefaultFlatPagination, ScheduledEventResponse, ScheduledEventRetrieveParams, ScheduledEvents, ScheduledPhoneCallEventResponse, ScheduledSMSEventResponse } from "./scheduled-events.mjs";
|
|
8
8
|
import * as TagsAPI from "./tags.mjs";
|
|
@@ -184,6 +184,43 @@ export interface Assistant {
|
|
|
184
184
|
*/
|
|
185
185
|
tools?: Array<Shared.BookAppointmentTool | Shared.CheckAvailabilityTool | WebhookTool | HangupTool | TransferTool | Shared.CallControlRetrievalTool>;
|
|
186
186
|
}
|
|
187
|
+
/**
|
|
188
|
+
* Reference to a connected integration attached to an assistant. Discover
|
|
189
|
+
* available integrations with `/ai/integrations` and connected integrations with
|
|
190
|
+
* `/ai/integrations/connections`.
|
|
191
|
+
*/
|
|
192
|
+
export interface AssistantIntegration {
|
|
193
|
+
/**
|
|
194
|
+
* Catalog integration ID to attach. This is the `id` from the integrations catalog
|
|
195
|
+
* at `/ai/integrations` (the same value also appears as `integration_id` on
|
|
196
|
+
* entries returned by `/ai/integrations/connections`). It is **not** the
|
|
197
|
+
* connection-level `id` from `/ai/integrations/connections`.
|
|
198
|
+
*/
|
|
199
|
+
integration_id: string;
|
|
200
|
+
/**
|
|
201
|
+
* Optional per-assistant allowlist of integration tool names. When omitted or
|
|
202
|
+
* empty, all tools allowed by the connected integration are available to the
|
|
203
|
+
* assistant.
|
|
204
|
+
*/
|
|
205
|
+
allowed_list?: Array<string>;
|
|
206
|
+
}
|
|
207
|
+
/**
|
|
208
|
+
* Reference to an MCP server attached to an assistant. Create and manage MCP
|
|
209
|
+
* servers with the `/ai/mcp_servers` endpoints, then attach them to assistants by
|
|
210
|
+
* ID.
|
|
211
|
+
*/
|
|
212
|
+
export interface AssistantMcpServer {
|
|
213
|
+
/**
|
|
214
|
+
* ID of the MCP server to attach. This must be the `id` of an MCP server returned
|
|
215
|
+
* by the `/ai/mcp_servers` endpoints.
|
|
216
|
+
*/
|
|
217
|
+
id: string;
|
|
218
|
+
/**
|
|
219
|
+
* Optional per-assistant allowlist of MCP tool names. When omitted, the assistant
|
|
220
|
+
* uses the MCP server's configured `allowed_tools`.
|
|
221
|
+
*/
|
|
222
|
+
allowed_tools?: Array<string>;
|
|
223
|
+
}
|
|
187
224
|
/**
|
|
188
225
|
* The handoff tool allows the assistant to hand off control of the conversation to
|
|
189
226
|
* another AI assistant. By default, this will happen transparently to the end
|
|
@@ -243,7 +280,7 @@ export declare namespace AssistantTool {
|
|
|
243
280
|
* variable string like `{{ targets }}` where `targets` is returned by the dynamic
|
|
244
281
|
* variables webhook and resolves to an array of target objects at runtime.
|
|
245
282
|
*/
|
|
246
|
-
targets: Array<Transfer.
|
|
283
|
+
targets: Array<Transfer.TargetsList> | string;
|
|
247
284
|
/**
|
|
248
285
|
* Custom headers to be added to the SIP INVITE for the transfer command.
|
|
249
286
|
*/
|
|
@@ -268,7 +305,7 @@ export declare namespace AssistantTool {
|
|
|
268
305
|
warm_transfer_instructions?: string;
|
|
269
306
|
}
|
|
270
307
|
namespace Transfer {
|
|
271
|
-
interface
|
|
308
|
+
interface TargetsList {
|
|
272
309
|
/**
|
|
273
310
|
* The destination number or SIP URI of the call.
|
|
274
311
|
*/
|
|
@@ -419,7 +456,7 @@ export declare namespace AssistantTool {
|
|
|
419
456
|
* omitted or null, the invite tool can still be configured and targets may be
|
|
420
457
|
* supplied dynamically at runtime.
|
|
421
458
|
*/
|
|
422
|
-
targets?: Array<Invite.
|
|
459
|
+
targets?: Array<Invite.TargetsList> | string | null;
|
|
423
460
|
/**
|
|
424
461
|
* Configuration for voicemail detection (AMD - Answering Machine Detection) on the
|
|
425
462
|
* invited call.
|
|
@@ -437,7 +474,7 @@ export declare namespace AssistantTool {
|
|
|
437
474
|
*/
|
|
438
475
|
value?: string;
|
|
439
476
|
}
|
|
440
|
-
interface
|
|
477
|
+
interface TargetsList {
|
|
441
478
|
/**
|
|
442
479
|
* The destination number or SIP URI of the call.
|
|
443
480
|
*/
|
|
@@ -778,7 +815,7 @@ export interface InferenceEmbedding {
|
|
|
778
815
|
* `/ai/integrations/connections`. Each item references a catalog integration by
|
|
779
816
|
* `integration_id`.
|
|
780
817
|
*/
|
|
781
|
-
integrations?: Array<
|
|
818
|
+
integrations?: Array<AssistantIntegration>;
|
|
782
819
|
/**
|
|
783
820
|
* Settings for interruptions and how the assistant decides the user has finished
|
|
784
821
|
* speaking. These timings are most relevant when using non turn-taking
|
|
@@ -787,7 +824,7 @@ export interface InferenceEmbedding {
|
|
|
787
824
|
* `transcription.settings` (`eot_threshold`, `eot_timeout_ms`,
|
|
788
825
|
* `eager_eot_threshold`).
|
|
789
826
|
*/
|
|
790
|
-
interruption_settings?:
|
|
827
|
+
interruption_settings?: InferenceEmbeddingInterruptionSettings;
|
|
791
828
|
/**
|
|
792
829
|
* This is only needed when using third-party inference providers selected by
|
|
793
830
|
* `model`. The `identifier` for an integration secret
|
|
@@ -801,7 +838,7 @@ export interface InferenceEmbedding {
|
|
|
801
838
|
* MCP servers attached to the assistant. Create MCP servers with
|
|
802
839
|
* `/ai/mcp_servers`, then reference them by `id` here.
|
|
803
840
|
*/
|
|
804
|
-
mcp_servers?: Array<
|
|
841
|
+
mcp_servers?: Array<AssistantMcpServer>;
|
|
805
842
|
messaging_settings?: MessagingSettings;
|
|
806
843
|
observability_settings?: Observability;
|
|
807
844
|
/**
|
|
@@ -850,108 +887,30 @@ export interface InferenceEmbedding {
|
|
|
850
887
|
*/
|
|
851
888
|
widget_settings?: WidgetSettings;
|
|
852
889
|
}
|
|
853
|
-
|
|
890
|
+
/**
|
|
891
|
+
* Settings for interruptions and how the assistant decides the user has finished
|
|
892
|
+
* speaking. These timings are most relevant when using non turn-taking
|
|
893
|
+
* transcription models. For turn-taking models like `deepgram/flux`, end-of-turn
|
|
894
|
+
* behavior is controlled by the transcription end-of-turn settings under
|
|
895
|
+
* `transcription.settings` (`eot_threshold`, `eot_timeout_ms`,
|
|
896
|
+
* `eager_eot_threshold`).
|
|
897
|
+
*/
|
|
898
|
+
export interface InferenceEmbeddingInterruptionSettings {
|
|
854
899
|
/**
|
|
855
|
-
*
|
|
856
|
-
* available integrations with `/ai/integrations` and connected integrations with
|
|
857
|
-
* `/ai/integrations/connections`.
|
|
900
|
+
* When true, disables user interruptions while the assistant greeting is playing.
|
|
858
901
|
*/
|
|
859
|
-
|
|
860
|
-
/**
|
|
861
|
-
* Catalog integration ID to attach. This is the `id` from the integrations catalog
|
|
862
|
-
* at `/ai/integrations` (the same value also appears as `integration_id` on
|
|
863
|
-
* entries returned by `/ai/integrations/connections`). It is **not** the
|
|
864
|
-
* connection-level `id` from `/ai/integrations/connections`.
|
|
865
|
-
*/
|
|
866
|
-
integration_id: string;
|
|
867
|
-
/**
|
|
868
|
-
* Optional per-assistant allowlist of integration tool names. When omitted or
|
|
869
|
-
* empty, all tools allowed by the connected integration are available to the
|
|
870
|
-
* assistant.
|
|
871
|
-
*/
|
|
872
|
-
allowed_list?: Array<string>;
|
|
873
|
-
}
|
|
902
|
+
disable_greeting_interruption?: boolean;
|
|
874
903
|
/**
|
|
875
|
-
*
|
|
876
|
-
* speaking. These timings are most relevant when using non turn-taking
|
|
877
|
-
* transcription models. For turn-taking models like `deepgram/flux`, end-of-turn
|
|
878
|
-
* behavior is controlled by the transcription end-of-turn settings under
|
|
879
|
-
* `transcription.settings` (`eot_threshold`, `eot_timeout_ms`,
|
|
880
|
-
* `eager_eot_threshold`).
|
|
904
|
+
* Whether users can interrupt the assistant while it is speaking.
|
|
881
905
|
*/
|
|
882
|
-
|
|
883
|
-
/**
|
|
884
|
-
* Whether users can interrupt the assistant while it is speaking.
|
|
885
|
-
*/
|
|
886
|
-
enable?: boolean;
|
|
887
|
-
/**
|
|
888
|
-
* Controls when the assistant starts speaking after the user stops. These
|
|
889
|
-
* thresholds primarily apply to non turn-taking transcription models. For
|
|
890
|
-
* turn-taking models like `deepgram/flux`, end-of-turn detection is driven by the
|
|
891
|
-
* transcription end-of-turn settings under `transcription.settings` instead.
|
|
892
|
-
*/
|
|
893
|
-
start_speaking_plan?: InterruptionSettings.StartSpeakingPlan;
|
|
894
|
-
}
|
|
895
|
-
namespace InterruptionSettings {
|
|
896
|
-
/**
|
|
897
|
-
* Controls when the assistant starts speaking after the user stops. These
|
|
898
|
-
* thresholds primarily apply to non turn-taking transcription models. For
|
|
899
|
-
* turn-taking models like `deepgram/flux`, end-of-turn detection is driven by the
|
|
900
|
-
* transcription end-of-turn settings under `transcription.settings` instead.
|
|
901
|
-
*/
|
|
902
|
-
interface StartSpeakingPlan {
|
|
903
|
-
/**
|
|
904
|
-
* Endpointing thresholds used to decide when the user has finished speaking.
|
|
905
|
-
* Applies to non turn-taking transcription models. For `deepgram/flux`, use
|
|
906
|
-
* `transcription.settings.eot_threshold` / `eot_timeout_ms` /
|
|
907
|
-
* `eager_eot_threshold`.
|
|
908
|
-
*/
|
|
909
|
-
transcription_endpointing_plan?: StartSpeakingPlan.TranscriptionEndpointingPlan;
|
|
910
|
-
/**
|
|
911
|
-
* Minimum seconds to wait before the assistant starts speaking.
|
|
912
|
-
*/
|
|
913
|
-
wait_seconds?: number;
|
|
914
|
-
}
|
|
915
|
-
namespace StartSpeakingPlan {
|
|
916
|
-
/**
|
|
917
|
-
* Endpointing thresholds used to decide when the user has finished speaking.
|
|
918
|
-
* Applies to non turn-taking transcription models. For `deepgram/flux`, use
|
|
919
|
-
* `transcription.settings.eot_threshold` / `eot_timeout_ms` /
|
|
920
|
-
* `eager_eot_threshold`.
|
|
921
|
-
*/
|
|
922
|
-
interface TranscriptionEndpointingPlan {
|
|
923
|
-
/**
|
|
924
|
-
* Seconds to wait after the transcript ends without punctuation.
|
|
925
|
-
*/
|
|
926
|
-
on_no_punctuation_seconds?: number;
|
|
927
|
-
/**
|
|
928
|
-
* Seconds to wait after the transcript ends with a number.
|
|
929
|
-
*/
|
|
930
|
-
on_number_seconds?: number;
|
|
931
|
-
/**
|
|
932
|
-
* Seconds to wait after the transcript ends with punctuation.
|
|
933
|
-
*/
|
|
934
|
-
on_punctuation_seconds?: number;
|
|
935
|
-
}
|
|
936
|
-
}
|
|
937
|
-
}
|
|
906
|
+
enable?: boolean;
|
|
938
907
|
/**
|
|
939
|
-
*
|
|
940
|
-
*
|
|
941
|
-
*
|
|
908
|
+
* Controls when the assistant starts speaking after the user stops. These
|
|
909
|
+
* thresholds primarily apply to non turn-taking transcription models. For
|
|
910
|
+
* turn-taking models like `deepgram/flux`, end-of-turn detection is driven by the
|
|
911
|
+
* transcription end-of-turn settings under `transcription.settings` instead.
|
|
942
912
|
*/
|
|
943
|
-
|
|
944
|
-
/**
|
|
945
|
-
* ID of the MCP server to attach. This must be the `id` of an MCP server returned
|
|
946
|
-
* by the `/ai/mcp_servers` endpoints.
|
|
947
|
-
*/
|
|
948
|
-
id: string;
|
|
949
|
-
/**
|
|
950
|
-
* Optional per-assistant allowlist of MCP tool names. When omitted, the assistant
|
|
951
|
-
* uses the MCP server's configured `allowed_tools`.
|
|
952
|
-
*/
|
|
953
|
-
allowed_tools?: Array<string>;
|
|
954
|
-
}
|
|
913
|
+
start_speaking_plan?: StartSpeakingPlan;
|
|
955
914
|
}
|
|
956
915
|
export interface InferenceEmbeddingWebhookToolParams {
|
|
957
916
|
type: 'webhook';
|
|
@@ -1212,6 +1171,25 @@ export interface RetrievalTool {
|
|
|
1212
1171
|
retrieval: ChatAPI.BucketIDs;
|
|
1213
1172
|
type: 'retrieval';
|
|
1214
1173
|
}
|
|
1174
|
+
/**
|
|
1175
|
+
* Controls when the assistant starts speaking after the user stops. These
|
|
1176
|
+
* thresholds primarily apply to non turn-taking transcription models. For
|
|
1177
|
+
* turn-taking models like `deepgram/flux`, end-of-turn detection is driven by the
|
|
1178
|
+
* transcription end-of-turn settings under `transcription.settings` instead.
|
|
1179
|
+
*/
|
|
1180
|
+
export interface StartSpeakingPlan {
|
|
1181
|
+
/**
|
|
1182
|
+
* Endpointing thresholds used to decide when the user has finished speaking.
|
|
1183
|
+
* Applies to non turn-taking transcription models. For `deepgram/flux`, use
|
|
1184
|
+
* `transcription.settings.eot_threshold` / `eot_timeout_ms` /
|
|
1185
|
+
* `eager_eot_threshold`.
|
|
1186
|
+
*/
|
|
1187
|
+
transcription_endpointing_plan?: TranscriptionEndpointingPlan;
|
|
1188
|
+
/**
|
|
1189
|
+
* Minimum seconds to wait before the assistant starts speaking.
|
|
1190
|
+
*/
|
|
1191
|
+
wait_seconds?: number;
|
|
1192
|
+
}
|
|
1215
1193
|
export interface TelephonySettings {
|
|
1216
1194
|
/**
|
|
1217
1195
|
* Default Texml App used for voice calls with your assistant. This will be created
|
|
@@ -1355,6 +1333,26 @@ export declare namespace TelephonySettings {
|
|
|
1355
1333
|
}
|
|
1356
1334
|
}
|
|
1357
1335
|
}
|
|
1336
|
+
/**
|
|
1337
|
+
* Endpointing thresholds used to decide when the user has finished speaking.
|
|
1338
|
+
* Applies to non turn-taking transcription models. For `deepgram/flux`, use
|
|
1339
|
+
* `transcription.settings.eot_threshold` / `eot_timeout_ms` /
|
|
1340
|
+
* `eager_eot_threshold`.
|
|
1341
|
+
*/
|
|
1342
|
+
export interface TranscriptionEndpointingPlan {
|
|
1343
|
+
/**
|
|
1344
|
+
* Seconds to wait after the transcript ends without punctuation.
|
|
1345
|
+
*/
|
|
1346
|
+
on_no_punctuation_seconds?: number;
|
|
1347
|
+
/**
|
|
1348
|
+
* Seconds to wait after the transcript ends with a number.
|
|
1349
|
+
*/
|
|
1350
|
+
on_number_seconds?: number;
|
|
1351
|
+
/**
|
|
1352
|
+
* Seconds to wait after the transcript ends with punctuation.
|
|
1353
|
+
*/
|
|
1354
|
+
on_punctuation_seconds?: number;
|
|
1355
|
+
}
|
|
1358
1356
|
export interface TranscriptionSettings {
|
|
1359
1357
|
/**
|
|
1360
1358
|
* Integration secret identifier for the transcription provider API key. Currently
|
|
@@ -1452,10 +1450,10 @@ export declare namespace TransferTool {
|
|
|
1452
1450
|
* variable string like `{{ targets }}` where `targets` is returned by the dynamic
|
|
1453
1451
|
* variables webhook and resolves to an array of target objects at runtime.
|
|
1454
1452
|
*/
|
|
1455
|
-
targets: Array<Transfer.
|
|
1453
|
+
targets: Array<Transfer.TargetsList> | string;
|
|
1456
1454
|
}
|
|
1457
1455
|
namespace Transfer {
|
|
1458
|
-
interface
|
|
1456
|
+
interface TargetsList {
|
|
1459
1457
|
/**
|
|
1460
1458
|
* The destination number or SIP URI of the call.
|
|
1461
1459
|
*/
|
|
@@ -1816,7 +1814,7 @@ export interface AssistantCreateParams {
|
|
|
1816
1814
|
* `/ai/integrations/connections`. Each item references a catalog integration by
|
|
1817
1815
|
* `integration_id`.
|
|
1818
1816
|
*/
|
|
1819
|
-
integrations?: Array<
|
|
1817
|
+
integrations?: Array<AssistantIntegration>;
|
|
1820
1818
|
/**
|
|
1821
1819
|
* Settings for interruptions and how the assistant decides the user has finished
|
|
1822
1820
|
* speaking. These timings are most relevant when using non turn-taking
|
|
@@ -1825,7 +1823,7 @@ export interface AssistantCreateParams {
|
|
|
1825
1823
|
* `transcription.settings` (`eot_threshold`, `eot_timeout_ms`,
|
|
1826
1824
|
* `eager_eot_threshold`).
|
|
1827
1825
|
*/
|
|
1828
|
-
interruption_settings?:
|
|
1826
|
+
interruption_settings?: InferenceEmbeddingInterruptionSettings;
|
|
1829
1827
|
/**
|
|
1830
1828
|
* This is only needed when using third-party inference providers selected by
|
|
1831
1829
|
* `model`. The `identifier` for an integration secret
|
|
@@ -1839,7 +1837,7 @@ export interface AssistantCreateParams {
|
|
|
1839
1837
|
* MCP servers attached to the assistant. Create MCP servers with
|
|
1840
1838
|
* `/ai/mcp_servers`, then reference them by `id` here.
|
|
1841
1839
|
*/
|
|
1842
|
-
mcp_servers?: Array<
|
|
1840
|
+
mcp_servers?: Array<AssistantMcpServer>;
|
|
1843
1841
|
messaging_settings?: MessagingSettings;
|
|
1844
1842
|
/**
|
|
1845
1843
|
* ID of the model to use when `external_llm` is not set. You can use the
|
|
@@ -1884,109 +1882,6 @@ export interface AssistantCreateParams {
|
|
|
1884
1882
|
*/
|
|
1885
1883
|
widget_settings?: WidgetSettings;
|
|
1886
1884
|
}
|
|
1887
|
-
export declare namespace AssistantCreateParams {
|
|
1888
|
-
/**
|
|
1889
|
-
* Reference to a connected integration attached to an assistant. Discover
|
|
1890
|
-
* available integrations with `/ai/integrations` and connected integrations with
|
|
1891
|
-
* `/ai/integrations/connections`.
|
|
1892
|
-
*/
|
|
1893
|
-
interface Integration {
|
|
1894
|
-
/**
|
|
1895
|
-
* Catalog integration ID to attach. This is the `id` from the integrations catalog
|
|
1896
|
-
* at `/ai/integrations` (the same value also appears as `integration_id` on
|
|
1897
|
-
* entries returned by `/ai/integrations/connections`). It is **not** the
|
|
1898
|
-
* connection-level `id` from `/ai/integrations/connections`.
|
|
1899
|
-
*/
|
|
1900
|
-
integration_id: string;
|
|
1901
|
-
/**
|
|
1902
|
-
* Optional per-assistant allowlist of integration tool names. When omitted or
|
|
1903
|
-
* empty, all tools allowed by the connected integration are available to the
|
|
1904
|
-
* assistant.
|
|
1905
|
-
*/
|
|
1906
|
-
allowed_list?: Array<string>;
|
|
1907
|
-
}
|
|
1908
|
-
/**
|
|
1909
|
-
* Settings for interruptions and how the assistant decides the user has finished
|
|
1910
|
-
* speaking. These timings are most relevant when using non turn-taking
|
|
1911
|
-
* transcription models. For turn-taking models like `deepgram/flux`, end-of-turn
|
|
1912
|
-
* behavior is controlled by the transcription end-of-turn settings under
|
|
1913
|
-
* `transcription.settings` (`eot_threshold`, `eot_timeout_ms`,
|
|
1914
|
-
* `eager_eot_threshold`).
|
|
1915
|
-
*/
|
|
1916
|
-
interface InterruptionSettings {
|
|
1917
|
-
/**
|
|
1918
|
-
* Whether users can interrupt the assistant while it is speaking.
|
|
1919
|
-
*/
|
|
1920
|
-
enable?: boolean;
|
|
1921
|
-
/**
|
|
1922
|
-
* Controls when the assistant starts speaking after the user stops. These
|
|
1923
|
-
* thresholds primarily apply to non turn-taking transcription models. For
|
|
1924
|
-
* turn-taking models like `deepgram/flux`, end-of-turn detection is driven by the
|
|
1925
|
-
* transcription end-of-turn settings under `transcription.settings` instead.
|
|
1926
|
-
*/
|
|
1927
|
-
start_speaking_plan?: InterruptionSettings.StartSpeakingPlan;
|
|
1928
|
-
}
|
|
1929
|
-
namespace InterruptionSettings {
|
|
1930
|
-
/**
|
|
1931
|
-
* Controls when the assistant starts speaking after the user stops. These
|
|
1932
|
-
* thresholds primarily apply to non turn-taking transcription models. For
|
|
1933
|
-
* turn-taking models like `deepgram/flux`, end-of-turn detection is driven by the
|
|
1934
|
-
* transcription end-of-turn settings under `transcription.settings` instead.
|
|
1935
|
-
*/
|
|
1936
|
-
interface StartSpeakingPlan {
|
|
1937
|
-
/**
|
|
1938
|
-
* Endpointing thresholds used to decide when the user has finished speaking.
|
|
1939
|
-
* Applies to non turn-taking transcription models. For `deepgram/flux`, use
|
|
1940
|
-
* `transcription.settings.eot_threshold` / `eot_timeout_ms` /
|
|
1941
|
-
* `eager_eot_threshold`.
|
|
1942
|
-
*/
|
|
1943
|
-
transcription_endpointing_plan?: StartSpeakingPlan.TranscriptionEndpointingPlan;
|
|
1944
|
-
/**
|
|
1945
|
-
* Minimum seconds to wait before the assistant starts speaking.
|
|
1946
|
-
*/
|
|
1947
|
-
wait_seconds?: number;
|
|
1948
|
-
}
|
|
1949
|
-
namespace StartSpeakingPlan {
|
|
1950
|
-
/**
|
|
1951
|
-
* Endpointing thresholds used to decide when the user has finished speaking.
|
|
1952
|
-
* Applies to non turn-taking transcription models. For `deepgram/flux`, use
|
|
1953
|
-
* `transcription.settings.eot_threshold` / `eot_timeout_ms` /
|
|
1954
|
-
* `eager_eot_threshold`.
|
|
1955
|
-
*/
|
|
1956
|
-
interface TranscriptionEndpointingPlan {
|
|
1957
|
-
/**
|
|
1958
|
-
* Seconds to wait after the transcript ends without punctuation.
|
|
1959
|
-
*/
|
|
1960
|
-
on_no_punctuation_seconds?: number;
|
|
1961
|
-
/**
|
|
1962
|
-
* Seconds to wait after the transcript ends with a number.
|
|
1963
|
-
*/
|
|
1964
|
-
on_number_seconds?: number;
|
|
1965
|
-
/**
|
|
1966
|
-
* Seconds to wait after the transcript ends with punctuation.
|
|
1967
|
-
*/
|
|
1968
|
-
on_punctuation_seconds?: number;
|
|
1969
|
-
}
|
|
1970
|
-
}
|
|
1971
|
-
}
|
|
1972
|
-
/**
|
|
1973
|
-
* Reference to an MCP server attached to an assistant. Create and manage MCP
|
|
1974
|
-
* servers with the `/ai/mcp_servers` endpoints, then attach them to assistants by
|
|
1975
|
-
* ID.
|
|
1976
|
-
*/
|
|
1977
|
-
interface McpServer {
|
|
1978
|
-
/**
|
|
1979
|
-
* ID of the MCP server to attach. This must be the `id` of an MCP server returned
|
|
1980
|
-
* by the `/ai/mcp_servers` endpoints.
|
|
1981
|
-
*/
|
|
1982
|
-
id: string;
|
|
1983
|
-
/**
|
|
1984
|
-
* Optional per-assistant allowlist of MCP tool names. When omitted, the assistant
|
|
1985
|
-
* uses the MCP server's configured `allowed_tools`.
|
|
1986
|
-
*/
|
|
1987
|
-
allowed_tools?: Array<string>;
|
|
1988
|
-
}
|
|
1989
|
-
}
|
|
1990
1885
|
export interface AssistantRetrieveParams {
|
|
1991
1886
|
call_control_id?: string;
|
|
1992
1887
|
fetch_dynamic_variables_from_webhook?: boolean;
|
|
@@ -2043,7 +1938,7 @@ export interface AssistantUpdateParams {
|
|
|
2043
1938
|
* `/ai/integrations/connections`. Each item references a catalog integration by
|
|
2044
1939
|
* `integration_id`.
|
|
2045
1940
|
*/
|
|
2046
|
-
integrations?: Array<
|
|
1941
|
+
integrations?: Array<AssistantIntegration>;
|
|
2047
1942
|
/**
|
|
2048
1943
|
* Settings for interruptions and how the assistant decides the user has finished
|
|
2049
1944
|
* speaking. These timings are most relevant when using non turn-taking
|
|
@@ -2052,7 +1947,7 @@ export interface AssistantUpdateParams {
|
|
|
2052
1947
|
* `transcription.settings` (`eot_threshold`, `eot_timeout_ms`,
|
|
2053
1948
|
* `eager_eot_threshold`).
|
|
2054
1949
|
*/
|
|
2055
|
-
interruption_settings?:
|
|
1950
|
+
interruption_settings?: InferenceEmbeddingInterruptionSettings;
|
|
2056
1951
|
/**
|
|
2057
1952
|
* This is only needed when using third-party inference providers selected by
|
|
2058
1953
|
* `model`. The `identifier` for an integration secret
|
|
@@ -2066,7 +1961,7 @@ export interface AssistantUpdateParams {
|
|
|
2066
1961
|
* MCP servers attached to the assistant. Create MCP servers with
|
|
2067
1962
|
* `/ai/mcp_servers`, then reference them by `id` here.
|
|
2068
1963
|
*/
|
|
2069
|
-
mcp_servers?: Array<
|
|
1964
|
+
mcp_servers?: Array<AssistantMcpServer>;
|
|
2070
1965
|
messaging_settings?: MessagingSettings;
|
|
2071
1966
|
/**
|
|
2072
1967
|
* ID of the model to use when `external_llm` is not set. You can use the
|
|
@@ -2121,109 +2016,6 @@ export interface AssistantUpdateParams {
|
|
|
2121
2016
|
*/
|
|
2122
2017
|
widget_settings?: WidgetSettings;
|
|
2123
2018
|
}
|
|
2124
|
-
export declare namespace AssistantUpdateParams {
|
|
2125
|
-
/**
|
|
2126
|
-
* Reference to a connected integration attached to an assistant. Discover
|
|
2127
|
-
* available integrations with `/ai/integrations` and connected integrations with
|
|
2128
|
-
* `/ai/integrations/connections`.
|
|
2129
|
-
*/
|
|
2130
|
-
interface Integration {
|
|
2131
|
-
/**
|
|
2132
|
-
* Catalog integration ID to attach. This is the `id` from the integrations catalog
|
|
2133
|
-
* at `/ai/integrations` (the same value also appears as `integration_id` on
|
|
2134
|
-
* entries returned by `/ai/integrations/connections`). It is **not** the
|
|
2135
|
-
* connection-level `id` from `/ai/integrations/connections`.
|
|
2136
|
-
*/
|
|
2137
|
-
integration_id: string;
|
|
2138
|
-
/**
|
|
2139
|
-
* Optional per-assistant allowlist of integration tool names. When omitted or
|
|
2140
|
-
* empty, all tools allowed by the connected integration are available to the
|
|
2141
|
-
* assistant.
|
|
2142
|
-
*/
|
|
2143
|
-
allowed_list?: Array<string>;
|
|
2144
|
-
}
|
|
2145
|
-
/**
|
|
2146
|
-
* Settings for interruptions and how the assistant decides the user has finished
|
|
2147
|
-
* speaking. These timings are most relevant when using non turn-taking
|
|
2148
|
-
* transcription models. For turn-taking models like `deepgram/flux`, end-of-turn
|
|
2149
|
-
* behavior is controlled by the transcription end-of-turn settings under
|
|
2150
|
-
* `transcription.settings` (`eot_threshold`, `eot_timeout_ms`,
|
|
2151
|
-
* `eager_eot_threshold`).
|
|
2152
|
-
*/
|
|
2153
|
-
interface InterruptionSettings {
|
|
2154
|
-
/**
|
|
2155
|
-
* Whether users can interrupt the assistant while it is speaking.
|
|
2156
|
-
*/
|
|
2157
|
-
enable?: boolean;
|
|
2158
|
-
/**
|
|
2159
|
-
* Controls when the assistant starts speaking after the user stops. These
|
|
2160
|
-
* thresholds primarily apply to non turn-taking transcription models. For
|
|
2161
|
-
* turn-taking models like `deepgram/flux`, end-of-turn detection is driven by the
|
|
2162
|
-
* transcription end-of-turn settings under `transcription.settings` instead.
|
|
2163
|
-
*/
|
|
2164
|
-
start_speaking_plan?: InterruptionSettings.StartSpeakingPlan;
|
|
2165
|
-
}
|
|
2166
|
-
namespace InterruptionSettings {
|
|
2167
|
-
/**
|
|
2168
|
-
* Controls when the assistant starts speaking after the user stops. These
|
|
2169
|
-
* thresholds primarily apply to non turn-taking transcription models. For
|
|
2170
|
-
* turn-taking models like `deepgram/flux`, end-of-turn detection is driven by the
|
|
2171
|
-
* transcription end-of-turn settings under `transcription.settings` instead.
|
|
2172
|
-
*/
|
|
2173
|
-
interface StartSpeakingPlan {
|
|
2174
|
-
/**
|
|
2175
|
-
* Endpointing thresholds used to decide when the user has finished speaking.
|
|
2176
|
-
* Applies to non turn-taking transcription models. For `deepgram/flux`, use
|
|
2177
|
-
* `transcription.settings.eot_threshold` / `eot_timeout_ms` /
|
|
2178
|
-
* `eager_eot_threshold`.
|
|
2179
|
-
*/
|
|
2180
|
-
transcription_endpointing_plan?: StartSpeakingPlan.TranscriptionEndpointingPlan;
|
|
2181
|
-
/**
|
|
2182
|
-
* Minimum seconds to wait before the assistant starts speaking.
|
|
2183
|
-
*/
|
|
2184
|
-
wait_seconds?: number;
|
|
2185
|
-
}
|
|
2186
|
-
namespace StartSpeakingPlan {
|
|
2187
|
-
/**
|
|
2188
|
-
* Endpointing thresholds used to decide when the user has finished speaking.
|
|
2189
|
-
* Applies to non turn-taking transcription models. For `deepgram/flux`, use
|
|
2190
|
-
* `transcription.settings.eot_threshold` / `eot_timeout_ms` /
|
|
2191
|
-
* `eager_eot_threshold`.
|
|
2192
|
-
*/
|
|
2193
|
-
interface TranscriptionEndpointingPlan {
|
|
2194
|
-
/**
|
|
2195
|
-
* Seconds to wait after the transcript ends without punctuation.
|
|
2196
|
-
*/
|
|
2197
|
-
on_no_punctuation_seconds?: number;
|
|
2198
|
-
/**
|
|
2199
|
-
* Seconds to wait after the transcript ends with a number.
|
|
2200
|
-
*/
|
|
2201
|
-
on_number_seconds?: number;
|
|
2202
|
-
/**
|
|
2203
|
-
* Seconds to wait after the transcript ends with punctuation.
|
|
2204
|
-
*/
|
|
2205
|
-
on_punctuation_seconds?: number;
|
|
2206
|
-
}
|
|
2207
|
-
}
|
|
2208
|
-
}
|
|
2209
|
-
/**
|
|
2210
|
-
* Reference to an MCP server attached to an assistant. Create and manage MCP
|
|
2211
|
-
* servers with the `/ai/mcp_servers` endpoints, then attach them to assistants by
|
|
2212
|
-
* ID.
|
|
2213
|
-
*/
|
|
2214
|
-
interface McpServer {
|
|
2215
|
-
/**
|
|
2216
|
-
* ID of the MCP server to attach. This must be the `id` of an MCP server returned
|
|
2217
|
-
* by the `/ai/mcp_servers` endpoints.
|
|
2218
|
-
*/
|
|
2219
|
-
id: string;
|
|
2220
|
-
/**
|
|
2221
|
-
* Optional per-assistant allowlist of MCP tool names. When omitted, the assistant
|
|
2222
|
-
* uses the MCP server's configured `allowed_tools`.
|
|
2223
|
-
*/
|
|
2224
|
-
allowed_tools?: Array<string>;
|
|
2225
|
-
}
|
|
2226
|
-
}
|
|
2227
2019
|
export interface AssistantChatParams {
|
|
2228
2020
|
/**
|
|
2229
2021
|
* The message content sent by the client to the assistant
|
|
@@ -2265,9 +2057,9 @@ export interface AssistantSendSMSParams {
|
|
|
2265
2057
|
text?: string;
|
|
2266
2058
|
}
|
|
2267
2059
|
export declare namespace Assistants {
|
|
2268
|
-
export { type Assistant as Assistant, type AssistantTool as AssistantTool, type AssistantsList as AssistantsList, type AudioVisualizerConfig as AudioVisualizerConfig, type EnabledFeatures as EnabledFeatures, type ExternalLlm as ExternalLlm, type ExternalLlmReq as ExternalLlmReq, type FallbackConfig as FallbackConfig, type FallbackConfigReq as FallbackConfigReq, type HangupTool as HangupTool, type HangupToolParams as HangupToolParams, type ImportMetadata as ImportMetadata, type InferenceEmbedding as InferenceEmbedding, type InferenceEmbeddingWebhookToolParams as InferenceEmbeddingWebhookToolParams, type InsightSettings as InsightSettings, type MessagingSettings as MessagingSettings, type Observability as Observability, type ObservabilityReq as ObservabilityReq, type PostConversationSettings as PostConversationSettings, type PostConversationSettingsReq as PostConversationSettingsReq, type PrivacySettings as PrivacySettings, type RetrievalTool as RetrievalTool, type TelephonySettings as TelephonySettings, type TranscriptionSettings as TranscriptionSettings, type TranscriptionSettingsConfig as TranscriptionSettingsConfig, type TransferTool as TransferTool, type VoiceSettings as VoiceSettings, type WebhookTool as WebhookTool, type WidgetSettings as WidgetSettings, type AssistantDeleteResponse as AssistantDeleteResponse, type AssistantChatResponse as AssistantChatResponse, type AssistantGetTexmlResponse as AssistantGetTexmlResponse, type AssistantSendSMSResponse as AssistantSendSMSResponse, type AssistantCreateParams as AssistantCreateParams, type AssistantRetrieveParams as AssistantRetrieveParams, type AssistantUpdateParams as AssistantUpdateParams, type AssistantChatParams as AssistantChatParams, type AssistantImportsParams as AssistantImportsParams, type AssistantSendSMSParams as AssistantSendSMSParams, };
|
|
2060
|
+
export { type Assistant as Assistant, type AssistantIntegration as AssistantIntegration, type AssistantMcpServer as AssistantMcpServer, type AssistantTool as AssistantTool, type AssistantsList as AssistantsList, type AudioVisualizerConfig as AudioVisualizerConfig, type EnabledFeatures as EnabledFeatures, type ExternalLlm as ExternalLlm, type ExternalLlmReq as ExternalLlmReq, type FallbackConfig as FallbackConfig, type FallbackConfigReq as FallbackConfigReq, type HangupTool as HangupTool, type HangupToolParams as HangupToolParams, type ImportMetadata as ImportMetadata, type InferenceEmbedding as InferenceEmbedding, type InferenceEmbeddingInterruptionSettings as InferenceEmbeddingInterruptionSettings, type InferenceEmbeddingWebhookToolParams as InferenceEmbeddingWebhookToolParams, type InsightSettings as InsightSettings, type MessagingSettings as MessagingSettings, type Observability as Observability, type ObservabilityReq as ObservabilityReq, type PostConversationSettings as PostConversationSettings, type PostConversationSettingsReq as PostConversationSettingsReq, type PrivacySettings as PrivacySettings, type RetrievalTool as RetrievalTool, type StartSpeakingPlan as StartSpeakingPlan, type TelephonySettings as TelephonySettings, type TranscriptionEndpointingPlan as TranscriptionEndpointingPlan, type TranscriptionSettings as TranscriptionSettings, type TranscriptionSettingsConfig as TranscriptionSettingsConfig, type TransferTool as TransferTool, type VoiceSettings as VoiceSettings, type WebhookTool as WebhookTool, type WidgetSettings as WidgetSettings, type AssistantDeleteResponse as AssistantDeleteResponse, type AssistantChatResponse as AssistantChatResponse, type AssistantGetTexmlResponse as AssistantGetTexmlResponse, type AssistantSendSMSResponse as AssistantSendSMSResponse, type AssistantCreateParams as AssistantCreateParams, type AssistantRetrieveParams as AssistantRetrieveParams, type AssistantUpdateParams as AssistantUpdateParams, type AssistantChatParams as AssistantChatParams, type AssistantImportsParams as AssistantImportsParams, type AssistantSendSMSParams as AssistantSendSMSParams, };
|
|
2269
2061
|
export { Tests as Tests, type AssistantTest as AssistantTest, type TelnyxConversationChannel as TelnyxConversationChannel, type AssistantTestsDefaultFlatPagination as AssistantTestsDefaultFlatPagination, type TestCreateParams as TestCreateParams, type TestUpdateParams as TestUpdateParams, type TestListParams as TestListParams, };
|
|
2270
|
-
export { CanaryDeploys as CanaryDeploys, type CanaryDeploy as CanaryDeploy, type CanaryDeployResponse as CanaryDeployResponse, type CanaryDeployCreateParams as CanaryDeployCreateParams, type CanaryDeployUpdateParams as CanaryDeployUpdateParams, };
|
|
2062
|
+
export { CanaryDeploys as CanaryDeploys, type CanaryDeploy as CanaryDeploy, type CanaryDeployResponse as CanaryDeployResponse, type Clause as Clause, type RolloutSlot as RolloutSlot, type RuleInput as RuleInput, type RuleOutput as RuleOutput, type Serve as Serve, type CanaryDeployCreateParams as CanaryDeployCreateParams, type CanaryDeployUpdateParams as CanaryDeployUpdateParams, };
|
|
2271
2063
|
export { ScheduledEvents as ScheduledEvents, type ConversationChannelType as ConversationChannelType, type EventStatus as EventStatus, type ScheduledEventResponse as ScheduledEventResponse, type ScheduledPhoneCallEventResponse as ScheduledPhoneCallEventResponse, type ScheduledSMSEventResponse as ScheduledSMSEventResponse, type ScheduledEventListResponse as ScheduledEventListResponse, type ScheduledEventListResponsesDefaultFlatPagination as ScheduledEventListResponsesDefaultFlatPagination, type ScheduledEventCreateParams as ScheduledEventCreateParams, type ScheduledEventRetrieveParams as ScheduledEventRetrieveParams, type ScheduledEventListParams as ScheduledEventListParams, type ScheduledEventDeleteParams as ScheduledEventDeleteParams, };
|
|
2272
2064
|
export { Tools as Tools, type ToolAddResponse as ToolAddResponse, type ToolRemoveResponse as ToolRemoveResponse, type ToolTestResponse as ToolTestResponse, type ToolAddParams as ToolAddParams, type ToolRemoveParams as ToolRemoveParams, type ToolTestParams as ToolTestParams, };
|
|
2273
2065
|
export { Versions as Versions, type UpdateAssistant as UpdateAssistant, type VersionRetrieveParams as VersionRetrieveParams, type VersionUpdateParams as VersionUpdateParams, type VersionDeleteParams as VersionDeleteParams, type VersionPromoteParams as VersionPromoteParams, };
|