retell-sdk 4.61.0 → 4.63.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/index.d.mts +3 -0
- package/index.d.ts +3 -0
- package/index.d.ts.map +1 -1
- package/index.js +3 -0
- package/index.js.map +1 -1
- package/index.mjs +3 -0
- package/index.mjs.map +1 -1
- 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 +51 -3
- package/resources/chat-agent.d.ts.map +1 -1
- package/resources/conversation-flow-component.d.ts +7835 -0
- package/resources/conversation-flow-component.d.ts.map +1 -0
- package/resources/conversation-flow-component.js +93 -0
- package/resources/conversation-flow-component.js.map +1 -0
- package/resources/conversation-flow-component.mjs +89 -0
- package/resources/conversation-flow-component.mjs.map +1 -0
- package/resources/conversation-flow.d.ts +540 -43
- 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/index.d.ts +1 -0
- package/resources/index.d.ts.map +1 -1
- package/resources/index.js +3 -1
- package/resources/index.js.map +1 -1
- package/resources/index.mjs +1 -0
- package/resources/index.mjs.map +1 -1
- package/resources/llm.d.ts +501 -9
- package/resources/llm.d.ts.map +1 -1
- package/resources/mcp-tool.d.ts +2 -1
- package/resources/mcp-tool.d.ts.map +1 -1
- package/src/index.ts +17 -0
- 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 +66 -27
- package/src/resources/conversation-flow-component.ts +11183 -0
- package/src/resources/conversation-flow.ts +799 -326
- package/src/resources/index.ts +7 -0
- package/src/resources/llm.ts +621 -33
- package/src/resources/mcp-tool.ts +2 -1
- package/src/version.ts +1 -1
- package/version.d.ts +1 -1
- package/version.js +1 -1
- package/version.mjs +1 -1
|
@@ -9,7 +9,7 @@ export declare class ConversationFlow extends APIResource {
|
|
|
9
9
|
* ```ts
|
|
10
10
|
* const conversationFlowResponse =
|
|
11
11
|
* await client.conversationFlow.create({
|
|
12
|
-
* model_choice: { model: 'gpt-
|
|
12
|
+
* model_choice: { model: 'gpt-4.1', type: 'cascading' },
|
|
13
13
|
* nodes: [
|
|
14
14
|
* {
|
|
15
15
|
* id: 'start',
|
|
@@ -407,7 +407,7 @@ export declare namespace ConversationFlowResponse {
|
|
|
407
407
|
/**
|
|
408
408
|
* The LLM model to use
|
|
409
409
|
*/
|
|
410
|
-
model: 'gpt-
|
|
410
|
+
model: 'gpt-4.1' | 'gpt-4.1-mini' | 'gpt-4.1-nano' | 'gpt-5' | 'gpt-5-mini' | 'gpt-5-nano' | 'claude-4.5-sonnet' | 'claude-4.5-haiku' | 'gemini-2.5-flash' | 'gemini-2.5-flash-lite';
|
|
411
411
|
/**
|
|
412
412
|
* Type of model choice
|
|
413
413
|
*/
|
|
@@ -762,7 +762,7 @@ export declare namespace ConversationFlowResponse {
|
|
|
762
762
|
/**
|
|
763
763
|
* The LLM model to use
|
|
764
764
|
*/
|
|
765
|
-
model: 'gpt-
|
|
765
|
+
model: 'gpt-4.1' | 'gpt-4.1-mini' | 'gpt-4.1-nano' | 'gpt-5' | 'gpt-5-mini' | 'gpt-5-nano' | 'claude-4.5-sonnet' | 'claude-4.5-haiku' | 'gemini-2.5-flash' | 'gemini-2.5-flash-lite';
|
|
766
766
|
/**
|
|
767
767
|
* Type of model choice
|
|
768
768
|
*/
|
|
@@ -780,7 +780,7 @@ export declare namespace ConversationFlowResponse {
|
|
|
780
780
|
id: string;
|
|
781
781
|
edge: TransferCallNode.Edge;
|
|
782
782
|
transfer_destination: TransferCallNode.TransferDestinationPredefined | TransferCallNode.TransferDestinationInferred;
|
|
783
|
-
transfer_option: TransferCallNode.TransferOptionColdTransfer | TransferCallNode.TransferOptionWarmTransfer;
|
|
783
|
+
transfer_option: TransferCallNode.TransferOptionColdTransfer | TransferCallNode.TransferOptionWarmTransfer | TransferCallNode.TransferOptionAgenticWarmTransfer;
|
|
784
784
|
/**
|
|
785
785
|
* Type of the node
|
|
786
786
|
*/
|
|
@@ -988,6 +988,88 @@ export declare namespace ConversationFlowResponse {
|
|
|
988
988
|
type?: 'static_message';
|
|
989
989
|
}
|
|
990
990
|
}
|
|
991
|
+
interface TransferOptionAgenticWarmTransfer {
|
|
992
|
+
/**
|
|
993
|
+
* Configuration for agentic warm transfer. Required for agentic warm transfer.
|
|
994
|
+
*/
|
|
995
|
+
agentic_transfer_config: TransferOptionAgenticWarmTransfer.AgenticTransferConfig;
|
|
996
|
+
/**
|
|
997
|
+
* The type of the transfer.
|
|
998
|
+
*/
|
|
999
|
+
type: 'agentic_warm_transfer';
|
|
1000
|
+
/**
|
|
1001
|
+
* Whether to play an audio cue when bridging the call. Defaults to true.
|
|
1002
|
+
*/
|
|
1003
|
+
enable_bridge_audio_cue?: boolean;
|
|
1004
|
+
/**
|
|
1005
|
+
* The music to play while the caller is being transferred.
|
|
1006
|
+
*/
|
|
1007
|
+
on_hold_music?: 'none' | 'relaxing_sound' | 'uplifting_beats' | 'ringtone';
|
|
1008
|
+
/**
|
|
1009
|
+
* If set, when transfer is successful, will say the handoff message to both the
|
|
1010
|
+
* transferee and the agent receiving the transfer. Can leave either a static
|
|
1011
|
+
* message or a dynamic one based on prompt. Set to null to disable warm handoff.
|
|
1012
|
+
*/
|
|
1013
|
+
public_handoff_option?: TransferOptionAgenticWarmTransfer.WarmTransferPrompt | TransferOptionAgenticWarmTransfer.WarmTransferStaticMessage;
|
|
1014
|
+
/**
|
|
1015
|
+
* If set to true, will show transferee (the user, not the AI agent) as caller when
|
|
1016
|
+
* transferring, requires the telephony side to support caller id override. Retell
|
|
1017
|
+
* Twilio numbers support this option.
|
|
1018
|
+
*/
|
|
1019
|
+
show_transferee_as_caller?: boolean;
|
|
1020
|
+
}
|
|
1021
|
+
namespace TransferOptionAgenticWarmTransfer {
|
|
1022
|
+
/**
|
|
1023
|
+
* Configuration for agentic warm transfer. Required for agentic warm transfer.
|
|
1024
|
+
*/
|
|
1025
|
+
interface AgenticTransferConfig {
|
|
1026
|
+
/**
|
|
1027
|
+
* The action to take when the transfer agent times out without making a decision.
|
|
1028
|
+
* Defaults to cancel_transfer.
|
|
1029
|
+
*/
|
|
1030
|
+
action_on_timeout?: 'bridge_transfer' | 'cancel_transfer';
|
|
1031
|
+
/**
|
|
1032
|
+
* The agent that will mediate the transfer decision.
|
|
1033
|
+
*/
|
|
1034
|
+
transfer_agent?: AgenticTransferConfig.TransferAgent;
|
|
1035
|
+
/**
|
|
1036
|
+
* The maximum time to wait for the transfer agent to make a decision, in
|
|
1037
|
+
* milliseconds. Defaults to 30000 (30 seconds).
|
|
1038
|
+
*/
|
|
1039
|
+
transfer_timeout_ms?: number;
|
|
1040
|
+
}
|
|
1041
|
+
namespace AgenticTransferConfig {
|
|
1042
|
+
/**
|
|
1043
|
+
* The agent that will mediate the transfer decision.
|
|
1044
|
+
*/
|
|
1045
|
+
interface TransferAgent {
|
|
1046
|
+
/**
|
|
1047
|
+
* The agent ID of the transfer agent. This agent must have isTransferAgent set to
|
|
1048
|
+
* true and should use bridge_transfer and cancel_transfer tools (for Retell LLM)
|
|
1049
|
+
* or BridgeTransferNode and CancelTransferNode (for Conversation Flow).
|
|
1050
|
+
*/
|
|
1051
|
+
agent_id: string;
|
|
1052
|
+
/**
|
|
1053
|
+
* The version of the transfer agent to use.
|
|
1054
|
+
*/
|
|
1055
|
+
agent_version: number;
|
|
1056
|
+
}
|
|
1057
|
+
}
|
|
1058
|
+
interface WarmTransferPrompt {
|
|
1059
|
+
/**
|
|
1060
|
+
* The prompt to be used for warm handoff. Can contain dynamic variables.
|
|
1061
|
+
*/
|
|
1062
|
+
prompt?: string;
|
|
1063
|
+
type?: 'prompt';
|
|
1064
|
+
}
|
|
1065
|
+
interface WarmTransferStaticMessage {
|
|
1066
|
+
/**
|
|
1067
|
+
* The static message to be used for warm handoff. Can contain dynamic variables.
|
|
1068
|
+
*/
|
|
1069
|
+
message?: string;
|
|
1070
|
+
type?: 'static_message';
|
|
1071
|
+
}
|
|
1072
|
+
}
|
|
991
1073
|
/**
|
|
992
1074
|
* Position for frontend display
|
|
993
1075
|
*/
|
|
@@ -1061,7 +1143,7 @@ export declare namespace ConversationFlowResponse {
|
|
|
1061
1143
|
/**
|
|
1062
1144
|
* The LLM model to use
|
|
1063
1145
|
*/
|
|
1064
|
-
model: 'gpt-
|
|
1146
|
+
model: 'gpt-4.1' | 'gpt-4.1-mini' | 'gpt-4.1-nano' | 'gpt-5' | 'gpt-5-mini' | 'gpt-5-nano' | 'claude-4.5-sonnet' | 'claude-4.5-haiku' | 'gemini-2.5-flash' | 'gemini-2.5-flash-lite';
|
|
1065
1147
|
/**
|
|
1066
1148
|
* Type of model choice
|
|
1067
1149
|
*/
|
|
@@ -1253,7 +1335,7 @@ export declare namespace ConversationFlowResponse {
|
|
|
1253
1335
|
/**
|
|
1254
1336
|
* The LLM model to use
|
|
1255
1337
|
*/
|
|
1256
|
-
model: 'gpt-
|
|
1338
|
+
model: 'gpt-4.1' | 'gpt-4.1-mini' | 'gpt-4.1-nano' | 'gpt-5' | 'gpt-5-mini' | 'gpt-5-nano' | 'claude-4.5-sonnet' | 'claude-4.5-haiku' | 'gemini-2.5-flash' | 'gemini-2.5-flash-lite';
|
|
1257
1339
|
/**
|
|
1258
1340
|
* Type of model choice
|
|
1259
1341
|
*/
|
|
@@ -1921,7 +2003,7 @@ export declare namespace ConversationFlowResponse {
|
|
|
1921
2003
|
/**
|
|
1922
2004
|
* The LLM model to use
|
|
1923
2005
|
*/
|
|
1924
|
-
model: 'gpt-
|
|
2006
|
+
model: 'gpt-4.1' | 'gpt-4.1-mini' | 'gpt-4.1-nano' | 'gpt-5' | 'gpt-5-mini' | 'gpt-5-nano' | 'claude-4.5-sonnet' | 'claude-4.5-haiku' | 'gemini-2.5-flash' | 'gemini-2.5-flash-lite';
|
|
1925
2007
|
/**
|
|
1926
2008
|
* Type of model choice
|
|
1927
2009
|
*/
|
|
@@ -2707,7 +2789,7 @@ export declare namespace ConversationFlowResponse {
|
|
|
2707
2789
|
/**
|
|
2708
2790
|
* The LLM model to use
|
|
2709
2791
|
*/
|
|
2710
|
-
model: 'gpt-
|
|
2792
|
+
model: 'gpt-4.1' | 'gpt-4.1-mini' | 'gpt-4.1-nano' | 'gpt-5' | 'gpt-5-mini' | 'gpt-5-nano' | 'claude-4.5-sonnet' | 'claude-4.5-haiku' | 'gemini-2.5-flash' | 'gemini-2.5-flash-lite';
|
|
2711
2793
|
/**
|
|
2712
2794
|
* Type of model choice
|
|
2713
2795
|
*/
|
|
@@ -2938,7 +3020,7 @@ export declare namespace ConversationFlowResponse {
|
|
|
2938
3020
|
/**
|
|
2939
3021
|
* The LLM model to use
|
|
2940
3022
|
*/
|
|
2941
|
-
model: 'gpt-
|
|
3023
|
+
model: 'gpt-4.1' | 'gpt-4.1-mini' | 'gpt-4.1-nano' | 'gpt-5' | 'gpt-5-mini' | 'gpt-5-nano' | 'claude-4.5-sonnet' | 'claude-4.5-haiku' | 'gemini-2.5-flash' | 'gemini-2.5-flash-lite';
|
|
2942
3024
|
/**
|
|
2943
3025
|
* Type of model choice
|
|
2944
3026
|
*/
|
|
@@ -3293,7 +3375,7 @@ export declare namespace ConversationFlowResponse {
|
|
|
3293
3375
|
/**
|
|
3294
3376
|
* The LLM model to use
|
|
3295
3377
|
*/
|
|
3296
|
-
model: 'gpt-
|
|
3378
|
+
model: 'gpt-4.1' | 'gpt-4.1-mini' | 'gpt-4.1-nano' | 'gpt-5' | 'gpt-5-mini' | 'gpt-5-nano' | 'claude-4.5-sonnet' | 'claude-4.5-haiku' | 'gemini-2.5-flash' | 'gemini-2.5-flash-lite';
|
|
3297
3379
|
/**
|
|
3298
3380
|
* Type of model choice
|
|
3299
3381
|
*/
|
|
@@ -3311,7 +3393,7 @@ export declare namespace ConversationFlowResponse {
|
|
|
3311
3393
|
id: string;
|
|
3312
3394
|
edge: TransferCallNode.Edge;
|
|
3313
3395
|
transfer_destination: TransferCallNode.TransferDestinationPredefined | TransferCallNode.TransferDestinationInferred;
|
|
3314
|
-
transfer_option: TransferCallNode.TransferOptionColdTransfer | TransferCallNode.TransferOptionWarmTransfer;
|
|
3396
|
+
transfer_option: TransferCallNode.TransferOptionColdTransfer | TransferCallNode.TransferOptionWarmTransfer | TransferCallNode.TransferOptionAgenticWarmTransfer;
|
|
3315
3397
|
/**
|
|
3316
3398
|
* Type of the node
|
|
3317
3399
|
*/
|
|
@@ -3519,6 +3601,88 @@ export declare namespace ConversationFlowResponse {
|
|
|
3519
3601
|
type?: 'static_message';
|
|
3520
3602
|
}
|
|
3521
3603
|
}
|
|
3604
|
+
interface TransferOptionAgenticWarmTransfer {
|
|
3605
|
+
/**
|
|
3606
|
+
* Configuration for agentic warm transfer. Required for agentic warm transfer.
|
|
3607
|
+
*/
|
|
3608
|
+
agentic_transfer_config: TransferOptionAgenticWarmTransfer.AgenticTransferConfig;
|
|
3609
|
+
/**
|
|
3610
|
+
* The type of the transfer.
|
|
3611
|
+
*/
|
|
3612
|
+
type: 'agentic_warm_transfer';
|
|
3613
|
+
/**
|
|
3614
|
+
* Whether to play an audio cue when bridging the call. Defaults to true.
|
|
3615
|
+
*/
|
|
3616
|
+
enable_bridge_audio_cue?: boolean;
|
|
3617
|
+
/**
|
|
3618
|
+
* The music to play while the caller is being transferred.
|
|
3619
|
+
*/
|
|
3620
|
+
on_hold_music?: 'none' | 'relaxing_sound' | 'uplifting_beats' | 'ringtone';
|
|
3621
|
+
/**
|
|
3622
|
+
* If set, when transfer is successful, will say the handoff message to both the
|
|
3623
|
+
* transferee and the agent receiving the transfer. Can leave either a static
|
|
3624
|
+
* message or a dynamic one based on prompt. Set to null to disable warm handoff.
|
|
3625
|
+
*/
|
|
3626
|
+
public_handoff_option?: TransferOptionAgenticWarmTransfer.WarmTransferPrompt | TransferOptionAgenticWarmTransfer.WarmTransferStaticMessage;
|
|
3627
|
+
/**
|
|
3628
|
+
* If set to true, will show transferee (the user, not the AI agent) as caller when
|
|
3629
|
+
* transferring, requires the telephony side to support caller id override. Retell
|
|
3630
|
+
* Twilio numbers support this option.
|
|
3631
|
+
*/
|
|
3632
|
+
show_transferee_as_caller?: boolean;
|
|
3633
|
+
}
|
|
3634
|
+
namespace TransferOptionAgenticWarmTransfer {
|
|
3635
|
+
/**
|
|
3636
|
+
* Configuration for agentic warm transfer. Required for agentic warm transfer.
|
|
3637
|
+
*/
|
|
3638
|
+
interface AgenticTransferConfig {
|
|
3639
|
+
/**
|
|
3640
|
+
* The action to take when the transfer agent times out without making a decision.
|
|
3641
|
+
* Defaults to cancel_transfer.
|
|
3642
|
+
*/
|
|
3643
|
+
action_on_timeout?: 'bridge_transfer' | 'cancel_transfer';
|
|
3644
|
+
/**
|
|
3645
|
+
* The agent that will mediate the transfer decision.
|
|
3646
|
+
*/
|
|
3647
|
+
transfer_agent?: AgenticTransferConfig.TransferAgent;
|
|
3648
|
+
/**
|
|
3649
|
+
* The maximum time to wait for the transfer agent to make a decision, in
|
|
3650
|
+
* milliseconds. Defaults to 30000 (30 seconds).
|
|
3651
|
+
*/
|
|
3652
|
+
transfer_timeout_ms?: number;
|
|
3653
|
+
}
|
|
3654
|
+
namespace AgenticTransferConfig {
|
|
3655
|
+
/**
|
|
3656
|
+
* The agent that will mediate the transfer decision.
|
|
3657
|
+
*/
|
|
3658
|
+
interface TransferAgent {
|
|
3659
|
+
/**
|
|
3660
|
+
* The agent ID of the transfer agent. This agent must have isTransferAgent set to
|
|
3661
|
+
* true and should use bridge_transfer and cancel_transfer tools (for Retell LLM)
|
|
3662
|
+
* or BridgeTransferNode and CancelTransferNode (for Conversation Flow).
|
|
3663
|
+
*/
|
|
3664
|
+
agent_id: string;
|
|
3665
|
+
/**
|
|
3666
|
+
* The version of the transfer agent to use.
|
|
3667
|
+
*/
|
|
3668
|
+
agent_version: number;
|
|
3669
|
+
}
|
|
3670
|
+
}
|
|
3671
|
+
interface WarmTransferPrompt {
|
|
3672
|
+
/**
|
|
3673
|
+
* The prompt to be used for warm handoff. Can contain dynamic variables.
|
|
3674
|
+
*/
|
|
3675
|
+
prompt?: string;
|
|
3676
|
+
type?: 'prompt';
|
|
3677
|
+
}
|
|
3678
|
+
interface WarmTransferStaticMessage {
|
|
3679
|
+
/**
|
|
3680
|
+
* The static message to be used for warm handoff. Can contain dynamic variables.
|
|
3681
|
+
*/
|
|
3682
|
+
message?: string;
|
|
3683
|
+
type?: 'static_message';
|
|
3684
|
+
}
|
|
3685
|
+
}
|
|
3522
3686
|
/**
|
|
3523
3687
|
* Position for frontend display
|
|
3524
3688
|
*/
|
|
@@ -3592,7 +3756,7 @@ export declare namespace ConversationFlowResponse {
|
|
|
3592
3756
|
/**
|
|
3593
3757
|
* The LLM model to use
|
|
3594
3758
|
*/
|
|
3595
|
-
model: 'gpt-
|
|
3759
|
+
model: 'gpt-4.1' | 'gpt-4.1-mini' | 'gpt-4.1-nano' | 'gpt-5' | 'gpt-5-mini' | 'gpt-5-nano' | 'claude-4.5-sonnet' | 'claude-4.5-haiku' | 'gemini-2.5-flash' | 'gemini-2.5-flash-lite';
|
|
3596
3760
|
/**
|
|
3597
3761
|
* Type of model choice
|
|
3598
3762
|
*/
|
|
@@ -3784,7 +3948,7 @@ export declare namespace ConversationFlowResponse {
|
|
|
3784
3948
|
/**
|
|
3785
3949
|
* The LLM model to use
|
|
3786
3950
|
*/
|
|
3787
|
-
model: 'gpt-
|
|
3951
|
+
model: 'gpt-4.1' | 'gpt-4.1-mini' | 'gpt-4.1-nano' | 'gpt-5' | 'gpt-5-mini' | 'gpt-5-nano' | 'claude-4.5-sonnet' | 'claude-4.5-haiku' | 'gemini-2.5-flash' | 'gemini-2.5-flash-lite';
|
|
3788
3952
|
/**
|
|
3789
3953
|
* Type of model choice
|
|
3790
3954
|
*/
|
|
@@ -4452,7 +4616,7 @@ export declare namespace ConversationFlowResponse {
|
|
|
4452
4616
|
/**
|
|
4453
4617
|
* The LLM model to use
|
|
4454
4618
|
*/
|
|
4455
|
-
model: 'gpt-
|
|
4619
|
+
model: 'gpt-4.1' | 'gpt-4.1-mini' | 'gpt-4.1-nano' | 'gpt-5' | 'gpt-5-mini' | 'gpt-5-nano' | 'claude-4.5-sonnet' | 'claude-4.5-haiku' | 'gemini-2.5-flash' | 'gemini-2.5-flash-lite';
|
|
4456
4620
|
/**
|
|
4457
4621
|
* Type of model choice
|
|
4458
4622
|
*/
|
|
@@ -5270,7 +5434,7 @@ export declare namespace ConversationFlowCreateParams {
|
|
|
5270
5434
|
/**
|
|
5271
5435
|
* The LLM model to use
|
|
5272
5436
|
*/
|
|
5273
|
-
model: 'gpt-
|
|
5437
|
+
model: 'gpt-4.1' | 'gpt-4.1-mini' | 'gpt-4.1-nano' | 'gpt-5' | 'gpt-5-mini' | 'gpt-5-nano' | 'claude-4.5-sonnet' | 'claude-4.5-haiku' | 'gemini-2.5-flash' | 'gemini-2.5-flash-lite';
|
|
5274
5438
|
/**
|
|
5275
5439
|
* Type of model choice
|
|
5276
5440
|
*/
|
|
@@ -5501,7 +5665,7 @@ export declare namespace ConversationFlowCreateParams {
|
|
|
5501
5665
|
/**
|
|
5502
5666
|
* The LLM model to use
|
|
5503
5667
|
*/
|
|
5504
|
-
model: 'gpt-
|
|
5668
|
+
model: 'gpt-4.1' | 'gpt-4.1-mini' | 'gpt-4.1-nano' | 'gpt-5' | 'gpt-5-mini' | 'gpt-5-nano' | 'claude-4.5-sonnet' | 'claude-4.5-haiku' | 'gemini-2.5-flash' | 'gemini-2.5-flash-lite';
|
|
5505
5669
|
/**
|
|
5506
5670
|
* Type of model choice
|
|
5507
5671
|
*/
|
|
@@ -5856,7 +6020,7 @@ export declare namespace ConversationFlowCreateParams {
|
|
|
5856
6020
|
/**
|
|
5857
6021
|
* The LLM model to use
|
|
5858
6022
|
*/
|
|
5859
|
-
model: 'gpt-
|
|
6023
|
+
model: 'gpt-4.1' | 'gpt-4.1-mini' | 'gpt-4.1-nano' | 'gpt-5' | 'gpt-5-mini' | 'gpt-5-nano' | 'claude-4.5-sonnet' | 'claude-4.5-haiku' | 'gemini-2.5-flash' | 'gemini-2.5-flash-lite';
|
|
5860
6024
|
/**
|
|
5861
6025
|
* Type of model choice
|
|
5862
6026
|
*/
|
|
@@ -5874,7 +6038,7 @@ export declare namespace ConversationFlowCreateParams {
|
|
|
5874
6038
|
id: string;
|
|
5875
6039
|
edge: TransferCallNode.Edge;
|
|
5876
6040
|
transfer_destination: TransferCallNode.TransferDestinationPredefined | TransferCallNode.TransferDestinationInferred;
|
|
5877
|
-
transfer_option: TransferCallNode.TransferOptionColdTransfer | TransferCallNode.TransferOptionWarmTransfer;
|
|
6041
|
+
transfer_option: TransferCallNode.TransferOptionColdTransfer | TransferCallNode.TransferOptionWarmTransfer | TransferCallNode.TransferOptionAgenticWarmTransfer;
|
|
5878
6042
|
/**
|
|
5879
6043
|
* Type of the node
|
|
5880
6044
|
*/
|
|
@@ -6082,6 +6246,88 @@ export declare namespace ConversationFlowCreateParams {
|
|
|
6082
6246
|
type?: 'static_message';
|
|
6083
6247
|
}
|
|
6084
6248
|
}
|
|
6249
|
+
interface TransferOptionAgenticWarmTransfer {
|
|
6250
|
+
/**
|
|
6251
|
+
* Configuration for agentic warm transfer. Required for agentic warm transfer.
|
|
6252
|
+
*/
|
|
6253
|
+
agentic_transfer_config: TransferOptionAgenticWarmTransfer.AgenticTransferConfig;
|
|
6254
|
+
/**
|
|
6255
|
+
* The type of the transfer.
|
|
6256
|
+
*/
|
|
6257
|
+
type: 'agentic_warm_transfer';
|
|
6258
|
+
/**
|
|
6259
|
+
* Whether to play an audio cue when bridging the call. Defaults to true.
|
|
6260
|
+
*/
|
|
6261
|
+
enable_bridge_audio_cue?: boolean;
|
|
6262
|
+
/**
|
|
6263
|
+
* The music to play while the caller is being transferred.
|
|
6264
|
+
*/
|
|
6265
|
+
on_hold_music?: 'none' | 'relaxing_sound' | 'uplifting_beats' | 'ringtone';
|
|
6266
|
+
/**
|
|
6267
|
+
* If set, when transfer is successful, will say the handoff message to both the
|
|
6268
|
+
* transferee and the agent receiving the transfer. Can leave either a static
|
|
6269
|
+
* message or a dynamic one based on prompt. Set to null to disable warm handoff.
|
|
6270
|
+
*/
|
|
6271
|
+
public_handoff_option?: TransferOptionAgenticWarmTransfer.WarmTransferPrompt | TransferOptionAgenticWarmTransfer.WarmTransferStaticMessage;
|
|
6272
|
+
/**
|
|
6273
|
+
* If set to true, will show transferee (the user, not the AI agent) as caller when
|
|
6274
|
+
* transferring, requires the telephony side to support caller id override. Retell
|
|
6275
|
+
* Twilio numbers support this option.
|
|
6276
|
+
*/
|
|
6277
|
+
show_transferee_as_caller?: boolean;
|
|
6278
|
+
}
|
|
6279
|
+
namespace TransferOptionAgenticWarmTransfer {
|
|
6280
|
+
/**
|
|
6281
|
+
* Configuration for agentic warm transfer. Required for agentic warm transfer.
|
|
6282
|
+
*/
|
|
6283
|
+
interface AgenticTransferConfig {
|
|
6284
|
+
/**
|
|
6285
|
+
* The action to take when the transfer agent times out without making a decision.
|
|
6286
|
+
* Defaults to cancel_transfer.
|
|
6287
|
+
*/
|
|
6288
|
+
action_on_timeout?: 'bridge_transfer' | 'cancel_transfer';
|
|
6289
|
+
/**
|
|
6290
|
+
* The agent that will mediate the transfer decision.
|
|
6291
|
+
*/
|
|
6292
|
+
transfer_agent?: AgenticTransferConfig.TransferAgent;
|
|
6293
|
+
/**
|
|
6294
|
+
* The maximum time to wait for the transfer agent to make a decision, in
|
|
6295
|
+
* milliseconds. Defaults to 30000 (30 seconds).
|
|
6296
|
+
*/
|
|
6297
|
+
transfer_timeout_ms?: number;
|
|
6298
|
+
}
|
|
6299
|
+
namespace AgenticTransferConfig {
|
|
6300
|
+
/**
|
|
6301
|
+
* The agent that will mediate the transfer decision.
|
|
6302
|
+
*/
|
|
6303
|
+
interface TransferAgent {
|
|
6304
|
+
/**
|
|
6305
|
+
* The agent ID of the transfer agent. This agent must have isTransferAgent set to
|
|
6306
|
+
* true and should use bridge_transfer and cancel_transfer tools (for Retell LLM)
|
|
6307
|
+
* or BridgeTransferNode and CancelTransferNode (for Conversation Flow).
|
|
6308
|
+
*/
|
|
6309
|
+
agent_id: string;
|
|
6310
|
+
/**
|
|
6311
|
+
* The version of the transfer agent to use.
|
|
6312
|
+
*/
|
|
6313
|
+
agent_version: number;
|
|
6314
|
+
}
|
|
6315
|
+
}
|
|
6316
|
+
interface WarmTransferPrompt {
|
|
6317
|
+
/**
|
|
6318
|
+
* The prompt to be used for warm handoff. Can contain dynamic variables.
|
|
6319
|
+
*/
|
|
6320
|
+
prompt?: string;
|
|
6321
|
+
type?: 'prompt';
|
|
6322
|
+
}
|
|
6323
|
+
interface WarmTransferStaticMessage {
|
|
6324
|
+
/**
|
|
6325
|
+
* The static message to be used for warm handoff. Can contain dynamic variables.
|
|
6326
|
+
*/
|
|
6327
|
+
message?: string;
|
|
6328
|
+
type?: 'static_message';
|
|
6329
|
+
}
|
|
6330
|
+
}
|
|
6085
6331
|
/**
|
|
6086
6332
|
* Position for frontend display
|
|
6087
6333
|
*/
|
|
@@ -6155,7 +6401,7 @@ export declare namespace ConversationFlowCreateParams {
|
|
|
6155
6401
|
/**
|
|
6156
6402
|
* The LLM model to use
|
|
6157
6403
|
*/
|
|
6158
|
-
model: 'gpt-
|
|
6404
|
+
model: 'gpt-4.1' | 'gpt-4.1-mini' | 'gpt-4.1-nano' | 'gpt-5' | 'gpt-5-mini' | 'gpt-5-nano' | 'claude-4.5-sonnet' | 'claude-4.5-haiku' | 'gemini-2.5-flash' | 'gemini-2.5-flash-lite';
|
|
6159
6405
|
/**
|
|
6160
6406
|
* Type of model choice
|
|
6161
6407
|
*/
|
|
@@ -6347,7 +6593,7 @@ export declare namespace ConversationFlowCreateParams {
|
|
|
6347
6593
|
/**
|
|
6348
6594
|
* The LLM model to use
|
|
6349
6595
|
*/
|
|
6350
|
-
model: 'gpt-
|
|
6596
|
+
model: 'gpt-4.1' | 'gpt-4.1-mini' | 'gpt-4.1-nano' | 'gpt-5' | 'gpt-5-mini' | 'gpt-5-nano' | 'claude-4.5-sonnet' | 'claude-4.5-haiku' | 'gemini-2.5-flash' | 'gemini-2.5-flash-lite';
|
|
6351
6597
|
/**
|
|
6352
6598
|
* Type of model choice
|
|
6353
6599
|
*/
|
|
@@ -7015,7 +7261,7 @@ export declare namespace ConversationFlowCreateParams {
|
|
|
7015
7261
|
/**
|
|
7016
7262
|
* The LLM model to use
|
|
7017
7263
|
*/
|
|
7018
|
-
model: 'gpt-
|
|
7264
|
+
model: 'gpt-4.1' | 'gpt-4.1-mini' | 'gpt-4.1-nano' | 'gpt-5' | 'gpt-5-mini' | 'gpt-5-nano' | 'claude-4.5-sonnet' | 'claude-4.5-haiku' | 'gemini-2.5-flash' | 'gemini-2.5-flash-lite';
|
|
7019
7265
|
/**
|
|
7020
7266
|
* Type of model choice
|
|
7021
7267
|
*/
|
|
@@ -7852,7 +8098,7 @@ export declare namespace ConversationFlowCreateParams {
|
|
|
7852
8098
|
/**
|
|
7853
8099
|
* The LLM model to use
|
|
7854
8100
|
*/
|
|
7855
|
-
model: 'gpt-
|
|
8101
|
+
model: 'gpt-4.1' | 'gpt-4.1-mini' | 'gpt-4.1-nano' | 'gpt-5' | 'gpt-5-mini' | 'gpt-5-nano' | 'claude-4.5-sonnet' | 'claude-4.5-haiku' | 'gemini-2.5-flash' | 'gemini-2.5-flash-lite';
|
|
7856
8102
|
/**
|
|
7857
8103
|
* Type of model choice
|
|
7858
8104
|
*/
|
|
@@ -8207,7 +8453,7 @@ export declare namespace ConversationFlowCreateParams {
|
|
|
8207
8453
|
/**
|
|
8208
8454
|
* The LLM model to use
|
|
8209
8455
|
*/
|
|
8210
|
-
model: 'gpt-
|
|
8456
|
+
model: 'gpt-4.1' | 'gpt-4.1-mini' | 'gpt-4.1-nano' | 'gpt-5' | 'gpt-5-mini' | 'gpt-5-nano' | 'claude-4.5-sonnet' | 'claude-4.5-haiku' | 'gemini-2.5-flash' | 'gemini-2.5-flash-lite';
|
|
8211
8457
|
/**
|
|
8212
8458
|
* Type of model choice
|
|
8213
8459
|
*/
|
|
@@ -8225,7 +8471,7 @@ export declare namespace ConversationFlowCreateParams {
|
|
|
8225
8471
|
id: string;
|
|
8226
8472
|
edge: TransferCallNode.Edge;
|
|
8227
8473
|
transfer_destination: TransferCallNode.TransferDestinationPredefined | TransferCallNode.TransferDestinationInferred;
|
|
8228
|
-
transfer_option: TransferCallNode.TransferOptionColdTransfer | TransferCallNode.TransferOptionWarmTransfer;
|
|
8474
|
+
transfer_option: TransferCallNode.TransferOptionColdTransfer | TransferCallNode.TransferOptionWarmTransfer | TransferCallNode.TransferOptionAgenticWarmTransfer;
|
|
8229
8475
|
/**
|
|
8230
8476
|
* Type of the node
|
|
8231
8477
|
*/
|
|
@@ -8433,6 +8679,88 @@ export declare namespace ConversationFlowCreateParams {
|
|
|
8433
8679
|
type?: 'static_message';
|
|
8434
8680
|
}
|
|
8435
8681
|
}
|
|
8682
|
+
interface TransferOptionAgenticWarmTransfer {
|
|
8683
|
+
/**
|
|
8684
|
+
* Configuration for agentic warm transfer. Required for agentic warm transfer.
|
|
8685
|
+
*/
|
|
8686
|
+
agentic_transfer_config: TransferOptionAgenticWarmTransfer.AgenticTransferConfig;
|
|
8687
|
+
/**
|
|
8688
|
+
* The type of the transfer.
|
|
8689
|
+
*/
|
|
8690
|
+
type: 'agentic_warm_transfer';
|
|
8691
|
+
/**
|
|
8692
|
+
* Whether to play an audio cue when bridging the call. Defaults to true.
|
|
8693
|
+
*/
|
|
8694
|
+
enable_bridge_audio_cue?: boolean;
|
|
8695
|
+
/**
|
|
8696
|
+
* The music to play while the caller is being transferred.
|
|
8697
|
+
*/
|
|
8698
|
+
on_hold_music?: 'none' | 'relaxing_sound' | 'uplifting_beats' | 'ringtone';
|
|
8699
|
+
/**
|
|
8700
|
+
* If set, when transfer is successful, will say the handoff message to both the
|
|
8701
|
+
* transferee and the agent receiving the transfer. Can leave either a static
|
|
8702
|
+
* message or a dynamic one based on prompt. Set to null to disable warm handoff.
|
|
8703
|
+
*/
|
|
8704
|
+
public_handoff_option?: TransferOptionAgenticWarmTransfer.WarmTransferPrompt | TransferOptionAgenticWarmTransfer.WarmTransferStaticMessage;
|
|
8705
|
+
/**
|
|
8706
|
+
* If set to true, will show transferee (the user, not the AI agent) as caller when
|
|
8707
|
+
* transferring, requires the telephony side to support caller id override. Retell
|
|
8708
|
+
* Twilio numbers support this option.
|
|
8709
|
+
*/
|
|
8710
|
+
show_transferee_as_caller?: boolean;
|
|
8711
|
+
}
|
|
8712
|
+
namespace TransferOptionAgenticWarmTransfer {
|
|
8713
|
+
/**
|
|
8714
|
+
* Configuration for agentic warm transfer. Required for agentic warm transfer.
|
|
8715
|
+
*/
|
|
8716
|
+
interface AgenticTransferConfig {
|
|
8717
|
+
/**
|
|
8718
|
+
* The action to take when the transfer agent times out without making a decision.
|
|
8719
|
+
* Defaults to cancel_transfer.
|
|
8720
|
+
*/
|
|
8721
|
+
action_on_timeout?: 'bridge_transfer' | 'cancel_transfer';
|
|
8722
|
+
/**
|
|
8723
|
+
* The agent that will mediate the transfer decision.
|
|
8724
|
+
*/
|
|
8725
|
+
transfer_agent?: AgenticTransferConfig.TransferAgent;
|
|
8726
|
+
/**
|
|
8727
|
+
* The maximum time to wait for the transfer agent to make a decision, in
|
|
8728
|
+
* milliseconds. Defaults to 30000 (30 seconds).
|
|
8729
|
+
*/
|
|
8730
|
+
transfer_timeout_ms?: number;
|
|
8731
|
+
}
|
|
8732
|
+
namespace AgenticTransferConfig {
|
|
8733
|
+
/**
|
|
8734
|
+
* The agent that will mediate the transfer decision.
|
|
8735
|
+
*/
|
|
8736
|
+
interface TransferAgent {
|
|
8737
|
+
/**
|
|
8738
|
+
* The agent ID of the transfer agent. This agent must have isTransferAgent set to
|
|
8739
|
+
* true and should use bridge_transfer and cancel_transfer tools (for Retell LLM)
|
|
8740
|
+
* or BridgeTransferNode and CancelTransferNode (for Conversation Flow).
|
|
8741
|
+
*/
|
|
8742
|
+
agent_id: string;
|
|
8743
|
+
/**
|
|
8744
|
+
* The version of the transfer agent to use.
|
|
8745
|
+
*/
|
|
8746
|
+
agent_version: number;
|
|
8747
|
+
}
|
|
8748
|
+
}
|
|
8749
|
+
interface WarmTransferPrompt {
|
|
8750
|
+
/**
|
|
8751
|
+
* The prompt to be used for warm handoff. Can contain dynamic variables.
|
|
8752
|
+
*/
|
|
8753
|
+
prompt?: string;
|
|
8754
|
+
type?: 'prompt';
|
|
8755
|
+
}
|
|
8756
|
+
interface WarmTransferStaticMessage {
|
|
8757
|
+
/**
|
|
8758
|
+
* The static message to be used for warm handoff. Can contain dynamic variables.
|
|
8759
|
+
*/
|
|
8760
|
+
message?: string;
|
|
8761
|
+
type?: 'static_message';
|
|
8762
|
+
}
|
|
8763
|
+
}
|
|
8436
8764
|
/**
|
|
8437
8765
|
* Position for frontend display
|
|
8438
8766
|
*/
|
|
@@ -8506,7 +8834,7 @@ export declare namespace ConversationFlowCreateParams {
|
|
|
8506
8834
|
/**
|
|
8507
8835
|
* The LLM model to use
|
|
8508
8836
|
*/
|
|
8509
|
-
model: 'gpt-
|
|
8837
|
+
model: 'gpt-4.1' | 'gpt-4.1-mini' | 'gpt-4.1-nano' | 'gpt-5' | 'gpt-5-mini' | 'gpt-5-nano' | 'claude-4.5-sonnet' | 'claude-4.5-haiku' | 'gemini-2.5-flash' | 'gemini-2.5-flash-lite';
|
|
8510
8838
|
/**
|
|
8511
8839
|
* Type of model choice
|
|
8512
8840
|
*/
|
|
@@ -8698,7 +9026,7 @@ export declare namespace ConversationFlowCreateParams {
|
|
|
8698
9026
|
/**
|
|
8699
9027
|
* The LLM model to use
|
|
8700
9028
|
*/
|
|
8701
|
-
model: 'gpt-
|
|
9029
|
+
model: 'gpt-4.1' | 'gpt-4.1-mini' | 'gpt-4.1-nano' | 'gpt-5' | 'gpt-5-mini' | 'gpt-5-nano' | 'claude-4.5-sonnet' | 'claude-4.5-haiku' | 'gemini-2.5-flash' | 'gemini-2.5-flash-lite';
|
|
8702
9030
|
/**
|
|
8703
9031
|
* Type of model choice
|
|
8704
9032
|
*/
|
|
@@ -9366,7 +9694,7 @@ export declare namespace ConversationFlowCreateParams {
|
|
|
9366
9694
|
/**
|
|
9367
9695
|
* The LLM model to use
|
|
9368
9696
|
*/
|
|
9369
|
-
model: 'gpt-
|
|
9697
|
+
model: 'gpt-4.1' | 'gpt-4.1-mini' | 'gpt-4.1-nano' | 'gpt-5' | 'gpt-5-mini' | 'gpt-5-nano' | 'claude-4.5-sonnet' | 'claude-4.5-haiku' | 'gemini-2.5-flash' | 'gemini-2.5-flash-lite';
|
|
9370
9698
|
/**
|
|
9371
9699
|
* Type of model choice
|
|
9372
9700
|
*/
|
|
@@ -10295,13 +10623,18 @@ export declare namespace ConversationFlowCreateParams {
|
|
|
10295
10623
|
}
|
|
10296
10624
|
}
|
|
10297
10625
|
export interface ConversationFlowRetrieveParams {
|
|
10298
|
-
|
|
10626
|
+
/**
|
|
10627
|
+
* Optional version of the conversation flow to retrieve. Default to latest
|
|
10628
|
+
* version.
|
|
10629
|
+
*/
|
|
10630
|
+
version?: number;
|
|
10299
10631
|
}
|
|
10300
10632
|
export interface ConversationFlowUpdateParams {
|
|
10301
10633
|
/**
|
|
10302
|
-
* Query param:
|
|
10634
|
+
* Query param: Optional version of the conversation flow to update. Default to
|
|
10635
|
+
* latest version.
|
|
10303
10636
|
*/
|
|
10304
|
-
version?:
|
|
10637
|
+
version?: number;
|
|
10305
10638
|
/**
|
|
10306
10639
|
* Body param: If set, the AI will begin the conversation after waiting for the
|
|
10307
10640
|
* user for the duration (in milliseconds) specified by this attribute. This only
|
|
@@ -10628,7 +10961,7 @@ export declare namespace ConversationFlowUpdateParams {
|
|
|
10628
10961
|
/**
|
|
10629
10962
|
* The LLM model to use
|
|
10630
10963
|
*/
|
|
10631
|
-
model: 'gpt-
|
|
10964
|
+
model: 'gpt-4.1' | 'gpt-4.1-mini' | 'gpt-4.1-nano' | 'gpt-5' | 'gpt-5-mini' | 'gpt-5-nano' | 'claude-4.5-sonnet' | 'claude-4.5-haiku' | 'gemini-2.5-flash' | 'gemini-2.5-flash-lite';
|
|
10632
10965
|
/**
|
|
10633
10966
|
* Type of model choice
|
|
10634
10967
|
*/
|
|
@@ -10983,7 +11316,7 @@ export declare namespace ConversationFlowUpdateParams {
|
|
|
10983
11316
|
/**
|
|
10984
11317
|
* The LLM model to use
|
|
10985
11318
|
*/
|
|
10986
|
-
model: 'gpt-
|
|
11319
|
+
model: 'gpt-4.1' | 'gpt-4.1-mini' | 'gpt-4.1-nano' | 'gpt-5' | 'gpt-5-mini' | 'gpt-5-nano' | 'claude-4.5-sonnet' | 'claude-4.5-haiku' | 'gemini-2.5-flash' | 'gemini-2.5-flash-lite';
|
|
10987
11320
|
/**
|
|
10988
11321
|
* Type of model choice
|
|
10989
11322
|
*/
|
|
@@ -11001,7 +11334,7 @@ export declare namespace ConversationFlowUpdateParams {
|
|
|
11001
11334
|
id: string;
|
|
11002
11335
|
edge: TransferCallNode.Edge;
|
|
11003
11336
|
transfer_destination: TransferCallNode.TransferDestinationPredefined | TransferCallNode.TransferDestinationInferred;
|
|
11004
|
-
transfer_option: TransferCallNode.TransferOptionColdTransfer | TransferCallNode.TransferOptionWarmTransfer;
|
|
11337
|
+
transfer_option: TransferCallNode.TransferOptionColdTransfer | TransferCallNode.TransferOptionWarmTransfer | TransferCallNode.TransferOptionAgenticWarmTransfer;
|
|
11005
11338
|
/**
|
|
11006
11339
|
* Type of the node
|
|
11007
11340
|
*/
|
|
@@ -11209,6 +11542,88 @@ export declare namespace ConversationFlowUpdateParams {
|
|
|
11209
11542
|
type?: 'static_message';
|
|
11210
11543
|
}
|
|
11211
11544
|
}
|
|
11545
|
+
interface TransferOptionAgenticWarmTransfer {
|
|
11546
|
+
/**
|
|
11547
|
+
* Configuration for agentic warm transfer. Required for agentic warm transfer.
|
|
11548
|
+
*/
|
|
11549
|
+
agentic_transfer_config: TransferOptionAgenticWarmTransfer.AgenticTransferConfig;
|
|
11550
|
+
/**
|
|
11551
|
+
* The type of the transfer.
|
|
11552
|
+
*/
|
|
11553
|
+
type: 'agentic_warm_transfer';
|
|
11554
|
+
/**
|
|
11555
|
+
* Whether to play an audio cue when bridging the call. Defaults to true.
|
|
11556
|
+
*/
|
|
11557
|
+
enable_bridge_audio_cue?: boolean;
|
|
11558
|
+
/**
|
|
11559
|
+
* The music to play while the caller is being transferred.
|
|
11560
|
+
*/
|
|
11561
|
+
on_hold_music?: 'none' | 'relaxing_sound' | 'uplifting_beats' | 'ringtone';
|
|
11562
|
+
/**
|
|
11563
|
+
* If set, when transfer is successful, will say the handoff message to both the
|
|
11564
|
+
* transferee and the agent receiving the transfer. Can leave either a static
|
|
11565
|
+
* message or a dynamic one based on prompt. Set to null to disable warm handoff.
|
|
11566
|
+
*/
|
|
11567
|
+
public_handoff_option?: TransferOptionAgenticWarmTransfer.WarmTransferPrompt | TransferOptionAgenticWarmTransfer.WarmTransferStaticMessage;
|
|
11568
|
+
/**
|
|
11569
|
+
* If set to true, will show transferee (the user, not the AI agent) as caller when
|
|
11570
|
+
* transferring, requires the telephony side to support caller id override. Retell
|
|
11571
|
+
* Twilio numbers support this option.
|
|
11572
|
+
*/
|
|
11573
|
+
show_transferee_as_caller?: boolean;
|
|
11574
|
+
}
|
|
11575
|
+
namespace TransferOptionAgenticWarmTransfer {
|
|
11576
|
+
/**
|
|
11577
|
+
* Configuration for agentic warm transfer. Required for agentic warm transfer.
|
|
11578
|
+
*/
|
|
11579
|
+
interface AgenticTransferConfig {
|
|
11580
|
+
/**
|
|
11581
|
+
* The action to take when the transfer agent times out without making a decision.
|
|
11582
|
+
* Defaults to cancel_transfer.
|
|
11583
|
+
*/
|
|
11584
|
+
action_on_timeout?: 'bridge_transfer' | 'cancel_transfer';
|
|
11585
|
+
/**
|
|
11586
|
+
* The agent that will mediate the transfer decision.
|
|
11587
|
+
*/
|
|
11588
|
+
transfer_agent?: AgenticTransferConfig.TransferAgent;
|
|
11589
|
+
/**
|
|
11590
|
+
* The maximum time to wait for the transfer agent to make a decision, in
|
|
11591
|
+
* milliseconds. Defaults to 30000 (30 seconds).
|
|
11592
|
+
*/
|
|
11593
|
+
transfer_timeout_ms?: number;
|
|
11594
|
+
}
|
|
11595
|
+
namespace AgenticTransferConfig {
|
|
11596
|
+
/**
|
|
11597
|
+
* The agent that will mediate the transfer decision.
|
|
11598
|
+
*/
|
|
11599
|
+
interface TransferAgent {
|
|
11600
|
+
/**
|
|
11601
|
+
* The agent ID of the transfer agent. This agent must have isTransferAgent set to
|
|
11602
|
+
* true and should use bridge_transfer and cancel_transfer tools (for Retell LLM)
|
|
11603
|
+
* or BridgeTransferNode and CancelTransferNode (for Conversation Flow).
|
|
11604
|
+
*/
|
|
11605
|
+
agent_id: string;
|
|
11606
|
+
/**
|
|
11607
|
+
* The version of the transfer agent to use.
|
|
11608
|
+
*/
|
|
11609
|
+
agent_version: number;
|
|
11610
|
+
}
|
|
11611
|
+
}
|
|
11612
|
+
interface WarmTransferPrompt {
|
|
11613
|
+
/**
|
|
11614
|
+
* The prompt to be used for warm handoff. Can contain dynamic variables.
|
|
11615
|
+
*/
|
|
11616
|
+
prompt?: string;
|
|
11617
|
+
type?: 'prompt';
|
|
11618
|
+
}
|
|
11619
|
+
interface WarmTransferStaticMessage {
|
|
11620
|
+
/**
|
|
11621
|
+
* The static message to be used for warm handoff. Can contain dynamic variables.
|
|
11622
|
+
*/
|
|
11623
|
+
message?: string;
|
|
11624
|
+
type?: 'static_message';
|
|
11625
|
+
}
|
|
11626
|
+
}
|
|
11212
11627
|
/**
|
|
11213
11628
|
* Position for frontend display
|
|
11214
11629
|
*/
|
|
@@ -11282,7 +11697,7 @@ export declare namespace ConversationFlowUpdateParams {
|
|
|
11282
11697
|
/**
|
|
11283
11698
|
* The LLM model to use
|
|
11284
11699
|
*/
|
|
11285
|
-
model: 'gpt-
|
|
11700
|
+
model: 'gpt-4.1' | 'gpt-4.1-mini' | 'gpt-4.1-nano' | 'gpt-5' | 'gpt-5-mini' | 'gpt-5-nano' | 'claude-4.5-sonnet' | 'claude-4.5-haiku' | 'gemini-2.5-flash' | 'gemini-2.5-flash-lite';
|
|
11286
11701
|
/**
|
|
11287
11702
|
* Type of model choice
|
|
11288
11703
|
*/
|
|
@@ -11474,7 +11889,7 @@ export declare namespace ConversationFlowUpdateParams {
|
|
|
11474
11889
|
/**
|
|
11475
11890
|
* The LLM model to use
|
|
11476
11891
|
*/
|
|
11477
|
-
model: 'gpt-
|
|
11892
|
+
model: 'gpt-4.1' | 'gpt-4.1-mini' | 'gpt-4.1-nano' | 'gpt-5' | 'gpt-5-mini' | 'gpt-5-nano' | 'claude-4.5-sonnet' | 'claude-4.5-haiku' | 'gemini-2.5-flash' | 'gemini-2.5-flash-lite';
|
|
11478
11893
|
/**
|
|
11479
11894
|
* Type of model choice
|
|
11480
11895
|
*/
|
|
@@ -12142,7 +12557,7 @@ export declare namespace ConversationFlowUpdateParams {
|
|
|
12142
12557
|
/**
|
|
12143
12558
|
* The LLM model to use
|
|
12144
12559
|
*/
|
|
12145
|
-
model: 'gpt-
|
|
12560
|
+
model: 'gpt-4.1' | 'gpt-4.1-mini' | 'gpt-4.1-nano' | 'gpt-5' | 'gpt-5-mini' | 'gpt-5-nano' | 'claude-4.5-sonnet' | 'claude-4.5-haiku' | 'gemini-2.5-flash' | 'gemini-2.5-flash-lite';
|
|
12146
12561
|
/**
|
|
12147
12562
|
* Type of model choice
|
|
12148
12563
|
*/
|
|
@@ -12928,7 +13343,7 @@ export declare namespace ConversationFlowUpdateParams {
|
|
|
12928
13343
|
/**
|
|
12929
13344
|
* The LLM model to use
|
|
12930
13345
|
*/
|
|
12931
|
-
model: 'gpt-
|
|
13346
|
+
model: 'gpt-4.1' | 'gpt-4.1-mini' | 'gpt-4.1-nano' | 'gpt-5' | 'gpt-5-mini' | 'gpt-5-nano' | 'claude-4.5-sonnet' | 'claude-4.5-haiku' | 'gemini-2.5-flash' | 'gemini-2.5-flash-lite';
|
|
12932
13347
|
/**
|
|
12933
13348
|
* Type of model choice
|
|
12934
13349
|
*/
|
|
@@ -13159,7 +13574,7 @@ export declare namespace ConversationFlowUpdateParams {
|
|
|
13159
13574
|
/**
|
|
13160
13575
|
* The LLM model to use
|
|
13161
13576
|
*/
|
|
13162
|
-
model: 'gpt-
|
|
13577
|
+
model: 'gpt-4.1' | 'gpt-4.1-mini' | 'gpt-4.1-nano' | 'gpt-5' | 'gpt-5-mini' | 'gpt-5-nano' | 'claude-4.5-sonnet' | 'claude-4.5-haiku' | 'gemini-2.5-flash' | 'gemini-2.5-flash-lite';
|
|
13163
13578
|
/**
|
|
13164
13579
|
* Type of model choice
|
|
13165
13580
|
*/
|
|
@@ -13514,7 +13929,7 @@ export declare namespace ConversationFlowUpdateParams {
|
|
|
13514
13929
|
/**
|
|
13515
13930
|
* The LLM model to use
|
|
13516
13931
|
*/
|
|
13517
|
-
model: 'gpt-
|
|
13932
|
+
model: 'gpt-4.1' | 'gpt-4.1-mini' | 'gpt-4.1-nano' | 'gpt-5' | 'gpt-5-mini' | 'gpt-5-nano' | 'claude-4.5-sonnet' | 'claude-4.5-haiku' | 'gemini-2.5-flash' | 'gemini-2.5-flash-lite';
|
|
13518
13933
|
/**
|
|
13519
13934
|
* Type of model choice
|
|
13520
13935
|
*/
|
|
@@ -13532,7 +13947,7 @@ export declare namespace ConversationFlowUpdateParams {
|
|
|
13532
13947
|
id: string;
|
|
13533
13948
|
edge: TransferCallNode.Edge;
|
|
13534
13949
|
transfer_destination: TransferCallNode.TransferDestinationPredefined | TransferCallNode.TransferDestinationInferred;
|
|
13535
|
-
transfer_option: TransferCallNode.TransferOptionColdTransfer | TransferCallNode.TransferOptionWarmTransfer;
|
|
13950
|
+
transfer_option: TransferCallNode.TransferOptionColdTransfer | TransferCallNode.TransferOptionWarmTransfer | TransferCallNode.TransferOptionAgenticWarmTransfer;
|
|
13536
13951
|
/**
|
|
13537
13952
|
* Type of the node
|
|
13538
13953
|
*/
|
|
@@ -13740,6 +14155,88 @@ export declare namespace ConversationFlowUpdateParams {
|
|
|
13740
14155
|
type?: 'static_message';
|
|
13741
14156
|
}
|
|
13742
14157
|
}
|
|
14158
|
+
interface TransferOptionAgenticWarmTransfer {
|
|
14159
|
+
/**
|
|
14160
|
+
* Configuration for agentic warm transfer. Required for agentic warm transfer.
|
|
14161
|
+
*/
|
|
14162
|
+
agentic_transfer_config: TransferOptionAgenticWarmTransfer.AgenticTransferConfig;
|
|
14163
|
+
/**
|
|
14164
|
+
* The type of the transfer.
|
|
14165
|
+
*/
|
|
14166
|
+
type: 'agentic_warm_transfer';
|
|
14167
|
+
/**
|
|
14168
|
+
* Whether to play an audio cue when bridging the call. Defaults to true.
|
|
14169
|
+
*/
|
|
14170
|
+
enable_bridge_audio_cue?: boolean;
|
|
14171
|
+
/**
|
|
14172
|
+
* The music to play while the caller is being transferred.
|
|
14173
|
+
*/
|
|
14174
|
+
on_hold_music?: 'none' | 'relaxing_sound' | 'uplifting_beats' | 'ringtone';
|
|
14175
|
+
/**
|
|
14176
|
+
* If set, when transfer is successful, will say the handoff message to both the
|
|
14177
|
+
* transferee and the agent receiving the transfer. Can leave either a static
|
|
14178
|
+
* message or a dynamic one based on prompt. Set to null to disable warm handoff.
|
|
14179
|
+
*/
|
|
14180
|
+
public_handoff_option?: TransferOptionAgenticWarmTransfer.WarmTransferPrompt | TransferOptionAgenticWarmTransfer.WarmTransferStaticMessage;
|
|
14181
|
+
/**
|
|
14182
|
+
* If set to true, will show transferee (the user, not the AI agent) as caller when
|
|
14183
|
+
* transferring, requires the telephony side to support caller id override. Retell
|
|
14184
|
+
* Twilio numbers support this option.
|
|
14185
|
+
*/
|
|
14186
|
+
show_transferee_as_caller?: boolean;
|
|
14187
|
+
}
|
|
14188
|
+
namespace TransferOptionAgenticWarmTransfer {
|
|
14189
|
+
/**
|
|
14190
|
+
* Configuration for agentic warm transfer. Required for agentic warm transfer.
|
|
14191
|
+
*/
|
|
14192
|
+
interface AgenticTransferConfig {
|
|
14193
|
+
/**
|
|
14194
|
+
* The action to take when the transfer agent times out without making a decision.
|
|
14195
|
+
* Defaults to cancel_transfer.
|
|
14196
|
+
*/
|
|
14197
|
+
action_on_timeout?: 'bridge_transfer' | 'cancel_transfer';
|
|
14198
|
+
/**
|
|
14199
|
+
* The agent that will mediate the transfer decision.
|
|
14200
|
+
*/
|
|
14201
|
+
transfer_agent?: AgenticTransferConfig.TransferAgent;
|
|
14202
|
+
/**
|
|
14203
|
+
* The maximum time to wait for the transfer agent to make a decision, in
|
|
14204
|
+
* milliseconds. Defaults to 30000 (30 seconds).
|
|
14205
|
+
*/
|
|
14206
|
+
transfer_timeout_ms?: number;
|
|
14207
|
+
}
|
|
14208
|
+
namespace AgenticTransferConfig {
|
|
14209
|
+
/**
|
|
14210
|
+
* The agent that will mediate the transfer decision.
|
|
14211
|
+
*/
|
|
14212
|
+
interface TransferAgent {
|
|
14213
|
+
/**
|
|
14214
|
+
* The agent ID of the transfer agent. This agent must have isTransferAgent set to
|
|
14215
|
+
* true and should use bridge_transfer and cancel_transfer tools (for Retell LLM)
|
|
14216
|
+
* or BridgeTransferNode and CancelTransferNode (for Conversation Flow).
|
|
14217
|
+
*/
|
|
14218
|
+
agent_id: string;
|
|
14219
|
+
/**
|
|
14220
|
+
* The version of the transfer agent to use.
|
|
14221
|
+
*/
|
|
14222
|
+
agent_version: number;
|
|
14223
|
+
}
|
|
14224
|
+
}
|
|
14225
|
+
interface WarmTransferPrompt {
|
|
14226
|
+
/**
|
|
14227
|
+
* The prompt to be used for warm handoff. Can contain dynamic variables.
|
|
14228
|
+
*/
|
|
14229
|
+
prompt?: string;
|
|
14230
|
+
type?: 'prompt';
|
|
14231
|
+
}
|
|
14232
|
+
interface WarmTransferStaticMessage {
|
|
14233
|
+
/**
|
|
14234
|
+
* The static message to be used for warm handoff. Can contain dynamic variables.
|
|
14235
|
+
*/
|
|
14236
|
+
message?: string;
|
|
14237
|
+
type?: 'static_message';
|
|
14238
|
+
}
|
|
14239
|
+
}
|
|
13743
14240
|
/**
|
|
13744
14241
|
* Position for frontend display
|
|
13745
14242
|
*/
|
|
@@ -13813,7 +14310,7 @@ export declare namespace ConversationFlowUpdateParams {
|
|
|
13813
14310
|
/**
|
|
13814
14311
|
* The LLM model to use
|
|
13815
14312
|
*/
|
|
13816
|
-
model: 'gpt-
|
|
14313
|
+
model: 'gpt-4.1' | 'gpt-4.1-mini' | 'gpt-4.1-nano' | 'gpt-5' | 'gpt-5-mini' | 'gpt-5-nano' | 'claude-4.5-sonnet' | 'claude-4.5-haiku' | 'gemini-2.5-flash' | 'gemini-2.5-flash-lite';
|
|
13817
14314
|
/**
|
|
13818
14315
|
* Type of model choice
|
|
13819
14316
|
*/
|
|
@@ -14005,7 +14502,7 @@ export declare namespace ConversationFlowUpdateParams {
|
|
|
14005
14502
|
/**
|
|
14006
14503
|
* The LLM model to use
|
|
14007
14504
|
*/
|
|
14008
|
-
model: 'gpt-
|
|
14505
|
+
model: 'gpt-4.1' | 'gpt-4.1-mini' | 'gpt-4.1-nano' | 'gpt-5' | 'gpt-5-mini' | 'gpt-5-nano' | 'claude-4.5-sonnet' | 'claude-4.5-haiku' | 'gemini-2.5-flash' | 'gemini-2.5-flash-lite';
|
|
14009
14506
|
/**
|
|
14010
14507
|
* Type of model choice
|
|
14011
14508
|
*/
|
|
@@ -14673,7 +15170,7 @@ export declare namespace ConversationFlowUpdateParams {
|
|
|
14673
15170
|
/**
|
|
14674
15171
|
* The LLM model to use
|
|
14675
15172
|
*/
|
|
14676
|
-
model: 'gpt-
|
|
15173
|
+
model: 'gpt-4.1' | 'gpt-4.1-mini' | 'gpt-4.1-nano' | 'gpt-5' | 'gpt-5-mini' | 'gpt-5-nano' | 'claude-4.5-sonnet' | 'claude-4.5-haiku' | 'gemini-2.5-flash' | 'gemini-2.5-flash-lite';
|
|
14677
15174
|
/**
|
|
14678
15175
|
* Type of model choice
|
|
14679
15176
|
*/
|