retell-sdk 4.60.0 → 4.62.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 +18 -0
- package/package.json +1 -1
- package/resources/agent.d.ts +57 -6
- package/resources/agent.d.ts.map +1 -1
- package/resources/batch-call.d.ts +21 -4
- package/resources/batch-call.d.ts.map +1 -1
- package/resources/call.d.ts +153 -16
- package/resources/call.d.ts.map +1 -1
- package/resources/chat-agent.d.ts +74 -3
- package/resources/chat-agent.d.ts.map +1 -1
- package/resources/chat-agent.js +33 -0
- package/resources/chat-agent.js.map +1 -1
- package/resources/chat-agent.mjs +33 -0
- package/resources/chat-agent.mjs.map +1 -1
- package/resources/conversation-flow.d.ts +532 -40
- package/resources/conversation-flow.d.ts.map +1 -1
- package/resources/conversation-flow.js +1 -1
- package/resources/conversation-flow.mjs +1 -1
- package/resources/llm.d.ts +501 -9
- package/resources/llm.d.ts.map +1 -1
- package/src/resources/agent.ts +72 -27
- package/src/resources/batch-call.ts +34 -27
- package/src/resources/call.ts +210 -85
- package/src/resources/chat-agent.ts +101 -27
- package/src/resources/conversation-flow.ts +794 -326
- package/src/resources/llm.ts +621 -33
- package/src/version.ts +1 -1
- package/version.d.ts +1 -1
- package/version.js +1 -1
- package/version.mjs +1 -1
|
@@ -13,7 +13,7 @@ export class ConversationFlow extends APIResource {
|
|
|
13
13
|
* ```ts
|
|
14
14
|
* const conversationFlowResponse =
|
|
15
15
|
* await client.conversationFlow.create({
|
|
16
|
-
* model_choice: { model: 'gpt-
|
|
16
|
+
* model_choice: { model: 'gpt-4.1', type: 'cascading' },
|
|
17
17
|
* nodes: [
|
|
18
18
|
* {
|
|
19
19
|
* id: 'start',
|
|
@@ -624,18 +624,14 @@ export namespace ConversationFlowResponse {
|
|
|
624
624
|
* The LLM model to use
|
|
625
625
|
*/
|
|
626
626
|
model:
|
|
627
|
-
| 'gpt-5'
|
|
628
|
-
| 'gpt-5-mini'
|
|
629
|
-
| 'gpt-5-nano'
|
|
630
|
-
| 'gpt-4o'
|
|
631
|
-
| 'gpt-4o-mini'
|
|
632
627
|
| 'gpt-4.1'
|
|
633
628
|
| 'gpt-4.1-mini'
|
|
634
629
|
| 'gpt-4.1-nano'
|
|
635
|
-
| '
|
|
636
|
-
| '
|
|
637
|
-
| '
|
|
638
|
-
| '
|
|
630
|
+
| 'gpt-5'
|
|
631
|
+
| 'gpt-5-mini'
|
|
632
|
+
| 'gpt-5-nano'
|
|
633
|
+
| 'claude-4.5-sonnet'
|
|
634
|
+
| 'claude-4.5-haiku'
|
|
639
635
|
| 'gemini-2.5-flash'
|
|
640
636
|
| 'gemini-2.5-flash-lite';
|
|
641
637
|
|
|
@@ -1149,18 +1145,14 @@ export namespace ConversationFlowResponse {
|
|
|
1149
1145
|
* The LLM model to use
|
|
1150
1146
|
*/
|
|
1151
1147
|
model:
|
|
1152
|
-
| 'gpt-5'
|
|
1153
|
-
| 'gpt-5-mini'
|
|
1154
|
-
| 'gpt-5-nano'
|
|
1155
|
-
| 'gpt-4o'
|
|
1156
|
-
| 'gpt-4o-mini'
|
|
1157
1148
|
| 'gpt-4.1'
|
|
1158
1149
|
| 'gpt-4.1-mini'
|
|
1159
1150
|
| 'gpt-4.1-nano'
|
|
1160
|
-
| '
|
|
1161
|
-
| '
|
|
1162
|
-
| '
|
|
1163
|
-
| '
|
|
1151
|
+
| 'gpt-5'
|
|
1152
|
+
| 'gpt-5-mini'
|
|
1153
|
+
| 'gpt-5-nano'
|
|
1154
|
+
| 'claude-4.5-sonnet'
|
|
1155
|
+
| 'claude-4.5-haiku'
|
|
1164
1156
|
| 'gemini-2.5-flash'
|
|
1165
1157
|
| 'gemini-2.5-flash-lite';
|
|
1166
1158
|
|
|
@@ -1190,7 +1182,8 @@ export namespace ConversationFlowResponse {
|
|
|
1190
1182
|
|
|
1191
1183
|
transfer_option:
|
|
1192
1184
|
| TransferCallNode.TransferOptionColdTransfer
|
|
1193
|
-
| TransferCallNode.TransferOptionWarmTransfer
|
|
1185
|
+
| TransferCallNode.TransferOptionWarmTransfer
|
|
1186
|
+
| TransferCallNode.TransferOptionAgenticWarmTransfer;
|
|
1194
1187
|
|
|
1195
1188
|
/**
|
|
1196
1189
|
* Type of the node
|
|
@@ -1458,6 +1451,105 @@ export namespace ConversationFlowResponse {
|
|
|
1458
1451
|
}
|
|
1459
1452
|
}
|
|
1460
1453
|
|
|
1454
|
+
export interface TransferOptionAgenticWarmTransfer {
|
|
1455
|
+
/**
|
|
1456
|
+
* Configuration for agentic warm transfer. Required for agentic warm transfer.
|
|
1457
|
+
*/
|
|
1458
|
+
agentic_transfer_config: TransferOptionAgenticWarmTransfer.AgenticTransferConfig;
|
|
1459
|
+
|
|
1460
|
+
/**
|
|
1461
|
+
* The type of the transfer.
|
|
1462
|
+
*/
|
|
1463
|
+
type: 'agentic_warm_transfer';
|
|
1464
|
+
|
|
1465
|
+
/**
|
|
1466
|
+
* Whether to play an audio cue when bridging the call. Defaults to true.
|
|
1467
|
+
*/
|
|
1468
|
+
enable_bridge_audio_cue?: boolean;
|
|
1469
|
+
|
|
1470
|
+
/**
|
|
1471
|
+
* The music to play while the caller is being transferred.
|
|
1472
|
+
*/
|
|
1473
|
+
on_hold_music?: 'none' | 'relaxing_sound' | 'uplifting_beats' | 'ringtone';
|
|
1474
|
+
|
|
1475
|
+
/**
|
|
1476
|
+
* If set, when transfer is successful, will say the handoff message to both the
|
|
1477
|
+
* transferee and the agent receiving the transfer. Can leave either a static
|
|
1478
|
+
* message or a dynamic one based on prompt. Set to null to disable warm handoff.
|
|
1479
|
+
*/
|
|
1480
|
+
public_handoff_option?:
|
|
1481
|
+
| TransferOptionAgenticWarmTransfer.WarmTransferPrompt
|
|
1482
|
+
| TransferOptionAgenticWarmTransfer.WarmTransferStaticMessage;
|
|
1483
|
+
|
|
1484
|
+
/**
|
|
1485
|
+
* If set to true, will show transferee (the user, not the AI agent) as caller when
|
|
1486
|
+
* transferring, requires the telephony side to support caller id override. Retell
|
|
1487
|
+
* Twilio numbers support this option.
|
|
1488
|
+
*/
|
|
1489
|
+
show_transferee_as_caller?: boolean;
|
|
1490
|
+
}
|
|
1491
|
+
|
|
1492
|
+
export namespace TransferOptionAgenticWarmTransfer {
|
|
1493
|
+
/**
|
|
1494
|
+
* Configuration for agentic warm transfer. Required for agentic warm transfer.
|
|
1495
|
+
*/
|
|
1496
|
+
export interface AgenticTransferConfig {
|
|
1497
|
+
/**
|
|
1498
|
+
* The action to take when the transfer agent times out without making a decision.
|
|
1499
|
+
* Defaults to cancel_transfer.
|
|
1500
|
+
*/
|
|
1501
|
+
action_on_timeout?: 'bridge_transfer' | 'cancel_transfer';
|
|
1502
|
+
|
|
1503
|
+
/**
|
|
1504
|
+
* The agent that will mediate the transfer decision.
|
|
1505
|
+
*/
|
|
1506
|
+
transfer_agent?: AgenticTransferConfig.TransferAgent;
|
|
1507
|
+
|
|
1508
|
+
/**
|
|
1509
|
+
* The maximum time to wait for the transfer agent to make a decision, in
|
|
1510
|
+
* milliseconds. Defaults to 30000 (30 seconds).
|
|
1511
|
+
*/
|
|
1512
|
+
transfer_timeout_ms?: number;
|
|
1513
|
+
}
|
|
1514
|
+
|
|
1515
|
+
export namespace AgenticTransferConfig {
|
|
1516
|
+
/**
|
|
1517
|
+
* The agent that will mediate the transfer decision.
|
|
1518
|
+
*/
|
|
1519
|
+
export interface TransferAgent {
|
|
1520
|
+
/**
|
|
1521
|
+
* The agent ID of the transfer agent. This agent must have isTransferAgent set to
|
|
1522
|
+
* true and should use bridge_transfer and cancel_transfer tools (for Retell LLM)
|
|
1523
|
+
* or BridgeTransferNode and CancelTransferNode (for Conversation Flow).
|
|
1524
|
+
*/
|
|
1525
|
+
agent_id: string;
|
|
1526
|
+
|
|
1527
|
+
/**
|
|
1528
|
+
* The version of the transfer agent to use.
|
|
1529
|
+
*/
|
|
1530
|
+
agent_version: number;
|
|
1531
|
+
}
|
|
1532
|
+
}
|
|
1533
|
+
|
|
1534
|
+
export interface WarmTransferPrompt {
|
|
1535
|
+
/**
|
|
1536
|
+
* The prompt to be used for warm handoff. Can contain dynamic variables.
|
|
1537
|
+
*/
|
|
1538
|
+
prompt?: string;
|
|
1539
|
+
|
|
1540
|
+
type?: 'prompt';
|
|
1541
|
+
}
|
|
1542
|
+
|
|
1543
|
+
export interface WarmTransferStaticMessage {
|
|
1544
|
+
/**
|
|
1545
|
+
* The static message to be used for warm handoff. Can contain dynamic variables.
|
|
1546
|
+
*/
|
|
1547
|
+
message?: string;
|
|
1548
|
+
|
|
1549
|
+
type?: 'static_message';
|
|
1550
|
+
}
|
|
1551
|
+
}
|
|
1552
|
+
|
|
1461
1553
|
/**
|
|
1462
1554
|
* Position for frontend display
|
|
1463
1555
|
*/
|
|
@@ -1565,18 +1657,14 @@ export namespace ConversationFlowResponse {
|
|
|
1565
1657
|
* The LLM model to use
|
|
1566
1658
|
*/
|
|
1567
1659
|
model:
|
|
1568
|
-
| 'gpt-5'
|
|
1569
|
-
| 'gpt-5-mini'
|
|
1570
|
-
| 'gpt-5-nano'
|
|
1571
|
-
| 'gpt-4o'
|
|
1572
|
-
| 'gpt-4o-mini'
|
|
1573
1660
|
| 'gpt-4.1'
|
|
1574
1661
|
| 'gpt-4.1-mini'
|
|
1575
1662
|
| 'gpt-4.1-nano'
|
|
1576
|
-
| '
|
|
1577
|
-
| '
|
|
1578
|
-
| '
|
|
1579
|
-
| '
|
|
1663
|
+
| 'gpt-5'
|
|
1664
|
+
| 'gpt-5-mini'
|
|
1665
|
+
| 'gpt-5-nano'
|
|
1666
|
+
| 'claude-4.5-sonnet'
|
|
1667
|
+
| 'claude-4.5-haiku'
|
|
1580
1668
|
| 'gemini-2.5-flash'
|
|
1581
1669
|
| 'gemini-2.5-flash-lite';
|
|
1582
1670
|
|
|
@@ -1856,18 +1944,14 @@ export namespace ConversationFlowResponse {
|
|
|
1856
1944
|
* The LLM model to use
|
|
1857
1945
|
*/
|
|
1858
1946
|
model:
|
|
1859
|
-
| 'gpt-5'
|
|
1860
|
-
| 'gpt-5-mini'
|
|
1861
|
-
| 'gpt-5-nano'
|
|
1862
|
-
| 'gpt-4o'
|
|
1863
|
-
| 'gpt-4o-mini'
|
|
1864
1947
|
| 'gpt-4.1'
|
|
1865
1948
|
| 'gpt-4.1-mini'
|
|
1866
1949
|
| 'gpt-4.1-nano'
|
|
1867
|
-
| '
|
|
1868
|
-
| '
|
|
1869
|
-
| '
|
|
1870
|
-
| '
|
|
1950
|
+
| 'gpt-5'
|
|
1951
|
+
| 'gpt-5-mini'
|
|
1952
|
+
| 'gpt-5-nano'
|
|
1953
|
+
| 'claude-4.5-sonnet'
|
|
1954
|
+
| 'claude-4.5-haiku'
|
|
1871
1955
|
| 'gemini-2.5-flash'
|
|
1872
1956
|
| 'gemini-2.5-flash-lite';
|
|
1873
1957
|
|
|
@@ -2840,18 +2924,14 @@ export namespace ConversationFlowResponse {
|
|
|
2840
2924
|
* The LLM model to use
|
|
2841
2925
|
*/
|
|
2842
2926
|
model:
|
|
2843
|
-
| 'gpt-5'
|
|
2844
|
-
| 'gpt-5-mini'
|
|
2845
|
-
| 'gpt-5-nano'
|
|
2846
|
-
| 'gpt-4o'
|
|
2847
|
-
| 'gpt-4o-mini'
|
|
2848
2927
|
| 'gpt-4.1'
|
|
2849
2928
|
| 'gpt-4.1-mini'
|
|
2850
2929
|
| 'gpt-4.1-nano'
|
|
2851
|
-
| '
|
|
2852
|
-
| '
|
|
2853
|
-
| '
|
|
2854
|
-
| '
|
|
2930
|
+
| 'gpt-5'
|
|
2931
|
+
| 'gpt-5-mini'
|
|
2932
|
+
| 'gpt-5-nano'
|
|
2933
|
+
| 'claude-4.5-sonnet'
|
|
2934
|
+
| 'claude-4.5-haiku'
|
|
2855
2935
|
| 'gemini-2.5-flash'
|
|
2856
2936
|
| 'gemini-2.5-flash-lite';
|
|
2857
2937
|
|
|
@@ -3908,18 +3988,14 @@ export namespace ConversationFlowResponse {
|
|
|
3908
3988
|
* The LLM model to use
|
|
3909
3989
|
*/
|
|
3910
3990
|
model:
|
|
3911
|
-
| 'gpt-5'
|
|
3912
|
-
| 'gpt-5-mini'
|
|
3913
|
-
| 'gpt-5-nano'
|
|
3914
|
-
| 'gpt-4o'
|
|
3915
|
-
| 'gpt-4o-mini'
|
|
3916
3991
|
| 'gpt-4.1'
|
|
3917
3992
|
| 'gpt-4.1-mini'
|
|
3918
3993
|
| 'gpt-4.1-nano'
|
|
3919
|
-
| '
|
|
3920
|
-
| '
|
|
3921
|
-
| '
|
|
3922
|
-
| '
|
|
3994
|
+
| 'gpt-5'
|
|
3995
|
+
| 'gpt-5-mini'
|
|
3996
|
+
| 'gpt-5-nano'
|
|
3997
|
+
| 'claude-4.5-sonnet'
|
|
3998
|
+
| 'claude-4.5-haiku'
|
|
3923
3999
|
| 'gemini-2.5-flash'
|
|
3924
4000
|
| 'gemini-2.5-flash-lite';
|
|
3925
4001
|
|
|
@@ -4258,18 +4334,14 @@ export namespace ConversationFlowResponse {
|
|
|
4258
4334
|
* The LLM model to use
|
|
4259
4335
|
*/
|
|
4260
4336
|
model:
|
|
4261
|
-
| 'gpt-5'
|
|
4262
|
-
| 'gpt-5-mini'
|
|
4263
|
-
| 'gpt-5-nano'
|
|
4264
|
-
| 'gpt-4o'
|
|
4265
|
-
| 'gpt-4o-mini'
|
|
4266
4337
|
| 'gpt-4.1'
|
|
4267
4338
|
| 'gpt-4.1-mini'
|
|
4268
4339
|
| 'gpt-4.1-nano'
|
|
4269
|
-
| '
|
|
4270
|
-
| '
|
|
4271
|
-
| '
|
|
4272
|
-
| '
|
|
4340
|
+
| 'gpt-5'
|
|
4341
|
+
| 'gpt-5-mini'
|
|
4342
|
+
| 'gpt-5-nano'
|
|
4343
|
+
| 'claude-4.5-sonnet'
|
|
4344
|
+
| 'claude-4.5-haiku'
|
|
4273
4345
|
| 'gemini-2.5-flash'
|
|
4274
4346
|
| 'gemini-2.5-flash-lite';
|
|
4275
4347
|
|
|
@@ -4783,18 +4855,14 @@ export namespace ConversationFlowResponse {
|
|
|
4783
4855
|
* The LLM model to use
|
|
4784
4856
|
*/
|
|
4785
4857
|
model:
|
|
4786
|
-
| 'gpt-5'
|
|
4787
|
-
| 'gpt-5-mini'
|
|
4788
|
-
| 'gpt-5-nano'
|
|
4789
|
-
| 'gpt-4o'
|
|
4790
|
-
| 'gpt-4o-mini'
|
|
4791
4858
|
| 'gpt-4.1'
|
|
4792
4859
|
| 'gpt-4.1-mini'
|
|
4793
4860
|
| 'gpt-4.1-nano'
|
|
4794
|
-
| '
|
|
4795
|
-
| '
|
|
4796
|
-
| '
|
|
4797
|
-
| '
|
|
4861
|
+
| 'gpt-5'
|
|
4862
|
+
| 'gpt-5-mini'
|
|
4863
|
+
| 'gpt-5-nano'
|
|
4864
|
+
| 'claude-4.5-sonnet'
|
|
4865
|
+
| 'claude-4.5-haiku'
|
|
4798
4866
|
| 'gemini-2.5-flash'
|
|
4799
4867
|
| 'gemini-2.5-flash-lite';
|
|
4800
4868
|
|
|
@@ -4824,7 +4892,8 @@ export namespace ConversationFlowResponse {
|
|
|
4824
4892
|
|
|
4825
4893
|
transfer_option:
|
|
4826
4894
|
| TransferCallNode.TransferOptionColdTransfer
|
|
4827
|
-
| TransferCallNode.TransferOptionWarmTransfer
|
|
4895
|
+
| TransferCallNode.TransferOptionWarmTransfer
|
|
4896
|
+
| TransferCallNode.TransferOptionAgenticWarmTransfer;
|
|
4828
4897
|
|
|
4829
4898
|
/**
|
|
4830
4899
|
* Type of the node
|
|
@@ -5092,6 +5161,105 @@ export namespace ConversationFlowResponse {
|
|
|
5092
5161
|
}
|
|
5093
5162
|
}
|
|
5094
5163
|
|
|
5164
|
+
export interface TransferOptionAgenticWarmTransfer {
|
|
5165
|
+
/**
|
|
5166
|
+
* Configuration for agentic warm transfer. Required for agentic warm transfer.
|
|
5167
|
+
*/
|
|
5168
|
+
agentic_transfer_config: TransferOptionAgenticWarmTransfer.AgenticTransferConfig;
|
|
5169
|
+
|
|
5170
|
+
/**
|
|
5171
|
+
* The type of the transfer.
|
|
5172
|
+
*/
|
|
5173
|
+
type: 'agentic_warm_transfer';
|
|
5174
|
+
|
|
5175
|
+
/**
|
|
5176
|
+
* Whether to play an audio cue when bridging the call. Defaults to true.
|
|
5177
|
+
*/
|
|
5178
|
+
enable_bridge_audio_cue?: boolean;
|
|
5179
|
+
|
|
5180
|
+
/**
|
|
5181
|
+
* The music to play while the caller is being transferred.
|
|
5182
|
+
*/
|
|
5183
|
+
on_hold_music?: 'none' | 'relaxing_sound' | 'uplifting_beats' | 'ringtone';
|
|
5184
|
+
|
|
5185
|
+
/**
|
|
5186
|
+
* If set, when transfer is successful, will say the handoff message to both the
|
|
5187
|
+
* transferee and the agent receiving the transfer. Can leave either a static
|
|
5188
|
+
* message or a dynamic one based on prompt. Set to null to disable warm handoff.
|
|
5189
|
+
*/
|
|
5190
|
+
public_handoff_option?:
|
|
5191
|
+
| TransferOptionAgenticWarmTransfer.WarmTransferPrompt
|
|
5192
|
+
| TransferOptionAgenticWarmTransfer.WarmTransferStaticMessage;
|
|
5193
|
+
|
|
5194
|
+
/**
|
|
5195
|
+
* If set to true, will show transferee (the user, not the AI agent) as caller when
|
|
5196
|
+
* transferring, requires the telephony side to support caller id override. Retell
|
|
5197
|
+
* Twilio numbers support this option.
|
|
5198
|
+
*/
|
|
5199
|
+
show_transferee_as_caller?: boolean;
|
|
5200
|
+
}
|
|
5201
|
+
|
|
5202
|
+
export namespace TransferOptionAgenticWarmTransfer {
|
|
5203
|
+
/**
|
|
5204
|
+
* Configuration for agentic warm transfer. Required for agentic warm transfer.
|
|
5205
|
+
*/
|
|
5206
|
+
export interface AgenticTransferConfig {
|
|
5207
|
+
/**
|
|
5208
|
+
* The action to take when the transfer agent times out without making a decision.
|
|
5209
|
+
* Defaults to cancel_transfer.
|
|
5210
|
+
*/
|
|
5211
|
+
action_on_timeout?: 'bridge_transfer' | 'cancel_transfer';
|
|
5212
|
+
|
|
5213
|
+
/**
|
|
5214
|
+
* The agent that will mediate the transfer decision.
|
|
5215
|
+
*/
|
|
5216
|
+
transfer_agent?: AgenticTransferConfig.TransferAgent;
|
|
5217
|
+
|
|
5218
|
+
/**
|
|
5219
|
+
* The maximum time to wait for the transfer agent to make a decision, in
|
|
5220
|
+
* milliseconds. Defaults to 30000 (30 seconds).
|
|
5221
|
+
*/
|
|
5222
|
+
transfer_timeout_ms?: number;
|
|
5223
|
+
}
|
|
5224
|
+
|
|
5225
|
+
export namespace AgenticTransferConfig {
|
|
5226
|
+
/**
|
|
5227
|
+
* The agent that will mediate the transfer decision.
|
|
5228
|
+
*/
|
|
5229
|
+
export interface TransferAgent {
|
|
5230
|
+
/**
|
|
5231
|
+
* The agent ID of the transfer agent. This agent must have isTransferAgent set to
|
|
5232
|
+
* true and should use bridge_transfer and cancel_transfer tools (for Retell LLM)
|
|
5233
|
+
* or BridgeTransferNode and CancelTransferNode (for Conversation Flow).
|
|
5234
|
+
*/
|
|
5235
|
+
agent_id: string;
|
|
5236
|
+
|
|
5237
|
+
/**
|
|
5238
|
+
* The version of the transfer agent to use.
|
|
5239
|
+
*/
|
|
5240
|
+
agent_version: number;
|
|
5241
|
+
}
|
|
5242
|
+
}
|
|
5243
|
+
|
|
5244
|
+
export interface WarmTransferPrompt {
|
|
5245
|
+
/**
|
|
5246
|
+
* The prompt to be used for warm handoff. Can contain dynamic variables.
|
|
5247
|
+
*/
|
|
5248
|
+
prompt?: string;
|
|
5249
|
+
|
|
5250
|
+
type?: 'prompt';
|
|
5251
|
+
}
|
|
5252
|
+
|
|
5253
|
+
export interface WarmTransferStaticMessage {
|
|
5254
|
+
/**
|
|
5255
|
+
* The static message to be used for warm handoff. Can contain dynamic variables.
|
|
5256
|
+
*/
|
|
5257
|
+
message?: string;
|
|
5258
|
+
|
|
5259
|
+
type?: 'static_message';
|
|
5260
|
+
}
|
|
5261
|
+
}
|
|
5262
|
+
|
|
5095
5263
|
/**
|
|
5096
5264
|
* Position for frontend display
|
|
5097
5265
|
*/
|
|
@@ -5199,18 +5367,14 @@ export namespace ConversationFlowResponse {
|
|
|
5199
5367
|
* The LLM model to use
|
|
5200
5368
|
*/
|
|
5201
5369
|
model:
|
|
5202
|
-
| 'gpt-5'
|
|
5203
|
-
| 'gpt-5-mini'
|
|
5204
|
-
| 'gpt-5-nano'
|
|
5205
|
-
| 'gpt-4o'
|
|
5206
|
-
| 'gpt-4o-mini'
|
|
5207
5370
|
| 'gpt-4.1'
|
|
5208
5371
|
| 'gpt-4.1-mini'
|
|
5209
5372
|
| 'gpt-4.1-nano'
|
|
5210
|
-
| '
|
|
5211
|
-
| '
|
|
5212
|
-
| '
|
|
5213
|
-
| '
|
|
5373
|
+
| 'gpt-5'
|
|
5374
|
+
| 'gpt-5-mini'
|
|
5375
|
+
| 'gpt-5-nano'
|
|
5376
|
+
| 'claude-4.5-sonnet'
|
|
5377
|
+
| 'claude-4.5-haiku'
|
|
5214
5378
|
| 'gemini-2.5-flash'
|
|
5215
5379
|
| 'gemini-2.5-flash-lite';
|
|
5216
5380
|
|
|
@@ -5490,18 +5654,14 @@ export namespace ConversationFlowResponse {
|
|
|
5490
5654
|
* The LLM model to use
|
|
5491
5655
|
*/
|
|
5492
5656
|
model:
|
|
5493
|
-
| 'gpt-5'
|
|
5494
|
-
| 'gpt-5-mini'
|
|
5495
|
-
| 'gpt-5-nano'
|
|
5496
|
-
| 'gpt-4o'
|
|
5497
|
-
| 'gpt-4o-mini'
|
|
5498
5657
|
| 'gpt-4.1'
|
|
5499
5658
|
| 'gpt-4.1-mini'
|
|
5500
5659
|
| 'gpt-4.1-nano'
|
|
5501
|
-
| '
|
|
5502
|
-
| '
|
|
5503
|
-
| '
|
|
5504
|
-
| '
|
|
5660
|
+
| 'gpt-5'
|
|
5661
|
+
| 'gpt-5-mini'
|
|
5662
|
+
| 'gpt-5-nano'
|
|
5663
|
+
| 'claude-4.5-sonnet'
|
|
5664
|
+
| 'claude-4.5-haiku'
|
|
5505
5665
|
| 'gemini-2.5-flash'
|
|
5506
5666
|
| 'gemini-2.5-flash-lite';
|
|
5507
5667
|
|
|
@@ -6474,18 +6634,14 @@ export namespace ConversationFlowResponse {
|
|
|
6474
6634
|
* The LLM model to use
|
|
6475
6635
|
*/
|
|
6476
6636
|
model:
|
|
6477
|
-
| 'gpt-5'
|
|
6478
|
-
| 'gpt-5-mini'
|
|
6479
|
-
| 'gpt-5-nano'
|
|
6480
|
-
| 'gpt-4o'
|
|
6481
|
-
| 'gpt-4o-mini'
|
|
6482
6637
|
| 'gpt-4.1'
|
|
6483
6638
|
| 'gpt-4.1-mini'
|
|
6484
6639
|
| 'gpt-4.1-nano'
|
|
6485
|
-
| '
|
|
6486
|
-
| '
|
|
6487
|
-
| '
|
|
6488
|
-
| '
|
|
6640
|
+
| 'gpt-5'
|
|
6641
|
+
| 'gpt-5-mini'
|
|
6642
|
+
| 'gpt-5-nano'
|
|
6643
|
+
| 'claude-4.5-sonnet'
|
|
6644
|
+
| 'claude-4.5-haiku'
|
|
6489
6645
|
| 'gemini-2.5-flash'
|
|
6490
6646
|
| 'gemini-2.5-flash-lite';
|
|
6491
6647
|
|
|
@@ -7600,18 +7756,14 @@ export namespace ConversationFlowCreateParams {
|
|
|
7600
7756
|
* The LLM model to use
|
|
7601
7757
|
*/
|
|
7602
7758
|
model:
|
|
7603
|
-
| 'gpt-5'
|
|
7604
|
-
| 'gpt-5-mini'
|
|
7605
|
-
| 'gpt-5-nano'
|
|
7606
|
-
| 'gpt-4o'
|
|
7607
|
-
| 'gpt-4o-mini'
|
|
7608
7759
|
| 'gpt-4.1'
|
|
7609
7760
|
| 'gpt-4.1-mini'
|
|
7610
7761
|
| 'gpt-4.1-nano'
|
|
7611
|
-
| '
|
|
7612
|
-
| '
|
|
7613
|
-
| '
|
|
7614
|
-
| '
|
|
7762
|
+
| 'gpt-5'
|
|
7763
|
+
| 'gpt-5-mini'
|
|
7764
|
+
| 'gpt-5-nano'
|
|
7765
|
+
| 'claude-4.5-sonnet'
|
|
7766
|
+
| 'claude-4.5-haiku'
|
|
7615
7767
|
| 'gemini-2.5-flash'
|
|
7616
7768
|
| 'gemini-2.5-flash-lite';
|
|
7617
7769
|
|
|
@@ -7950,18 +8102,14 @@ export namespace ConversationFlowCreateParams {
|
|
|
7950
8102
|
* The LLM model to use
|
|
7951
8103
|
*/
|
|
7952
8104
|
model:
|
|
7953
|
-
| 'gpt-5'
|
|
7954
|
-
| 'gpt-5-mini'
|
|
7955
|
-
| 'gpt-5-nano'
|
|
7956
|
-
| 'gpt-4o'
|
|
7957
|
-
| 'gpt-4o-mini'
|
|
7958
8105
|
| 'gpt-4.1'
|
|
7959
8106
|
| 'gpt-4.1-mini'
|
|
7960
8107
|
| 'gpt-4.1-nano'
|
|
7961
|
-
| '
|
|
7962
|
-
| '
|
|
7963
|
-
| '
|
|
7964
|
-
| '
|
|
8108
|
+
| 'gpt-5'
|
|
8109
|
+
| 'gpt-5-mini'
|
|
8110
|
+
| 'gpt-5-nano'
|
|
8111
|
+
| 'claude-4.5-sonnet'
|
|
8112
|
+
| 'claude-4.5-haiku'
|
|
7965
8113
|
| 'gemini-2.5-flash'
|
|
7966
8114
|
| 'gemini-2.5-flash-lite';
|
|
7967
8115
|
|
|
@@ -8475,18 +8623,14 @@ export namespace ConversationFlowCreateParams {
|
|
|
8475
8623
|
* The LLM model to use
|
|
8476
8624
|
*/
|
|
8477
8625
|
model:
|
|
8478
|
-
| 'gpt-5'
|
|
8479
|
-
| 'gpt-5-mini'
|
|
8480
|
-
| 'gpt-5-nano'
|
|
8481
|
-
| 'gpt-4o'
|
|
8482
|
-
| 'gpt-4o-mini'
|
|
8483
8626
|
| 'gpt-4.1'
|
|
8484
8627
|
| 'gpt-4.1-mini'
|
|
8485
8628
|
| 'gpt-4.1-nano'
|
|
8486
|
-
| '
|
|
8487
|
-
| '
|
|
8488
|
-
| '
|
|
8489
|
-
| '
|
|
8629
|
+
| 'gpt-5'
|
|
8630
|
+
| 'gpt-5-mini'
|
|
8631
|
+
| 'gpt-5-nano'
|
|
8632
|
+
| 'claude-4.5-sonnet'
|
|
8633
|
+
| 'claude-4.5-haiku'
|
|
8490
8634
|
| 'gemini-2.5-flash'
|
|
8491
8635
|
| 'gemini-2.5-flash-lite';
|
|
8492
8636
|
|
|
@@ -8516,7 +8660,8 @@ export namespace ConversationFlowCreateParams {
|
|
|
8516
8660
|
|
|
8517
8661
|
transfer_option:
|
|
8518
8662
|
| TransferCallNode.TransferOptionColdTransfer
|
|
8519
|
-
| TransferCallNode.TransferOptionWarmTransfer
|
|
8663
|
+
| TransferCallNode.TransferOptionWarmTransfer
|
|
8664
|
+
| TransferCallNode.TransferOptionAgenticWarmTransfer;
|
|
8520
8665
|
|
|
8521
8666
|
/**
|
|
8522
8667
|
* Type of the node
|
|
@@ -8784,6 +8929,105 @@ export namespace ConversationFlowCreateParams {
|
|
|
8784
8929
|
}
|
|
8785
8930
|
}
|
|
8786
8931
|
|
|
8932
|
+
export interface TransferOptionAgenticWarmTransfer {
|
|
8933
|
+
/**
|
|
8934
|
+
* Configuration for agentic warm transfer. Required for agentic warm transfer.
|
|
8935
|
+
*/
|
|
8936
|
+
agentic_transfer_config: TransferOptionAgenticWarmTransfer.AgenticTransferConfig;
|
|
8937
|
+
|
|
8938
|
+
/**
|
|
8939
|
+
* The type of the transfer.
|
|
8940
|
+
*/
|
|
8941
|
+
type: 'agentic_warm_transfer';
|
|
8942
|
+
|
|
8943
|
+
/**
|
|
8944
|
+
* Whether to play an audio cue when bridging the call. Defaults to true.
|
|
8945
|
+
*/
|
|
8946
|
+
enable_bridge_audio_cue?: boolean;
|
|
8947
|
+
|
|
8948
|
+
/**
|
|
8949
|
+
* The music to play while the caller is being transferred.
|
|
8950
|
+
*/
|
|
8951
|
+
on_hold_music?: 'none' | 'relaxing_sound' | 'uplifting_beats' | 'ringtone';
|
|
8952
|
+
|
|
8953
|
+
/**
|
|
8954
|
+
* If set, when transfer is successful, will say the handoff message to both the
|
|
8955
|
+
* transferee and the agent receiving the transfer. Can leave either a static
|
|
8956
|
+
* message or a dynamic one based on prompt. Set to null to disable warm handoff.
|
|
8957
|
+
*/
|
|
8958
|
+
public_handoff_option?:
|
|
8959
|
+
| TransferOptionAgenticWarmTransfer.WarmTransferPrompt
|
|
8960
|
+
| TransferOptionAgenticWarmTransfer.WarmTransferStaticMessage;
|
|
8961
|
+
|
|
8962
|
+
/**
|
|
8963
|
+
* If set to true, will show transferee (the user, not the AI agent) as caller when
|
|
8964
|
+
* transferring, requires the telephony side to support caller id override. Retell
|
|
8965
|
+
* Twilio numbers support this option.
|
|
8966
|
+
*/
|
|
8967
|
+
show_transferee_as_caller?: boolean;
|
|
8968
|
+
}
|
|
8969
|
+
|
|
8970
|
+
export namespace TransferOptionAgenticWarmTransfer {
|
|
8971
|
+
/**
|
|
8972
|
+
* Configuration for agentic warm transfer. Required for agentic warm transfer.
|
|
8973
|
+
*/
|
|
8974
|
+
export interface AgenticTransferConfig {
|
|
8975
|
+
/**
|
|
8976
|
+
* The action to take when the transfer agent times out without making a decision.
|
|
8977
|
+
* Defaults to cancel_transfer.
|
|
8978
|
+
*/
|
|
8979
|
+
action_on_timeout?: 'bridge_transfer' | 'cancel_transfer';
|
|
8980
|
+
|
|
8981
|
+
/**
|
|
8982
|
+
* The agent that will mediate the transfer decision.
|
|
8983
|
+
*/
|
|
8984
|
+
transfer_agent?: AgenticTransferConfig.TransferAgent;
|
|
8985
|
+
|
|
8986
|
+
/**
|
|
8987
|
+
* The maximum time to wait for the transfer agent to make a decision, in
|
|
8988
|
+
* milliseconds. Defaults to 30000 (30 seconds).
|
|
8989
|
+
*/
|
|
8990
|
+
transfer_timeout_ms?: number;
|
|
8991
|
+
}
|
|
8992
|
+
|
|
8993
|
+
export namespace AgenticTransferConfig {
|
|
8994
|
+
/**
|
|
8995
|
+
* The agent that will mediate the transfer decision.
|
|
8996
|
+
*/
|
|
8997
|
+
export interface TransferAgent {
|
|
8998
|
+
/**
|
|
8999
|
+
* The agent ID of the transfer agent. This agent must have isTransferAgent set to
|
|
9000
|
+
* true and should use bridge_transfer and cancel_transfer tools (for Retell LLM)
|
|
9001
|
+
* or BridgeTransferNode and CancelTransferNode (for Conversation Flow).
|
|
9002
|
+
*/
|
|
9003
|
+
agent_id: string;
|
|
9004
|
+
|
|
9005
|
+
/**
|
|
9006
|
+
* The version of the transfer agent to use.
|
|
9007
|
+
*/
|
|
9008
|
+
agent_version: number;
|
|
9009
|
+
}
|
|
9010
|
+
}
|
|
9011
|
+
|
|
9012
|
+
export interface WarmTransferPrompt {
|
|
9013
|
+
/**
|
|
9014
|
+
* The prompt to be used for warm handoff. Can contain dynamic variables.
|
|
9015
|
+
*/
|
|
9016
|
+
prompt?: string;
|
|
9017
|
+
|
|
9018
|
+
type?: 'prompt';
|
|
9019
|
+
}
|
|
9020
|
+
|
|
9021
|
+
export interface WarmTransferStaticMessage {
|
|
9022
|
+
/**
|
|
9023
|
+
* The static message to be used for warm handoff. Can contain dynamic variables.
|
|
9024
|
+
*/
|
|
9025
|
+
message?: string;
|
|
9026
|
+
|
|
9027
|
+
type?: 'static_message';
|
|
9028
|
+
}
|
|
9029
|
+
}
|
|
9030
|
+
|
|
8787
9031
|
/**
|
|
8788
9032
|
* Position for frontend display
|
|
8789
9033
|
*/
|
|
@@ -8891,18 +9135,14 @@ export namespace ConversationFlowCreateParams {
|
|
|
8891
9135
|
* The LLM model to use
|
|
8892
9136
|
*/
|
|
8893
9137
|
model:
|
|
8894
|
-
| 'gpt-5'
|
|
8895
|
-
| 'gpt-5-mini'
|
|
8896
|
-
| 'gpt-5-nano'
|
|
8897
|
-
| 'gpt-4o'
|
|
8898
|
-
| 'gpt-4o-mini'
|
|
8899
9138
|
| 'gpt-4.1'
|
|
8900
9139
|
| 'gpt-4.1-mini'
|
|
8901
9140
|
| 'gpt-4.1-nano'
|
|
8902
|
-
| '
|
|
8903
|
-
| '
|
|
8904
|
-
| '
|
|
8905
|
-
| '
|
|
9141
|
+
| 'gpt-5'
|
|
9142
|
+
| 'gpt-5-mini'
|
|
9143
|
+
| 'gpt-5-nano'
|
|
9144
|
+
| 'claude-4.5-sonnet'
|
|
9145
|
+
| 'claude-4.5-haiku'
|
|
8906
9146
|
| 'gemini-2.5-flash'
|
|
8907
9147
|
| 'gemini-2.5-flash-lite';
|
|
8908
9148
|
|
|
@@ -9182,18 +9422,14 @@ export namespace ConversationFlowCreateParams {
|
|
|
9182
9422
|
* The LLM model to use
|
|
9183
9423
|
*/
|
|
9184
9424
|
model:
|
|
9185
|
-
| 'gpt-5'
|
|
9186
|
-
| 'gpt-5-mini'
|
|
9187
|
-
| 'gpt-5-nano'
|
|
9188
|
-
| 'gpt-4o'
|
|
9189
|
-
| 'gpt-4o-mini'
|
|
9190
9425
|
| 'gpt-4.1'
|
|
9191
9426
|
| 'gpt-4.1-mini'
|
|
9192
9427
|
| 'gpt-4.1-nano'
|
|
9193
|
-
| '
|
|
9194
|
-
| '
|
|
9195
|
-
| '
|
|
9196
|
-
| '
|
|
9428
|
+
| 'gpt-5'
|
|
9429
|
+
| 'gpt-5-mini'
|
|
9430
|
+
| 'gpt-5-nano'
|
|
9431
|
+
| 'claude-4.5-sonnet'
|
|
9432
|
+
| 'claude-4.5-haiku'
|
|
9197
9433
|
| 'gemini-2.5-flash'
|
|
9198
9434
|
| 'gemini-2.5-flash-lite';
|
|
9199
9435
|
|
|
@@ -10166,18 +10402,14 @@ export namespace ConversationFlowCreateParams {
|
|
|
10166
10402
|
* The LLM model to use
|
|
10167
10403
|
*/
|
|
10168
10404
|
model:
|
|
10169
|
-
| 'gpt-5'
|
|
10170
|
-
| 'gpt-5-mini'
|
|
10171
|
-
| 'gpt-5-nano'
|
|
10172
|
-
| 'gpt-4o'
|
|
10173
|
-
| 'gpt-4o-mini'
|
|
10174
10405
|
| 'gpt-4.1'
|
|
10175
10406
|
| 'gpt-4.1-mini'
|
|
10176
10407
|
| 'gpt-4.1-nano'
|
|
10177
|
-
| '
|
|
10178
|
-
| '
|
|
10179
|
-
| '
|
|
10180
|
-
| '
|
|
10408
|
+
| 'gpt-5'
|
|
10409
|
+
| 'gpt-5-mini'
|
|
10410
|
+
| 'gpt-5-nano'
|
|
10411
|
+
| 'claude-4.5-sonnet'
|
|
10412
|
+
| 'claude-4.5-haiku'
|
|
10181
10413
|
| 'gemini-2.5-flash'
|
|
10182
10414
|
| 'gemini-2.5-flash-lite';
|
|
10183
10415
|
|
|
@@ -11385,18 +11617,14 @@ export namespace ConversationFlowCreateParams {
|
|
|
11385
11617
|
* The LLM model to use
|
|
11386
11618
|
*/
|
|
11387
11619
|
model:
|
|
11388
|
-
| 'gpt-5'
|
|
11389
|
-
| 'gpt-5-mini'
|
|
11390
|
-
| 'gpt-5-nano'
|
|
11391
|
-
| 'gpt-4o'
|
|
11392
|
-
| 'gpt-4o-mini'
|
|
11393
11620
|
| 'gpt-4.1'
|
|
11394
11621
|
| 'gpt-4.1-mini'
|
|
11395
11622
|
| 'gpt-4.1-nano'
|
|
11396
|
-
| '
|
|
11397
|
-
| '
|
|
11398
|
-
| '
|
|
11399
|
-
| '
|
|
11623
|
+
| 'gpt-5'
|
|
11624
|
+
| 'gpt-5-mini'
|
|
11625
|
+
| 'gpt-5-nano'
|
|
11626
|
+
| 'claude-4.5-sonnet'
|
|
11627
|
+
| 'claude-4.5-haiku'
|
|
11400
11628
|
| 'gemini-2.5-flash'
|
|
11401
11629
|
| 'gemini-2.5-flash-lite';
|
|
11402
11630
|
|
|
@@ -11910,18 +12138,14 @@ export namespace ConversationFlowCreateParams {
|
|
|
11910
12138
|
* The LLM model to use
|
|
11911
12139
|
*/
|
|
11912
12140
|
model:
|
|
11913
|
-
| 'gpt-5'
|
|
11914
|
-
| 'gpt-5-mini'
|
|
11915
|
-
| 'gpt-5-nano'
|
|
11916
|
-
| 'gpt-4o'
|
|
11917
|
-
| 'gpt-4o-mini'
|
|
11918
12141
|
| 'gpt-4.1'
|
|
11919
12142
|
| 'gpt-4.1-mini'
|
|
11920
12143
|
| 'gpt-4.1-nano'
|
|
11921
|
-
| '
|
|
11922
|
-
| '
|
|
11923
|
-
| '
|
|
11924
|
-
| '
|
|
12144
|
+
| 'gpt-5'
|
|
12145
|
+
| 'gpt-5-mini'
|
|
12146
|
+
| 'gpt-5-nano'
|
|
12147
|
+
| 'claude-4.5-sonnet'
|
|
12148
|
+
| 'claude-4.5-haiku'
|
|
11925
12149
|
| 'gemini-2.5-flash'
|
|
11926
12150
|
| 'gemini-2.5-flash-lite';
|
|
11927
12151
|
|
|
@@ -11951,7 +12175,8 @@ export namespace ConversationFlowCreateParams {
|
|
|
11951
12175
|
|
|
11952
12176
|
transfer_option:
|
|
11953
12177
|
| TransferCallNode.TransferOptionColdTransfer
|
|
11954
|
-
| TransferCallNode.TransferOptionWarmTransfer
|
|
12178
|
+
| TransferCallNode.TransferOptionWarmTransfer
|
|
12179
|
+
| TransferCallNode.TransferOptionAgenticWarmTransfer;
|
|
11955
12180
|
|
|
11956
12181
|
/**
|
|
11957
12182
|
* Type of the node
|
|
@@ -12147,9 +12372,98 @@ export namespace ConversationFlowCreateParams {
|
|
|
12147
12372
|
* agent receiving the transfer. Can leave either a static message or a dynamic one
|
|
12148
12373
|
* based on prompt. Set to null to disable warm handoff.
|
|
12149
12374
|
*/
|
|
12150
|
-
private_handoff_option?:
|
|
12151
|
-
| TransferOptionWarmTransfer.WarmTransferPrompt
|
|
12152
|
-
| TransferOptionWarmTransfer.WarmTransferStaticMessage;
|
|
12375
|
+
private_handoff_option?:
|
|
12376
|
+
| TransferOptionWarmTransfer.WarmTransferPrompt
|
|
12377
|
+
| TransferOptionWarmTransfer.WarmTransferStaticMessage;
|
|
12378
|
+
|
|
12379
|
+
/**
|
|
12380
|
+
* If set, when transfer is successful, will say the handoff message to both the
|
|
12381
|
+
* transferee and the agent receiving the transfer. Can leave either a static
|
|
12382
|
+
* message or a dynamic one based on prompt. Set to null to disable warm handoff.
|
|
12383
|
+
*/
|
|
12384
|
+
public_handoff_option?:
|
|
12385
|
+
| TransferOptionWarmTransfer.WarmTransferPrompt
|
|
12386
|
+
| TransferOptionWarmTransfer.WarmTransferStaticMessage;
|
|
12387
|
+
|
|
12388
|
+
/**
|
|
12389
|
+
* If set to true, will show transferee (the user, not the AI agent) as caller when
|
|
12390
|
+
* transferring, requires the telephony side to support caller id override. Retell
|
|
12391
|
+
* Twilio numbers support this option.
|
|
12392
|
+
*/
|
|
12393
|
+
show_transferee_as_caller?: boolean;
|
|
12394
|
+
}
|
|
12395
|
+
|
|
12396
|
+
export namespace TransferOptionWarmTransfer {
|
|
12397
|
+
/**
|
|
12398
|
+
* IVR navigation option to run when doing human detection. This prompt will guide
|
|
12399
|
+
* the AI on how to navigate the IVR system.
|
|
12400
|
+
*/
|
|
12401
|
+
export interface IvrOption {
|
|
12402
|
+
/**
|
|
12403
|
+
* The prompt to be used for warm handoff. Can contain dynamic variables.
|
|
12404
|
+
*/
|
|
12405
|
+
prompt?: string;
|
|
12406
|
+
|
|
12407
|
+
type?: 'prompt';
|
|
12408
|
+
}
|
|
12409
|
+
|
|
12410
|
+
export interface WarmTransferPrompt {
|
|
12411
|
+
/**
|
|
12412
|
+
* The prompt to be used for warm handoff. Can contain dynamic variables.
|
|
12413
|
+
*/
|
|
12414
|
+
prompt?: string;
|
|
12415
|
+
|
|
12416
|
+
type?: 'prompt';
|
|
12417
|
+
}
|
|
12418
|
+
|
|
12419
|
+
export interface WarmTransferStaticMessage {
|
|
12420
|
+
/**
|
|
12421
|
+
* The static message to be used for warm handoff. Can contain dynamic variables.
|
|
12422
|
+
*/
|
|
12423
|
+
message?: string;
|
|
12424
|
+
|
|
12425
|
+
type?: 'static_message';
|
|
12426
|
+
}
|
|
12427
|
+
|
|
12428
|
+
export interface WarmTransferPrompt {
|
|
12429
|
+
/**
|
|
12430
|
+
* The prompt to be used for warm handoff. Can contain dynamic variables.
|
|
12431
|
+
*/
|
|
12432
|
+
prompt?: string;
|
|
12433
|
+
|
|
12434
|
+
type?: 'prompt';
|
|
12435
|
+
}
|
|
12436
|
+
|
|
12437
|
+
export interface WarmTransferStaticMessage {
|
|
12438
|
+
/**
|
|
12439
|
+
* The static message to be used for warm handoff. Can contain dynamic variables.
|
|
12440
|
+
*/
|
|
12441
|
+
message?: string;
|
|
12442
|
+
|
|
12443
|
+
type?: 'static_message';
|
|
12444
|
+
}
|
|
12445
|
+
}
|
|
12446
|
+
|
|
12447
|
+
export interface TransferOptionAgenticWarmTransfer {
|
|
12448
|
+
/**
|
|
12449
|
+
* Configuration for agentic warm transfer. Required for agentic warm transfer.
|
|
12450
|
+
*/
|
|
12451
|
+
agentic_transfer_config: TransferOptionAgenticWarmTransfer.AgenticTransferConfig;
|
|
12452
|
+
|
|
12453
|
+
/**
|
|
12454
|
+
* The type of the transfer.
|
|
12455
|
+
*/
|
|
12456
|
+
type: 'agentic_warm_transfer';
|
|
12457
|
+
|
|
12458
|
+
/**
|
|
12459
|
+
* Whether to play an audio cue when bridging the call. Defaults to true.
|
|
12460
|
+
*/
|
|
12461
|
+
enable_bridge_audio_cue?: boolean;
|
|
12462
|
+
|
|
12463
|
+
/**
|
|
12464
|
+
* The music to play while the caller is being transferred.
|
|
12465
|
+
*/
|
|
12466
|
+
on_hold_music?: 'none' | 'relaxing_sound' | 'uplifting_beats' | 'ringtone';
|
|
12153
12467
|
|
|
12154
12468
|
/**
|
|
12155
12469
|
* If set, when transfer is successful, will say the handoff message to both the
|
|
@@ -12157,8 +12471,8 @@ export namespace ConversationFlowCreateParams {
|
|
|
12157
12471
|
* message or a dynamic one based on prompt. Set to null to disable warm handoff.
|
|
12158
12472
|
*/
|
|
12159
12473
|
public_handoff_option?:
|
|
12160
|
-
|
|
|
12161
|
-
|
|
|
12474
|
+
| TransferOptionAgenticWarmTransfer.WarmTransferPrompt
|
|
12475
|
+
| TransferOptionAgenticWarmTransfer.WarmTransferStaticMessage;
|
|
12162
12476
|
|
|
12163
12477
|
/**
|
|
12164
12478
|
* If set to true, will show transferee (the user, not the AI agent) as caller when
|
|
@@ -12168,36 +12482,46 @@ export namespace ConversationFlowCreateParams {
|
|
|
12168
12482
|
show_transferee_as_caller?: boolean;
|
|
12169
12483
|
}
|
|
12170
12484
|
|
|
12171
|
-
export namespace
|
|
12485
|
+
export namespace TransferOptionAgenticWarmTransfer {
|
|
12172
12486
|
/**
|
|
12173
|
-
*
|
|
12174
|
-
* the AI on how to navigate the IVR system.
|
|
12487
|
+
* Configuration for agentic warm transfer. Required for agentic warm transfer.
|
|
12175
12488
|
*/
|
|
12176
|
-
export interface
|
|
12489
|
+
export interface AgenticTransferConfig {
|
|
12177
12490
|
/**
|
|
12178
|
-
* The
|
|
12491
|
+
* The action to take when the transfer agent times out without making a decision.
|
|
12492
|
+
* Defaults to cancel_transfer.
|
|
12179
12493
|
*/
|
|
12180
|
-
|
|
12494
|
+
action_on_timeout?: 'bridge_transfer' | 'cancel_transfer';
|
|
12181
12495
|
|
|
12182
|
-
type?: 'prompt';
|
|
12183
|
-
}
|
|
12184
|
-
|
|
12185
|
-
export interface WarmTransferPrompt {
|
|
12186
12496
|
/**
|
|
12187
|
-
* The
|
|
12497
|
+
* The agent that will mediate the transfer decision.
|
|
12188
12498
|
*/
|
|
12189
|
-
|
|
12499
|
+
transfer_agent?: AgenticTransferConfig.TransferAgent;
|
|
12190
12500
|
|
|
12191
|
-
|
|
12501
|
+
/**
|
|
12502
|
+
* The maximum time to wait for the transfer agent to make a decision, in
|
|
12503
|
+
* milliseconds. Defaults to 30000 (30 seconds).
|
|
12504
|
+
*/
|
|
12505
|
+
transfer_timeout_ms?: number;
|
|
12192
12506
|
}
|
|
12193
12507
|
|
|
12194
|
-
export
|
|
12508
|
+
export namespace AgenticTransferConfig {
|
|
12195
12509
|
/**
|
|
12196
|
-
* The
|
|
12510
|
+
* The agent that will mediate the transfer decision.
|
|
12197
12511
|
*/
|
|
12198
|
-
|
|
12512
|
+
export interface TransferAgent {
|
|
12513
|
+
/**
|
|
12514
|
+
* The agent ID of the transfer agent. This agent must have isTransferAgent set to
|
|
12515
|
+
* true and should use bridge_transfer and cancel_transfer tools (for Retell LLM)
|
|
12516
|
+
* or BridgeTransferNode and CancelTransferNode (for Conversation Flow).
|
|
12517
|
+
*/
|
|
12518
|
+
agent_id: string;
|
|
12199
12519
|
|
|
12200
|
-
|
|
12520
|
+
/**
|
|
12521
|
+
* The version of the transfer agent to use.
|
|
12522
|
+
*/
|
|
12523
|
+
agent_version: number;
|
|
12524
|
+
}
|
|
12201
12525
|
}
|
|
12202
12526
|
|
|
12203
12527
|
export interface WarmTransferPrompt {
|
|
@@ -12326,18 +12650,14 @@ export namespace ConversationFlowCreateParams {
|
|
|
12326
12650
|
* The LLM model to use
|
|
12327
12651
|
*/
|
|
12328
12652
|
model:
|
|
12329
|
-
| 'gpt-5'
|
|
12330
|
-
| 'gpt-5-mini'
|
|
12331
|
-
| 'gpt-5-nano'
|
|
12332
|
-
| 'gpt-4o'
|
|
12333
|
-
| 'gpt-4o-mini'
|
|
12334
12653
|
| 'gpt-4.1'
|
|
12335
12654
|
| 'gpt-4.1-mini'
|
|
12336
12655
|
| 'gpt-4.1-nano'
|
|
12337
|
-
| '
|
|
12338
|
-
| '
|
|
12339
|
-
| '
|
|
12340
|
-
| '
|
|
12656
|
+
| 'gpt-5'
|
|
12657
|
+
| 'gpt-5-mini'
|
|
12658
|
+
| 'gpt-5-nano'
|
|
12659
|
+
| 'claude-4.5-sonnet'
|
|
12660
|
+
| 'claude-4.5-haiku'
|
|
12341
12661
|
| 'gemini-2.5-flash'
|
|
12342
12662
|
| 'gemini-2.5-flash-lite';
|
|
12343
12663
|
|
|
@@ -12617,18 +12937,14 @@ export namespace ConversationFlowCreateParams {
|
|
|
12617
12937
|
* The LLM model to use
|
|
12618
12938
|
*/
|
|
12619
12939
|
model:
|
|
12620
|
-
| 'gpt-5'
|
|
12621
|
-
| 'gpt-5-mini'
|
|
12622
|
-
| 'gpt-5-nano'
|
|
12623
|
-
| 'gpt-4o'
|
|
12624
|
-
| 'gpt-4o-mini'
|
|
12625
12940
|
| 'gpt-4.1'
|
|
12626
12941
|
| 'gpt-4.1-mini'
|
|
12627
12942
|
| 'gpt-4.1-nano'
|
|
12628
|
-
| '
|
|
12629
|
-
| '
|
|
12630
|
-
| '
|
|
12631
|
-
| '
|
|
12943
|
+
| 'gpt-5'
|
|
12944
|
+
| 'gpt-5-mini'
|
|
12945
|
+
| 'gpt-5-nano'
|
|
12946
|
+
| 'claude-4.5-sonnet'
|
|
12947
|
+
| 'claude-4.5-haiku'
|
|
12632
12948
|
| 'gemini-2.5-flash'
|
|
12633
12949
|
| 'gemini-2.5-flash-lite';
|
|
12634
12950
|
|
|
@@ -13601,18 +13917,14 @@ export namespace ConversationFlowCreateParams {
|
|
|
13601
13917
|
* The LLM model to use
|
|
13602
13918
|
*/
|
|
13603
13919
|
model:
|
|
13604
|
-
| 'gpt-5'
|
|
13605
|
-
| 'gpt-5-mini'
|
|
13606
|
-
| 'gpt-5-nano'
|
|
13607
|
-
| 'gpt-4o'
|
|
13608
|
-
| 'gpt-4o-mini'
|
|
13609
13920
|
| 'gpt-4.1'
|
|
13610
13921
|
| 'gpt-4.1-mini'
|
|
13611
13922
|
| 'gpt-4.1-nano'
|
|
13612
|
-
| '
|
|
13613
|
-
| '
|
|
13614
|
-
| '
|
|
13615
|
-
| '
|
|
13923
|
+
| 'gpt-5'
|
|
13924
|
+
| 'gpt-5-mini'
|
|
13925
|
+
| 'gpt-5-nano'
|
|
13926
|
+
| 'claude-4.5-sonnet'
|
|
13927
|
+
| 'claude-4.5-haiku'
|
|
13616
13928
|
| 'gemini-2.5-flash'
|
|
13617
13929
|
| 'gemini-2.5-flash-lite';
|
|
13618
13930
|
|
|
@@ -15322,18 +15634,14 @@ export namespace ConversationFlowUpdateParams {
|
|
|
15322
15634
|
* The LLM model to use
|
|
15323
15635
|
*/
|
|
15324
15636
|
model:
|
|
15325
|
-
| 'gpt-5'
|
|
15326
|
-
| 'gpt-5-mini'
|
|
15327
|
-
| 'gpt-5-nano'
|
|
15328
|
-
| 'gpt-4o'
|
|
15329
|
-
| 'gpt-4o-mini'
|
|
15330
15637
|
| 'gpt-4.1'
|
|
15331
15638
|
| 'gpt-4.1-mini'
|
|
15332
15639
|
| 'gpt-4.1-nano'
|
|
15333
|
-
| '
|
|
15334
|
-
| '
|
|
15335
|
-
| '
|
|
15336
|
-
| '
|
|
15640
|
+
| 'gpt-5'
|
|
15641
|
+
| 'gpt-5-mini'
|
|
15642
|
+
| 'gpt-5-nano'
|
|
15643
|
+
| 'claude-4.5-sonnet'
|
|
15644
|
+
| 'claude-4.5-haiku'
|
|
15337
15645
|
| 'gemini-2.5-flash'
|
|
15338
15646
|
| 'gemini-2.5-flash-lite';
|
|
15339
15647
|
|
|
@@ -15847,18 +16155,14 @@ export namespace ConversationFlowUpdateParams {
|
|
|
15847
16155
|
* The LLM model to use
|
|
15848
16156
|
*/
|
|
15849
16157
|
model:
|
|
15850
|
-
| 'gpt-5'
|
|
15851
|
-
| 'gpt-5-mini'
|
|
15852
|
-
| 'gpt-5-nano'
|
|
15853
|
-
| 'gpt-4o'
|
|
15854
|
-
| 'gpt-4o-mini'
|
|
15855
16158
|
| 'gpt-4.1'
|
|
15856
16159
|
| 'gpt-4.1-mini'
|
|
15857
16160
|
| 'gpt-4.1-nano'
|
|
15858
|
-
| '
|
|
15859
|
-
| '
|
|
15860
|
-
| '
|
|
15861
|
-
| '
|
|
16161
|
+
| 'gpt-5'
|
|
16162
|
+
| 'gpt-5-mini'
|
|
16163
|
+
| 'gpt-5-nano'
|
|
16164
|
+
| 'claude-4.5-sonnet'
|
|
16165
|
+
| 'claude-4.5-haiku'
|
|
15862
16166
|
| 'gemini-2.5-flash'
|
|
15863
16167
|
| 'gemini-2.5-flash-lite';
|
|
15864
16168
|
|
|
@@ -15888,7 +16192,8 @@ export namespace ConversationFlowUpdateParams {
|
|
|
15888
16192
|
|
|
15889
16193
|
transfer_option:
|
|
15890
16194
|
| TransferCallNode.TransferOptionColdTransfer
|
|
15891
|
-
| TransferCallNode.TransferOptionWarmTransfer
|
|
16195
|
+
| TransferCallNode.TransferOptionWarmTransfer
|
|
16196
|
+
| TransferCallNode.TransferOptionAgenticWarmTransfer;
|
|
15892
16197
|
|
|
15893
16198
|
/**
|
|
15894
16199
|
* Type of the node
|
|
@@ -16156,6 +16461,105 @@ export namespace ConversationFlowUpdateParams {
|
|
|
16156
16461
|
}
|
|
16157
16462
|
}
|
|
16158
16463
|
|
|
16464
|
+
export interface TransferOptionAgenticWarmTransfer {
|
|
16465
|
+
/**
|
|
16466
|
+
* Configuration for agentic warm transfer. Required for agentic warm transfer.
|
|
16467
|
+
*/
|
|
16468
|
+
agentic_transfer_config: TransferOptionAgenticWarmTransfer.AgenticTransferConfig;
|
|
16469
|
+
|
|
16470
|
+
/**
|
|
16471
|
+
* The type of the transfer.
|
|
16472
|
+
*/
|
|
16473
|
+
type: 'agentic_warm_transfer';
|
|
16474
|
+
|
|
16475
|
+
/**
|
|
16476
|
+
* Whether to play an audio cue when bridging the call. Defaults to true.
|
|
16477
|
+
*/
|
|
16478
|
+
enable_bridge_audio_cue?: boolean;
|
|
16479
|
+
|
|
16480
|
+
/**
|
|
16481
|
+
* The music to play while the caller is being transferred.
|
|
16482
|
+
*/
|
|
16483
|
+
on_hold_music?: 'none' | 'relaxing_sound' | 'uplifting_beats' | 'ringtone';
|
|
16484
|
+
|
|
16485
|
+
/**
|
|
16486
|
+
* If set, when transfer is successful, will say the handoff message to both the
|
|
16487
|
+
* transferee and the agent receiving the transfer. Can leave either a static
|
|
16488
|
+
* message or a dynamic one based on prompt. Set to null to disable warm handoff.
|
|
16489
|
+
*/
|
|
16490
|
+
public_handoff_option?:
|
|
16491
|
+
| TransferOptionAgenticWarmTransfer.WarmTransferPrompt
|
|
16492
|
+
| TransferOptionAgenticWarmTransfer.WarmTransferStaticMessage;
|
|
16493
|
+
|
|
16494
|
+
/**
|
|
16495
|
+
* If set to true, will show transferee (the user, not the AI agent) as caller when
|
|
16496
|
+
* transferring, requires the telephony side to support caller id override. Retell
|
|
16497
|
+
* Twilio numbers support this option.
|
|
16498
|
+
*/
|
|
16499
|
+
show_transferee_as_caller?: boolean;
|
|
16500
|
+
}
|
|
16501
|
+
|
|
16502
|
+
export namespace TransferOptionAgenticWarmTransfer {
|
|
16503
|
+
/**
|
|
16504
|
+
* Configuration for agentic warm transfer. Required for agentic warm transfer.
|
|
16505
|
+
*/
|
|
16506
|
+
export interface AgenticTransferConfig {
|
|
16507
|
+
/**
|
|
16508
|
+
* The action to take when the transfer agent times out without making a decision.
|
|
16509
|
+
* Defaults to cancel_transfer.
|
|
16510
|
+
*/
|
|
16511
|
+
action_on_timeout?: 'bridge_transfer' | 'cancel_transfer';
|
|
16512
|
+
|
|
16513
|
+
/**
|
|
16514
|
+
* The agent that will mediate the transfer decision.
|
|
16515
|
+
*/
|
|
16516
|
+
transfer_agent?: AgenticTransferConfig.TransferAgent;
|
|
16517
|
+
|
|
16518
|
+
/**
|
|
16519
|
+
* The maximum time to wait for the transfer agent to make a decision, in
|
|
16520
|
+
* milliseconds. Defaults to 30000 (30 seconds).
|
|
16521
|
+
*/
|
|
16522
|
+
transfer_timeout_ms?: number;
|
|
16523
|
+
}
|
|
16524
|
+
|
|
16525
|
+
export namespace AgenticTransferConfig {
|
|
16526
|
+
/**
|
|
16527
|
+
* The agent that will mediate the transfer decision.
|
|
16528
|
+
*/
|
|
16529
|
+
export interface TransferAgent {
|
|
16530
|
+
/**
|
|
16531
|
+
* The agent ID of the transfer agent. This agent must have isTransferAgent set to
|
|
16532
|
+
* true and should use bridge_transfer and cancel_transfer tools (for Retell LLM)
|
|
16533
|
+
* or BridgeTransferNode and CancelTransferNode (for Conversation Flow).
|
|
16534
|
+
*/
|
|
16535
|
+
agent_id: string;
|
|
16536
|
+
|
|
16537
|
+
/**
|
|
16538
|
+
* The version of the transfer agent to use.
|
|
16539
|
+
*/
|
|
16540
|
+
agent_version: number;
|
|
16541
|
+
}
|
|
16542
|
+
}
|
|
16543
|
+
|
|
16544
|
+
export interface WarmTransferPrompt {
|
|
16545
|
+
/**
|
|
16546
|
+
* The prompt to be used for warm handoff. Can contain dynamic variables.
|
|
16547
|
+
*/
|
|
16548
|
+
prompt?: string;
|
|
16549
|
+
|
|
16550
|
+
type?: 'prompt';
|
|
16551
|
+
}
|
|
16552
|
+
|
|
16553
|
+
export interface WarmTransferStaticMessage {
|
|
16554
|
+
/**
|
|
16555
|
+
* The static message to be used for warm handoff. Can contain dynamic variables.
|
|
16556
|
+
*/
|
|
16557
|
+
message?: string;
|
|
16558
|
+
|
|
16559
|
+
type?: 'static_message';
|
|
16560
|
+
}
|
|
16561
|
+
}
|
|
16562
|
+
|
|
16159
16563
|
/**
|
|
16160
16564
|
* Position for frontend display
|
|
16161
16565
|
*/
|
|
@@ -16263,18 +16667,14 @@ export namespace ConversationFlowUpdateParams {
|
|
|
16263
16667
|
* The LLM model to use
|
|
16264
16668
|
*/
|
|
16265
16669
|
model:
|
|
16266
|
-
| 'gpt-5'
|
|
16267
|
-
| 'gpt-5-mini'
|
|
16268
|
-
| 'gpt-5-nano'
|
|
16269
|
-
| 'gpt-4o'
|
|
16270
|
-
| 'gpt-4o-mini'
|
|
16271
16670
|
| 'gpt-4.1'
|
|
16272
16671
|
| 'gpt-4.1-mini'
|
|
16273
16672
|
| 'gpt-4.1-nano'
|
|
16274
|
-
| '
|
|
16275
|
-
| '
|
|
16276
|
-
| '
|
|
16277
|
-
| '
|
|
16673
|
+
| 'gpt-5'
|
|
16674
|
+
| 'gpt-5-mini'
|
|
16675
|
+
| 'gpt-5-nano'
|
|
16676
|
+
| 'claude-4.5-sonnet'
|
|
16677
|
+
| 'claude-4.5-haiku'
|
|
16278
16678
|
| 'gemini-2.5-flash'
|
|
16279
16679
|
| 'gemini-2.5-flash-lite';
|
|
16280
16680
|
|
|
@@ -16554,18 +16954,14 @@ export namespace ConversationFlowUpdateParams {
|
|
|
16554
16954
|
* The LLM model to use
|
|
16555
16955
|
*/
|
|
16556
16956
|
model:
|
|
16557
|
-
| 'gpt-5'
|
|
16558
|
-
| 'gpt-5-mini'
|
|
16559
|
-
| 'gpt-5-nano'
|
|
16560
|
-
| 'gpt-4o'
|
|
16561
|
-
| 'gpt-4o-mini'
|
|
16562
16957
|
| 'gpt-4.1'
|
|
16563
16958
|
| 'gpt-4.1-mini'
|
|
16564
16959
|
| 'gpt-4.1-nano'
|
|
16565
|
-
| '
|
|
16566
|
-
| '
|
|
16567
|
-
| '
|
|
16568
|
-
| '
|
|
16960
|
+
| 'gpt-5'
|
|
16961
|
+
| 'gpt-5-mini'
|
|
16962
|
+
| 'gpt-5-nano'
|
|
16963
|
+
| 'claude-4.5-sonnet'
|
|
16964
|
+
| 'claude-4.5-haiku'
|
|
16569
16965
|
| 'gemini-2.5-flash'
|
|
16570
16966
|
| 'gemini-2.5-flash-lite';
|
|
16571
16967
|
|
|
@@ -17538,18 +17934,14 @@ export namespace ConversationFlowUpdateParams {
|
|
|
17538
17934
|
* The LLM model to use
|
|
17539
17935
|
*/
|
|
17540
17936
|
model:
|
|
17541
|
-
| 'gpt-5'
|
|
17542
|
-
| 'gpt-5-mini'
|
|
17543
|
-
| 'gpt-5-nano'
|
|
17544
|
-
| 'gpt-4o'
|
|
17545
|
-
| 'gpt-4o-mini'
|
|
17546
17937
|
| 'gpt-4.1'
|
|
17547
17938
|
| 'gpt-4.1-mini'
|
|
17548
17939
|
| 'gpt-4.1-nano'
|
|
17549
|
-
| '
|
|
17550
|
-
| '
|
|
17551
|
-
| '
|
|
17552
|
-
| '
|
|
17940
|
+
| 'gpt-5'
|
|
17941
|
+
| 'gpt-5-mini'
|
|
17942
|
+
| 'gpt-5-nano'
|
|
17943
|
+
| 'claude-4.5-sonnet'
|
|
17944
|
+
| 'claude-4.5-haiku'
|
|
17553
17945
|
| 'gemini-2.5-flash'
|
|
17554
17946
|
| 'gemini-2.5-flash-lite';
|
|
17555
17947
|
|
|
@@ -18606,18 +18998,14 @@ export namespace ConversationFlowUpdateParams {
|
|
|
18606
18998
|
* The LLM model to use
|
|
18607
18999
|
*/
|
|
18608
19000
|
model:
|
|
18609
|
-
| 'gpt-5'
|
|
18610
|
-
| 'gpt-5-mini'
|
|
18611
|
-
| 'gpt-5-nano'
|
|
18612
|
-
| 'gpt-4o'
|
|
18613
|
-
| 'gpt-4o-mini'
|
|
18614
19001
|
| 'gpt-4.1'
|
|
18615
19002
|
| 'gpt-4.1-mini'
|
|
18616
19003
|
| 'gpt-4.1-nano'
|
|
18617
|
-
| '
|
|
18618
|
-
| '
|
|
18619
|
-
| '
|
|
18620
|
-
| '
|
|
19004
|
+
| 'gpt-5'
|
|
19005
|
+
| 'gpt-5-mini'
|
|
19006
|
+
| 'gpt-5-nano'
|
|
19007
|
+
| 'claude-4.5-sonnet'
|
|
19008
|
+
| 'claude-4.5-haiku'
|
|
18621
19009
|
| 'gemini-2.5-flash'
|
|
18622
19010
|
| 'gemini-2.5-flash-lite';
|
|
18623
19011
|
|
|
@@ -18956,18 +19344,14 @@ export namespace ConversationFlowUpdateParams {
|
|
|
18956
19344
|
* The LLM model to use
|
|
18957
19345
|
*/
|
|
18958
19346
|
model:
|
|
18959
|
-
| 'gpt-5'
|
|
18960
|
-
| 'gpt-5-mini'
|
|
18961
|
-
| 'gpt-5-nano'
|
|
18962
|
-
| 'gpt-4o'
|
|
18963
|
-
| 'gpt-4o-mini'
|
|
18964
19347
|
| 'gpt-4.1'
|
|
18965
19348
|
| 'gpt-4.1-mini'
|
|
18966
19349
|
| 'gpt-4.1-nano'
|
|
18967
|
-
| '
|
|
18968
|
-
| '
|
|
18969
|
-
| '
|
|
18970
|
-
| '
|
|
19350
|
+
| 'gpt-5'
|
|
19351
|
+
| 'gpt-5-mini'
|
|
19352
|
+
| 'gpt-5-nano'
|
|
19353
|
+
| 'claude-4.5-sonnet'
|
|
19354
|
+
| 'claude-4.5-haiku'
|
|
18971
19355
|
| 'gemini-2.5-flash'
|
|
18972
19356
|
| 'gemini-2.5-flash-lite';
|
|
18973
19357
|
|
|
@@ -19481,18 +19865,14 @@ export namespace ConversationFlowUpdateParams {
|
|
|
19481
19865
|
* The LLM model to use
|
|
19482
19866
|
*/
|
|
19483
19867
|
model:
|
|
19484
|
-
| 'gpt-5'
|
|
19485
|
-
| 'gpt-5-mini'
|
|
19486
|
-
| 'gpt-5-nano'
|
|
19487
|
-
| 'gpt-4o'
|
|
19488
|
-
| 'gpt-4o-mini'
|
|
19489
19868
|
| 'gpt-4.1'
|
|
19490
19869
|
| 'gpt-4.1-mini'
|
|
19491
19870
|
| 'gpt-4.1-nano'
|
|
19492
|
-
| '
|
|
19493
|
-
| '
|
|
19494
|
-
| '
|
|
19495
|
-
| '
|
|
19871
|
+
| 'gpt-5'
|
|
19872
|
+
| 'gpt-5-mini'
|
|
19873
|
+
| 'gpt-5-nano'
|
|
19874
|
+
| 'claude-4.5-sonnet'
|
|
19875
|
+
| 'claude-4.5-haiku'
|
|
19496
19876
|
| 'gemini-2.5-flash'
|
|
19497
19877
|
| 'gemini-2.5-flash-lite';
|
|
19498
19878
|
|
|
@@ -19522,7 +19902,8 @@ export namespace ConversationFlowUpdateParams {
|
|
|
19522
19902
|
|
|
19523
19903
|
transfer_option:
|
|
19524
19904
|
| TransferCallNode.TransferOptionColdTransfer
|
|
19525
|
-
| TransferCallNode.TransferOptionWarmTransfer
|
|
19905
|
+
| TransferCallNode.TransferOptionWarmTransfer
|
|
19906
|
+
| TransferCallNode.TransferOptionAgenticWarmTransfer;
|
|
19526
19907
|
|
|
19527
19908
|
/**
|
|
19528
19909
|
* Type of the node
|
|
@@ -19790,6 +20171,105 @@ export namespace ConversationFlowUpdateParams {
|
|
|
19790
20171
|
}
|
|
19791
20172
|
}
|
|
19792
20173
|
|
|
20174
|
+
export interface TransferOptionAgenticWarmTransfer {
|
|
20175
|
+
/**
|
|
20176
|
+
* Configuration for agentic warm transfer. Required for agentic warm transfer.
|
|
20177
|
+
*/
|
|
20178
|
+
agentic_transfer_config: TransferOptionAgenticWarmTransfer.AgenticTransferConfig;
|
|
20179
|
+
|
|
20180
|
+
/**
|
|
20181
|
+
* The type of the transfer.
|
|
20182
|
+
*/
|
|
20183
|
+
type: 'agentic_warm_transfer';
|
|
20184
|
+
|
|
20185
|
+
/**
|
|
20186
|
+
* Whether to play an audio cue when bridging the call. Defaults to true.
|
|
20187
|
+
*/
|
|
20188
|
+
enable_bridge_audio_cue?: boolean;
|
|
20189
|
+
|
|
20190
|
+
/**
|
|
20191
|
+
* The music to play while the caller is being transferred.
|
|
20192
|
+
*/
|
|
20193
|
+
on_hold_music?: 'none' | 'relaxing_sound' | 'uplifting_beats' | 'ringtone';
|
|
20194
|
+
|
|
20195
|
+
/**
|
|
20196
|
+
* If set, when transfer is successful, will say the handoff message to both the
|
|
20197
|
+
* transferee and the agent receiving the transfer. Can leave either a static
|
|
20198
|
+
* message or a dynamic one based on prompt. Set to null to disable warm handoff.
|
|
20199
|
+
*/
|
|
20200
|
+
public_handoff_option?:
|
|
20201
|
+
| TransferOptionAgenticWarmTransfer.WarmTransferPrompt
|
|
20202
|
+
| TransferOptionAgenticWarmTransfer.WarmTransferStaticMessage;
|
|
20203
|
+
|
|
20204
|
+
/**
|
|
20205
|
+
* If set to true, will show transferee (the user, not the AI agent) as caller when
|
|
20206
|
+
* transferring, requires the telephony side to support caller id override. Retell
|
|
20207
|
+
* Twilio numbers support this option.
|
|
20208
|
+
*/
|
|
20209
|
+
show_transferee_as_caller?: boolean;
|
|
20210
|
+
}
|
|
20211
|
+
|
|
20212
|
+
export namespace TransferOptionAgenticWarmTransfer {
|
|
20213
|
+
/**
|
|
20214
|
+
* Configuration for agentic warm transfer. Required for agentic warm transfer.
|
|
20215
|
+
*/
|
|
20216
|
+
export interface AgenticTransferConfig {
|
|
20217
|
+
/**
|
|
20218
|
+
* The action to take when the transfer agent times out without making a decision.
|
|
20219
|
+
* Defaults to cancel_transfer.
|
|
20220
|
+
*/
|
|
20221
|
+
action_on_timeout?: 'bridge_transfer' | 'cancel_transfer';
|
|
20222
|
+
|
|
20223
|
+
/**
|
|
20224
|
+
* The agent that will mediate the transfer decision.
|
|
20225
|
+
*/
|
|
20226
|
+
transfer_agent?: AgenticTransferConfig.TransferAgent;
|
|
20227
|
+
|
|
20228
|
+
/**
|
|
20229
|
+
* The maximum time to wait for the transfer agent to make a decision, in
|
|
20230
|
+
* milliseconds. Defaults to 30000 (30 seconds).
|
|
20231
|
+
*/
|
|
20232
|
+
transfer_timeout_ms?: number;
|
|
20233
|
+
}
|
|
20234
|
+
|
|
20235
|
+
export namespace AgenticTransferConfig {
|
|
20236
|
+
/**
|
|
20237
|
+
* The agent that will mediate the transfer decision.
|
|
20238
|
+
*/
|
|
20239
|
+
export interface TransferAgent {
|
|
20240
|
+
/**
|
|
20241
|
+
* The agent ID of the transfer agent. This agent must have isTransferAgent set to
|
|
20242
|
+
* true and should use bridge_transfer and cancel_transfer tools (for Retell LLM)
|
|
20243
|
+
* or BridgeTransferNode and CancelTransferNode (for Conversation Flow).
|
|
20244
|
+
*/
|
|
20245
|
+
agent_id: string;
|
|
20246
|
+
|
|
20247
|
+
/**
|
|
20248
|
+
* The version of the transfer agent to use.
|
|
20249
|
+
*/
|
|
20250
|
+
agent_version: number;
|
|
20251
|
+
}
|
|
20252
|
+
}
|
|
20253
|
+
|
|
20254
|
+
export interface WarmTransferPrompt {
|
|
20255
|
+
/**
|
|
20256
|
+
* The prompt to be used for warm handoff. Can contain dynamic variables.
|
|
20257
|
+
*/
|
|
20258
|
+
prompt?: string;
|
|
20259
|
+
|
|
20260
|
+
type?: 'prompt';
|
|
20261
|
+
}
|
|
20262
|
+
|
|
20263
|
+
export interface WarmTransferStaticMessage {
|
|
20264
|
+
/**
|
|
20265
|
+
* The static message to be used for warm handoff. Can contain dynamic variables.
|
|
20266
|
+
*/
|
|
20267
|
+
message?: string;
|
|
20268
|
+
|
|
20269
|
+
type?: 'static_message';
|
|
20270
|
+
}
|
|
20271
|
+
}
|
|
20272
|
+
|
|
19793
20273
|
/**
|
|
19794
20274
|
* Position for frontend display
|
|
19795
20275
|
*/
|
|
@@ -19897,18 +20377,14 @@ export namespace ConversationFlowUpdateParams {
|
|
|
19897
20377
|
* The LLM model to use
|
|
19898
20378
|
*/
|
|
19899
20379
|
model:
|
|
19900
|
-
| 'gpt-5'
|
|
19901
|
-
| 'gpt-5-mini'
|
|
19902
|
-
| 'gpt-5-nano'
|
|
19903
|
-
| 'gpt-4o'
|
|
19904
|
-
| 'gpt-4o-mini'
|
|
19905
20380
|
| 'gpt-4.1'
|
|
19906
20381
|
| 'gpt-4.1-mini'
|
|
19907
20382
|
| 'gpt-4.1-nano'
|
|
19908
|
-
| '
|
|
19909
|
-
| '
|
|
19910
|
-
| '
|
|
19911
|
-
| '
|
|
20383
|
+
| 'gpt-5'
|
|
20384
|
+
| 'gpt-5-mini'
|
|
20385
|
+
| 'gpt-5-nano'
|
|
20386
|
+
| 'claude-4.5-sonnet'
|
|
20387
|
+
| 'claude-4.5-haiku'
|
|
19912
20388
|
| 'gemini-2.5-flash'
|
|
19913
20389
|
| 'gemini-2.5-flash-lite';
|
|
19914
20390
|
|
|
@@ -20188,18 +20664,14 @@ export namespace ConversationFlowUpdateParams {
|
|
|
20188
20664
|
* The LLM model to use
|
|
20189
20665
|
*/
|
|
20190
20666
|
model:
|
|
20191
|
-
| 'gpt-5'
|
|
20192
|
-
| 'gpt-5-mini'
|
|
20193
|
-
| 'gpt-5-nano'
|
|
20194
|
-
| 'gpt-4o'
|
|
20195
|
-
| 'gpt-4o-mini'
|
|
20196
20667
|
| 'gpt-4.1'
|
|
20197
20668
|
| 'gpt-4.1-mini'
|
|
20198
20669
|
| 'gpt-4.1-nano'
|
|
20199
|
-
| '
|
|
20200
|
-
| '
|
|
20201
|
-
| '
|
|
20202
|
-
| '
|
|
20670
|
+
| 'gpt-5'
|
|
20671
|
+
| 'gpt-5-mini'
|
|
20672
|
+
| 'gpt-5-nano'
|
|
20673
|
+
| 'claude-4.5-sonnet'
|
|
20674
|
+
| 'claude-4.5-haiku'
|
|
20203
20675
|
| 'gemini-2.5-flash'
|
|
20204
20676
|
| 'gemini-2.5-flash-lite';
|
|
20205
20677
|
|
|
@@ -21172,18 +21644,14 @@ export namespace ConversationFlowUpdateParams {
|
|
|
21172
21644
|
* The LLM model to use
|
|
21173
21645
|
*/
|
|
21174
21646
|
model:
|
|
21175
|
-
| 'gpt-5'
|
|
21176
|
-
| 'gpt-5-mini'
|
|
21177
|
-
| 'gpt-5-nano'
|
|
21178
|
-
| 'gpt-4o'
|
|
21179
|
-
| 'gpt-4o-mini'
|
|
21180
21647
|
| 'gpt-4.1'
|
|
21181
21648
|
| 'gpt-4.1-mini'
|
|
21182
21649
|
| 'gpt-4.1-nano'
|
|
21183
|
-
| '
|
|
21184
|
-
| '
|
|
21185
|
-
| '
|
|
21186
|
-
| '
|
|
21650
|
+
| 'gpt-5'
|
|
21651
|
+
| 'gpt-5-mini'
|
|
21652
|
+
| 'gpt-5-nano'
|
|
21653
|
+
| 'claude-4.5-sonnet'
|
|
21654
|
+
| 'claude-4.5-haiku'
|
|
21187
21655
|
| 'gemini-2.5-flash'
|
|
21188
21656
|
| 'gemini-2.5-flash-lite';
|
|
21189
21657
|
|