retell-sdk 6.2.6 → 6.2.8
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 +20 -0
- package/package.json +1 -1
- package/resources/agent.d.mts +141 -18
- package/resources/agent.d.mts.map +1 -1
- package/resources/agent.d.ts +141 -18
- package/resources/agent.d.ts.map +1 -1
- package/resources/batch-call.d.mts +61 -12
- package/resources/batch-call.d.mts.map +1 -1
- package/resources/batch-call.d.ts +61 -12
- package/resources/batch-call.d.ts.map +1 -1
- package/resources/call.d.mts +185 -37
- package/resources/call.d.mts.map +1 -1
- package/resources/call.d.ts +185 -37
- package/resources/call.d.ts.map +1 -1
- package/resources/call.js +2 -1
- package/resources/call.js.map +1 -1
- package/resources/call.mjs +2 -1
- package/resources/call.mjs.map +1 -1
- package/resources/chat-agent.d.mts +130 -18
- package/resources/chat-agent.d.mts.map +1 -1
- package/resources/chat-agent.d.ts +130 -18
- package/resources/chat-agent.d.ts.map +1 -1
- package/resources/conversation-flow-component.d.mts +492 -42
- package/resources/conversation-flow-component.d.mts.map +1 -1
- package/resources/conversation-flow-component.d.ts +492 -42
- package/resources/conversation-flow-component.d.ts.map +1 -1
- package/resources/conversation-flow.d.mts +1005 -87
- package/resources/conversation-flow.d.mts.map +1 -1
- package/resources/conversation-flow.d.ts +1005 -87
- package/resources/conversation-flow.d.ts.map +1 -1
- package/resources/llm.d.mts +234 -3
- package/resources/llm.d.mts.map +1 -1
- package/resources/llm.d.ts +234 -3
- package/resources/llm.d.ts.map +1 -1
- package/resources/tests.d.mts +3 -3
- package/resources/tests.d.mts.map +1 -1
- package/resources/tests.d.ts +3 -3
- package/resources/tests.d.ts.map +1 -1
- package/src/resources/agent.ts +172 -15
- package/src/resources/batch-call.ts +75 -10
- package/src/resources/call.ts +227 -31
- package/src/resources/chat-agent.ts +159 -15
- package/src/resources/conversation-flow-component.ts +627 -42
- package/src/resources/conversation-flow.ts +1290 -87
- package/src/resources/llm.ts +291 -0
- package/src/resources/tests.ts +6 -3
- package/src/version.ts +1 -1
- package/version.d.mts +1 -1
- package/version.d.ts +1 -1
- package/version.js +1 -1
- package/version.mjs +1 -1
package/resources/call.d.ts
CHANGED
|
@@ -125,7 +125,8 @@ export declare class Call extends APIResource {
|
|
|
125
125
|
/**
|
|
126
126
|
* Take over an in-progress call from the AI agent. The agent stops responding and
|
|
127
127
|
* the specified live-listen participant is allowed to speak directly to the
|
|
128
|
-
* caller. The call must be in ONGOING status.
|
|
128
|
+
* caller. The call must be in ONGOING status. Calls cannot be taken over while a
|
|
129
|
+
* PCI session is active.
|
|
129
130
|
*
|
|
130
131
|
* @example
|
|
131
132
|
* ```ts
|
|
@@ -5649,7 +5650,9 @@ export declare namespace CallCreatePhoneCallParams {
|
|
|
5649
5650
|
interface AgentOverride {
|
|
5650
5651
|
/**
|
|
5651
5652
|
* Override agent configuration settings. Any properties specified here will
|
|
5652
|
-
* override the base agent configuration for this call.
|
|
5653
|
+
* override the base agent configuration for this call. If a Retell LLM or
|
|
5654
|
+
* Conversation Flow response engine is specified without a version, it uses the
|
|
5655
|
+
* latest version.
|
|
5653
5656
|
*/
|
|
5654
5657
|
agent?: AgentOverride.Agent;
|
|
5655
5658
|
/**
|
|
@@ -5662,7 +5665,7 @@ export declare namespace CallCreatePhoneCallParams {
|
|
|
5662
5665
|
/**
|
|
5663
5666
|
* Override Retell LLM configuration settings. Only applicable when using Retell
|
|
5664
5667
|
* LLM as the response engine. Supported attributes - model, s2s_model,
|
|
5665
|
-
* model_temperature, model_high_priority, tool_call_strict_mode,
|
|
5668
|
+
* model_temperature, model_high_priority, model_ultrafast, tool_call_strict_mode,
|
|
5666
5669
|
* knowledge_base_ids, kb_config, start_speaker, begin_after_user_silence_ms,
|
|
5667
5670
|
* begin_message.
|
|
5668
5671
|
*/
|
|
@@ -5671,7 +5674,9 @@ export declare namespace CallCreatePhoneCallParams {
|
|
|
5671
5674
|
namespace AgentOverride {
|
|
5672
5675
|
/**
|
|
5673
5676
|
* Override agent configuration settings. Any properties specified here will
|
|
5674
|
-
* override the base agent configuration for this call.
|
|
5677
|
+
* override the base agent configuration for this call. If a Retell LLM or
|
|
5678
|
+
* Conversation Flow response engine is specified without a version, it uses the
|
|
5679
|
+
* latest version.
|
|
5675
5680
|
*/
|
|
5676
5681
|
interface Agent {
|
|
5677
5682
|
/**
|
|
@@ -5877,12 +5882,9 @@ export declare namespace CallCreatePhoneCallParams {
|
|
|
5877
5882
|
/**
|
|
5878
5883
|
* Specifies what language(s) the agent will operate in. Accepts either a single
|
|
5879
5884
|
* locale (e.g. `en-US`) or an array of locales for multilingual agents (e.g.
|
|
5880
|
-
* `["en-US","es-ES"]`).
|
|
5881
|
-
* as a scalar, and is stored and returned as the ten locales it used to mean. It
|
|
5882
|
-
* must not appear inside the array form. Send an explicit locale array instead. If
|
|
5883
|
-
* unset, defaults to `en-US`.
|
|
5885
|
+
* `["en-US","es-ES"]`). If unset, defaults to `en-US`.
|
|
5884
5886
|
*/
|
|
5885
|
-
language?: 'en-US' | 'en-IN' | 'en-GB' | 'en-AU' | 'en-NZ' | 'de-DE' | 'es-ES' | 'es-419' | 'hi-IN' | 'fr-FR' | 'fr-CA' | 'ja-JP' | 'pt-PT' | 'pt-BR' | 'zh-CN' | 'ru-RU' | 'it-IT' | 'ko-KR' | 'nl-NL' | 'nl-BE' | 'pl-PL' | 'tr-TR' | 'vi-VN' | 'ro-RO' | 'bg-BG' | 'ca-ES' | 'th-TH' | 'da-DK' | 'fi-FI' | 'el-GR' | 'hu-HU' | 'id-ID' | 'no-NO' | 'sk-SK' | 'sv-SE' | 'lt-LT' | 'lv-LV' | 'cs-CZ' | 'ms-MY' | 'af-ZA' | 'ar-SA' | 'az-AZ' | 'bs-BA' | 'cy-GB' | 'fa-IR' | 'fil-PH' | 'gl-ES' | 'he-IL' | 'hr-HR' | 'hy-AM' | 'is-IS' | 'kk-KZ' | 'kn-IN' | 'mk-MK' | 'mr-IN' | 'ne-NP' | 'sl-SI' | 'sr-RS' | 'sw-KE' | 'ta-IN' | 'ur-IN' | 'yue-CN' | 'uk-UA' |
|
|
5887
|
+
language?: 'en-US' | 'en-IN' | 'en-GB' | 'en-AU' | 'en-NZ' | 'de-DE' | 'es-ES' | 'es-419' | 'hi-IN' | 'fr-FR' | 'fr-CA' | 'ja-JP' | 'pt-PT' | 'pt-BR' | 'zh-CN' | 'ru-RU' | 'it-IT' | 'ko-KR' | 'nl-NL' | 'nl-BE' | 'pl-PL' | 'tr-TR' | 'vi-VN' | 'ro-RO' | 'bg-BG' | 'ca-ES' | 'th-TH' | 'da-DK' | 'fi-FI' | 'el-GR' | 'hu-HU' | 'id-ID' | 'no-NO' | 'sk-SK' | 'sv-SE' | 'lt-LT' | 'lv-LV' | 'cs-CZ' | 'ms-MY' | 'af-ZA' | 'ar-SA' | 'az-AZ' | 'bs-BA' | 'cy-GB' | 'fa-IR' | 'fil-PH' | 'gl-ES' | 'he-IL' | 'hr-HR' | 'hy-AM' | 'is-IS' | 'kk-KZ' | 'kn-IN' | 'mk-MK' | 'mr-IN' | 'ne-NP' | 'sl-SI' | 'sr-RS' | 'sw-KE' | 'ta-IN' | 'ur-IN' | 'yue-CN' | 'uk-UA' | Array<'en-US' | 'en-IN' | 'en-GB' | 'en-AU' | 'en-NZ' | 'de-DE' | 'es-ES' | 'es-419' | 'hi-IN' | 'fr-FR' | 'fr-CA' | 'ja-JP' | 'pt-PT' | 'pt-BR' | 'zh-CN' | 'ru-RU' | 'it-IT' | 'ko-KR' | 'nl-NL' | 'nl-BE' | 'pl-PL' | 'tr-TR' | 'vi-VN' | 'ro-RO' | 'bg-BG' | 'ca-ES' | 'th-TH' | 'da-DK' | 'fi-FI' | 'el-GR' | 'hu-HU' | 'id-ID' | 'no-NO' | 'sk-SK' | 'sv-SE' | 'lt-LT' | 'lv-LV' | 'cs-CZ' | 'ms-MY' | 'af-ZA' | 'ar-SA' | 'az-AZ' | 'bs-BA' | 'cy-GB' | 'fa-IR' | 'fil-PH' | 'gl-ES' | 'he-IL' | 'hr-HR' | 'hy-AM' | 'is-IS' | 'kk-KZ' | 'kn-IN' | 'mk-MK' | 'mr-IN' | 'ne-NP' | 'sl-SI' | 'sr-RS' | 'sw-KE' | 'ta-IN' | 'ur-IN' | 'yue-CN' | 'uk-UA'>;
|
|
5886
5888
|
/**
|
|
5887
5889
|
* Maximum allowed length for the call, will force end the call if reached. The
|
|
5888
5890
|
* minimum value allowed is 60,000 ms (1 min), and maximum value allowed is
|
|
@@ -5908,7 +5910,7 @@ export declare namespace CallCreatePhoneCallParams {
|
|
|
5908
5910
|
/**
|
|
5909
5911
|
* The model to use for post call analysis. Default to gpt-5.6-terra.
|
|
5910
5912
|
*/
|
|
5911
|
-
post_call_analysis_model?: 'gpt-4.1' | 'gpt-4.1-mini' | 'gpt-5' | 'gpt-5-mini' | 'gpt-5-nano' | 'gpt-5.1' | 'gpt-5.2' | 'gpt-5.4' | 'gpt-5.4-mini' | 'gpt-5.4-nano' | 'gpt-5.5' | 'gpt-5.6-terra' | 'gpt-5.6-luna' | 'gpt-6-astra' | 'gpt-6-sol' | 'gpt-6.1-sol' | 'gpt-6-luna' | 'claude-4.6-sonnet' | 'claude-5-opus' | 'claude-5.5-opus' | 'claude-5-sonnet' | 'claude-5.5-sonnet' | 'claude-5.5-haiku' | 'claude-4.5-haiku' | 'gemini-3.0-flash' | 'gemini-3.1-flash-lite' | 'gemini-3.5-flash' | 'gemini-3.5-flash-lite' | 'gemini-3.6-flash' | 'gemini-3.7-flash' | 'gemini-3.8-flash' | null;
|
|
5913
|
+
post_call_analysis_model?: 'gpt-4.1' | 'gpt-4.1-mini' | 'gpt-5' | 'gpt-5-mini' | 'gpt-5-nano' | 'gpt-5.1' | 'gpt-5.2' | 'gpt-5.4' | 'gpt-5.4-mini' | 'gpt-5.4-nano' | 'gpt-5.5' | 'gpt-5.6-terra' | 'gpt-5.6-luna' | 'gpt-6-astra' | 'gpt-6-sol' | 'gpt-6.1-sol' | 'gpt-6-luna' | 'claude-4.6-sonnet' | 'claude-5-opus' | 'claude-5.5-opus' | 'claude-5-sonnet' | 'claude-5.5-sonnet' | 'claude-5.5-haiku' | 'claude-4.5-haiku' | 'gemini-3.0-flash' | 'gemini-3.1-flash-lite' | 'gemini-3.5-flash' | 'gemini-3.5-flash-lite' | 'gemini-3.6-flash' | 'gemini-3.7-flash' | 'gemini-3.8-flash' | 'gemini-4-argon' | null;
|
|
5912
5914
|
/**
|
|
5913
5915
|
* Integration (Agent Functions) tools run as a dependency graph during teardown,
|
|
5914
5916
|
* after post-call analysis. Each tool can be gated by a condition. On calls the
|
|
@@ -6802,6 +6804,20 @@ export declare namespace CallCreatePhoneCallParams {
|
|
|
6802
6804
|
* to "prompt".
|
|
6803
6805
|
*/
|
|
6804
6806
|
execution_message_type?: 'prompt' | 'static_text';
|
|
6807
|
+
/**
|
|
6808
|
+
* SMS destination number configuration. If omitted, the message is sent to the
|
|
6809
|
+
* customer number on the call.
|
|
6810
|
+
*/
|
|
6811
|
+
sms_destination?: SendSMSTool.DestinationCustomerNumber | SendSMSTool.DestinationPhoneNumber | unknown;
|
|
6812
|
+
/**
|
|
6813
|
+
* SMS sender number configuration. If omitted, the message is sent from the
|
|
6814
|
+
* agent's phone number.
|
|
6815
|
+
*/
|
|
6816
|
+
sms_sender?: SendSMSTool.SenderCurrentNumber | SendSMSTool.SenderRetellLongCode | unknown;
|
|
6817
|
+
/**
|
|
6818
|
+
* Whether the agent should speak after the SMS tool finishes execution.
|
|
6819
|
+
*/
|
|
6820
|
+
speak_after_execution?: boolean;
|
|
6805
6821
|
/**
|
|
6806
6822
|
* If true, the agent will speak a short line before sending the SMS. If omitted,
|
|
6807
6823
|
* defaults to true (same as end_call / transfer_call tools).
|
|
@@ -6856,6 +6872,27 @@ export declare namespace CallCreatePhoneCallParams {
|
|
|
6856
6872
|
right?: string;
|
|
6857
6873
|
}
|
|
6858
6874
|
}
|
|
6875
|
+
interface DestinationCustomerNumber {
|
|
6876
|
+
type: 'customer_number';
|
|
6877
|
+
}
|
|
6878
|
+
interface DestinationPhoneNumber {
|
|
6879
|
+
/**
|
|
6880
|
+
* Destination phone number in E.164 format.
|
|
6881
|
+
*/
|
|
6882
|
+
phone_number: string;
|
|
6883
|
+
type: 'phone_number';
|
|
6884
|
+
/**
|
|
6885
|
+
* If true, skip E.164 validation for this phone number (same semantics as
|
|
6886
|
+
* transfer_call ignore_e164_validation).
|
|
6887
|
+
*/
|
|
6888
|
+
ignore_e164_validation?: boolean;
|
|
6889
|
+
}
|
|
6890
|
+
interface SenderCurrentNumber {
|
|
6891
|
+
type: 'current_number';
|
|
6892
|
+
}
|
|
6893
|
+
interface SenderRetellLongCode {
|
|
6894
|
+
type: 'retell_long_code';
|
|
6895
|
+
}
|
|
6859
6896
|
}
|
|
6860
6897
|
interface AppTool {
|
|
6861
6898
|
/**
|
|
@@ -7365,7 +7402,7 @@ export declare namespace CallCreatePhoneCallParams {
|
|
|
7365
7402
|
/**
|
|
7366
7403
|
* The LLM model to use
|
|
7367
7404
|
*/
|
|
7368
|
-
model: 'gpt-4.1' | 'gpt-4.1-mini' | 'gpt-5' | 'gpt-5-mini' | 'gpt-5-nano' | 'gpt-5.1' | 'gpt-5.2' | 'gpt-5.4' | 'gpt-5.4-mini' | 'gpt-5.4-nano' | 'gpt-5.5' | 'gpt-5.6-terra' | 'gpt-5.6-luna' | 'gpt-6-astra' | 'gpt-6-sol' | 'gpt-6.1-sol' | 'gpt-6-luna' | 'claude-4.6-sonnet' | 'claude-5-opus' | 'claude-5.5-opus' | 'claude-5-sonnet' | 'claude-5.5-sonnet' | 'claude-5.5-haiku' | 'claude-4.5-haiku' | 'gemini-3.0-flash' | 'gemini-3.1-flash-lite' | 'gemini-3.5-flash' | 'gemini-3.5-flash-lite' | 'gemini-3.6-flash' | 'gemini-3.7-flash' | 'gemini-3.8-flash';
|
|
7405
|
+
model: 'gpt-4.1' | 'gpt-4.1-mini' | 'gpt-5' | 'gpt-5-mini' | 'gpt-5-nano' | 'gpt-5.1' | 'gpt-5.2' | 'gpt-5.4' | 'gpt-5.4-mini' | 'gpt-5.4-nano' | 'gpt-5.5' | 'gpt-5.6-terra' | 'gpt-5.6-luna' | 'gpt-6-astra' | 'gpt-6-sol' | 'gpt-6.1-sol' | 'gpt-6-luna' | 'claude-4.6-sonnet' | 'claude-5-opus' | 'claude-5.5-opus' | 'claude-5-sonnet' | 'claude-5.5-sonnet' | 'claude-5.5-haiku' | 'claude-4.5-haiku' | 'gemini-3.0-flash' | 'gemini-3.1-flash-lite' | 'gemini-3.5-flash' | 'gemini-3.5-flash-lite' | 'gemini-3.6-flash' | 'gemini-3.7-flash' | 'gemini-3.8-flash' | 'gemini-4-argon';
|
|
7369
7406
|
/**
|
|
7370
7407
|
* Type of model choice
|
|
7371
7408
|
*/
|
|
@@ -7374,6 +7411,12 @@ export declare namespace CallCreatePhoneCallParams {
|
|
|
7374
7411
|
* Whether to use high priority pool with more dedicated resource, default false
|
|
7375
7412
|
*/
|
|
7376
7413
|
high_priority?: boolean;
|
|
7414
|
+
/**
|
|
7415
|
+
* Whether to use the ultrafast tier for much faster response generation, default
|
|
7416
|
+
* false. Only supported by gpt-6.1-sol on voice agents; ignored otherwise. Takes
|
|
7417
|
+
* precedence over high_priority.
|
|
7418
|
+
*/
|
|
7419
|
+
ultrafast?: boolean;
|
|
7377
7420
|
}
|
|
7378
7421
|
interface ModelChoiceS2S {
|
|
7379
7422
|
/**
|
|
@@ -7389,7 +7432,7 @@ export declare namespace CallCreatePhoneCallParams {
|
|
|
7389
7432
|
/**
|
|
7390
7433
|
* Override Retell LLM configuration settings. Only applicable when using Retell
|
|
7391
7434
|
* LLM as the response engine. Supported attributes - model, s2s_model,
|
|
7392
|
-
* model_temperature, model_high_priority, tool_call_strict_mode,
|
|
7435
|
+
* model_temperature, model_high_priority, model_ultrafast, tool_call_strict_mode,
|
|
7393
7436
|
* knowledge_base_ids, kb_config, start_speaker, begin_after_user_silence_ms,
|
|
7394
7437
|
* begin_message.
|
|
7395
7438
|
*/
|
|
@@ -7417,7 +7460,7 @@ export declare namespace CallCreatePhoneCallParams {
|
|
|
7417
7460
|
/**
|
|
7418
7461
|
* Select the underlying text LLM. If not set, would default to gpt-5.6-terra.
|
|
7419
7462
|
*/
|
|
7420
|
-
model?: 'gpt-4.1' | 'gpt-4.1-mini' | 'gpt-5' | 'gpt-5-mini' | 'gpt-5-nano' | 'gpt-5.1' | 'gpt-5.2' | 'gpt-5.4' | 'gpt-5.4-mini' | 'gpt-5.4-nano' | 'gpt-5.5' | 'gpt-5.6-terra' | 'gpt-5.6-luna' | 'gpt-6-astra' | 'gpt-6-sol' | 'gpt-6.1-sol' | 'gpt-6-luna' | 'claude-4.6-sonnet' | 'claude-5-opus' | 'claude-5.5-opus' | 'claude-5-sonnet' | 'claude-5.5-sonnet' | 'claude-5.5-haiku' | 'claude-4.5-haiku' | 'gemini-3.0-flash' | 'gemini-3.1-flash-lite' | 'gemini-3.5-flash' | 'gemini-3.5-flash-lite' | 'gemini-3.6-flash' | 'gemini-3.7-flash' | 'gemini-3.8-flash' | null;
|
|
7463
|
+
model?: 'gpt-4.1' | 'gpt-4.1-mini' | 'gpt-5' | 'gpt-5-mini' | 'gpt-5-nano' | 'gpt-5.1' | 'gpt-5.2' | 'gpt-5.4' | 'gpt-5.4-mini' | 'gpt-5.4-nano' | 'gpt-5.5' | 'gpt-5.6-terra' | 'gpt-5.6-luna' | 'gpt-6-astra' | 'gpt-6-sol' | 'gpt-6.1-sol' | 'gpt-6-luna' | 'claude-4.6-sonnet' | 'claude-5-opus' | 'claude-5.5-opus' | 'claude-5-sonnet' | 'claude-5.5-sonnet' | 'claude-5.5-haiku' | 'claude-4.5-haiku' | 'gemini-3.0-flash' | 'gemini-3.1-flash-lite' | 'gemini-3.5-flash' | 'gemini-3.5-flash-lite' | 'gemini-3.6-flash' | 'gemini-3.7-flash' | 'gemini-3.8-flash' | 'gemini-4-argon' | null;
|
|
7421
7464
|
/**
|
|
7422
7465
|
* If set to true, will use high priority pool with more dedicated resource to
|
|
7423
7466
|
* ensure lower and more consistent latency, default to false. This feature usually
|
|
@@ -7431,6 +7474,13 @@ export declare namespace CallCreatePhoneCallParams {
|
|
|
7431
7474
|
* recommended.
|
|
7432
7475
|
*/
|
|
7433
7476
|
model_temperature?: number;
|
|
7477
|
+
/**
|
|
7478
|
+
* If set to true, will use the ultrafast tier for much faster response generation,
|
|
7479
|
+
* default to false. Only supported by gpt-6.1-sol on voice agents; ignored
|
|
7480
|
+
* otherwise. Takes precedence over model_high_priority. This feature comes with a
|
|
7481
|
+
* higher cost.
|
|
7482
|
+
*/
|
|
7483
|
+
model_ultrafast?: boolean | null;
|
|
7434
7484
|
/**
|
|
7435
7485
|
* Select the underlying speech to speech model. Can only set this or model, not
|
|
7436
7486
|
* both.
|
|
@@ -7516,7 +7566,9 @@ export declare namespace CallCreateWebCallParams {
|
|
|
7516
7566
|
interface AgentOverride {
|
|
7517
7567
|
/**
|
|
7518
7568
|
* Override agent configuration settings. Any properties specified here will
|
|
7519
|
-
* override the base agent configuration for this call.
|
|
7569
|
+
* override the base agent configuration for this call. If a Retell LLM or
|
|
7570
|
+
* Conversation Flow response engine is specified without a version, it uses the
|
|
7571
|
+
* latest version.
|
|
7520
7572
|
*/
|
|
7521
7573
|
agent?: AgentOverride.Agent;
|
|
7522
7574
|
/**
|
|
@@ -7529,7 +7581,7 @@ export declare namespace CallCreateWebCallParams {
|
|
|
7529
7581
|
/**
|
|
7530
7582
|
* Override Retell LLM configuration settings. Only applicable when using Retell
|
|
7531
7583
|
* LLM as the response engine. Supported attributes - model, s2s_model,
|
|
7532
|
-
* model_temperature, model_high_priority, tool_call_strict_mode,
|
|
7584
|
+
* model_temperature, model_high_priority, model_ultrafast, tool_call_strict_mode,
|
|
7533
7585
|
* knowledge_base_ids, kb_config, start_speaker, begin_after_user_silence_ms,
|
|
7534
7586
|
* begin_message.
|
|
7535
7587
|
*/
|
|
@@ -7538,7 +7590,9 @@ export declare namespace CallCreateWebCallParams {
|
|
|
7538
7590
|
namespace AgentOverride {
|
|
7539
7591
|
/**
|
|
7540
7592
|
* Override agent configuration settings. Any properties specified here will
|
|
7541
|
-
* override the base agent configuration for this call.
|
|
7593
|
+
* override the base agent configuration for this call. If a Retell LLM or
|
|
7594
|
+
* Conversation Flow response engine is specified without a version, it uses the
|
|
7595
|
+
* latest version.
|
|
7542
7596
|
*/
|
|
7543
7597
|
interface Agent {
|
|
7544
7598
|
/**
|
|
@@ -7744,12 +7798,9 @@ export declare namespace CallCreateWebCallParams {
|
|
|
7744
7798
|
/**
|
|
7745
7799
|
* Specifies what language(s) the agent will operate in. Accepts either a single
|
|
7746
7800
|
* locale (e.g. `en-US`) or an array of locales for multilingual agents (e.g.
|
|
7747
|
-
* `["en-US","es-ES"]`).
|
|
7748
|
-
* as a scalar, and is stored and returned as the ten locales it used to mean. It
|
|
7749
|
-
* must not appear inside the array form. Send an explicit locale array instead. If
|
|
7750
|
-
* unset, defaults to `en-US`.
|
|
7801
|
+
* `["en-US","es-ES"]`). If unset, defaults to `en-US`.
|
|
7751
7802
|
*/
|
|
7752
|
-
language?: 'en-US' | 'en-IN' | 'en-GB' | 'en-AU' | 'en-NZ' | 'de-DE' | 'es-ES' | 'es-419' | 'hi-IN' | 'fr-FR' | 'fr-CA' | 'ja-JP' | 'pt-PT' | 'pt-BR' | 'zh-CN' | 'ru-RU' | 'it-IT' | 'ko-KR' | 'nl-NL' | 'nl-BE' | 'pl-PL' | 'tr-TR' | 'vi-VN' | 'ro-RO' | 'bg-BG' | 'ca-ES' | 'th-TH' | 'da-DK' | 'fi-FI' | 'el-GR' | 'hu-HU' | 'id-ID' | 'no-NO' | 'sk-SK' | 'sv-SE' | 'lt-LT' | 'lv-LV' | 'cs-CZ' | 'ms-MY' | 'af-ZA' | 'ar-SA' | 'az-AZ' | 'bs-BA' | 'cy-GB' | 'fa-IR' | 'fil-PH' | 'gl-ES' | 'he-IL' | 'hr-HR' | 'hy-AM' | 'is-IS' | 'kk-KZ' | 'kn-IN' | 'mk-MK' | 'mr-IN' | 'ne-NP' | 'sl-SI' | 'sr-RS' | 'sw-KE' | 'ta-IN' | 'ur-IN' | 'yue-CN' | 'uk-UA' |
|
|
7803
|
+
language?: 'en-US' | 'en-IN' | 'en-GB' | 'en-AU' | 'en-NZ' | 'de-DE' | 'es-ES' | 'es-419' | 'hi-IN' | 'fr-FR' | 'fr-CA' | 'ja-JP' | 'pt-PT' | 'pt-BR' | 'zh-CN' | 'ru-RU' | 'it-IT' | 'ko-KR' | 'nl-NL' | 'nl-BE' | 'pl-PL' | 'tr-TR' | 'vi-VN' | 'ro-RO' | 'bg-BG' | 'ca-ES' | 'th-TH' | 'da-DK' | 'fi-FI' | 'el-GR' | 'hu-HU' | 'id-ID' | 'no-NO' | 'sk-SK' | 'sv-SE' | 'lt-LT' | 'lv-LV' | 'cs-CZ' | 'ms-MY' | 'af-ZA' | 'ar-SA' | 'az-AZ' | 'bs-BA' | 'cy-GB' | 'fa-IR' | 'fil-PH' | 'gl-ES' | 'he-IL' | 'hr-HR' | 'hy-AM' | 'is-IS' | 'kk-KZ' | 'kn-IN' | 'mk-MK' | 'mr-IN' | 'ne-NP' | 'sl-SI' | 'sr-RS' | 'sw-KE' | 'ta-IN' | 'ur-IN' | 'yue-CN' | 'uk-UA' | Array<'en-US' | 'en-IN' | 'en-GB' | 'en-AU' | 'en-NZ' | 'de-DE' | 'es-ES' | 'es-419' | 'hi-IN' | 'fr-FR' | 'fr-CA' | 'ja-JP' | 'pt-PT' | 'pt-BR' | 'zh-CN' | 'ru-RU' | 'it-IT' | 'ko-KR' | 'nl-NL' | 'nl-BE' | 'pl-PL' | 'tr-TR' | 'vi-VN' | 'ro-RO' | 'bg-BG' | 'ca-ES' | 'th-TH' | 'da-DK' | 'fi-FI' | 'el-GR' | 'hu-HU' | 'id-ID' | 'no-NO' | 'sk-SK' | 'sv-SE' | 'lt-LT' | 'lv-LV' | 'cs-CZ' | 'ms-MY' | 'af-ZA' | 'ar-SA' | 'az-AZ' | 'bs-BA' | 'cy-GB' | 'fa-IR' | 'fil-PH' | 'gl-ES' | 'he-IL' | 'hr-HR' | 'hy-AM' | 'is-IS' | 'kk-KZ' | 'kn-IN' | 'mk-MK' | 'mr-IN' | 'ne-NP' | 'sl-SI' | 'sr-RS' | 'sw-KE' | 'ta-IN' | 'ur-IN' | 'yue-CN' | 'uk-UA'>;
|
|
7753
7804
|
/**
|
|
7754
7805
|
* Maximum allowed length for the call, will force end the call if reached. The
|
|
7755
7806
|
* minimum value allowed is 60,000 ms (1 min), and maximum value allowed is
|
|
@@ -7775,7 +7826,7 @@ export declare namespace CallCreateWebCallParams {
|
|
|
7775
7826
|
/**
|
|
7776
7827
|
* The model to use for post call analysis. Default to gpt-5.6-terra.
|
|
7777
7828
|
*/
|
|
7778
|
-
post_call_analysis_model?: 'gpt-4.1' | 'gpt-4.1-mini' | 'gpt-5' | 'gpt-5-mini' | 'gpt-5-nano' | 'gpt-5.1' | 'gpt-5.2' | 'gpt-5.4' | 'gpt-5.4-mini' | 'gpt-5.4-nano' | 'gpt-5.5' | 'gpt-5.6-terra' | 'gpt-5.6-luna' | 'gpt-6-astra' | 'gpt-6-sol' | 'gpt-6.1-sol' | 'gpt-6-luna' | 'claude-4.6-sonnet' | 'claude-5-opus' | 'claude-5.5-opus' | 'claude-5-sonnet' | 'claude-5.5-sonnet' | 'claude-5.5-haiku' | 'claude-4.5-haiku' | 'gemini-3.0-flash' | 'gemini-3.1-flash-lite' | 'gemini-3.5-flash' | 'gemini-3.5-flash-lite' | 'gemini-3.6-flash' | 'gemini-3.7-flash' | 'gemini-3.8-flash' | null;
|
|
7829
|
+
post_call_analysis_model?: 'gpt-4.1' | 'gpt-4.1-mini' | 'gpt-5' | 'gpt-5-mini' | 'gpt-5-nano' | 'gpt-5.1' | 'gpt-5.2' | 'gpt-5.4' | 'gpt-5.4-mini' | 'gpt-5.4-nano' | 'gpt-5.5' | 'gpt-5.6-terra' | 'gpt-5.6-luna' | 'gpt-6-astra' | 'gpt-6-sol' | 'gpt-6.1-sol' | 'gpt-6-luna' | 'claude-4.6-sonnet' | 'claude-5-opus' | 'claude-5.5-opus' | 'claude-5-sonnet' | 'claude-5.5-sonnet' | 'claude-5.5-haiku' | 'claude-4.5-haiku' | 'gemini-3.0-flash' | 'gemini-3.1-flash-lite' | 'gemini-3.5-flash' | 'gemini-3.5-flash-lite' | 'gemini-3.6-flash' | 'gemini-3.7-flash' | 'gemini-3.8-flash' | 'gemini-4-argon' | null;
|
|
7779
7830
|
/**
|
|
7780
7831
|
* Integration (Agent Functions) tools run as a dependency graph during teardown,
|
|
7781
7832
|
* after post-call analysis. Each tool can be gated by a condition. On calls the
|
|
@@ -8669,6 +8720,20 @@ export declare namespace CallCreateWebCallParams {
|
|
|
8669
8720
|
* to "prompt".
|
|
8670
8721
|
*/
|
|
8671
8722
|
execution_message_type?: 'prompt' | 'static_text';
|
|
8723
|
+
/**
|
|
8724
|
+
* SMS destination number configuration. If omitted, the message is sent to the
|
|
8725
|
+
* customer number on the call.
|
|
8726
|
+
*/
|
|
8727
|
+
sms_destination?: SendSMSTool.DestinationCustomerNumber | SendSMSTool.DestinationPhoneNumber | unknown;
|
|
8728
|
+
/**
|
|
8729
|
+
* SMS sender number configuration. If omitted, the message is sent from the
|
|
8730
|
+
* agent's phone number.
|
|
8731
|
+
*/
|
|
8732
|
+
sms_sender?: SendSMSTool.SenderCurrentNumber | SendSMSTool.SenderRetellLongCode | unknown;
|
|
8733
|
+
/**
|
|
8734
|
+
* Whether the agent should speak after the SMS tool finishes execution.
|
|
8735
|
+
*/
|
|
8736
|
+
speak_after_execution?: boolean;
|
|
8672
8737
|
/**
|
|
8673
8738
|
* If true, the agent will speak a short line before sending the SMS. If omitted,
|
|
8674
8739
|
* defaults to true (same as end_call / transfer_call tools).
|
|
@@ -8723,6 +8788,27 @@ export declare namespace CallCreateWebCallParams {
|
|
|
8723
8788
|
right?: string;
|
|
8724
8789
|
}
|
|
8725
8790
|
}
|
|
8791
|
+
interface DestinationCustomerNumber {
|
|
8792
|
+
type: 'customer_number';
|
|
8793
|
+
}
|
|
8794
|
+
interface DestinationPhoneNumber {
|
|
8795
|
+
/**
|
|
8796
|
+
* Destination phone number in E.164 format.
|
|
8797
|
+
*/
|
|
8798
|
+
phone_number: string;
|
|
8799
|
+
type: 'phone_number';
|
|
8800
|
+
/**
|
|
8801
|
+
* If true, skip E.164 validation for this phone number (same semantics as
|
|
8802
|
+
* transfer_call ignore_e164_validation).
|
|
8803
|
+
*/
|
|
8804
|
+
ignore_e164_validation?: boolean;
|
|
8805
|
+
}
|
|
8806
|
+
interface SenderCurrentNumber {
|
|
8807
|
+
type: 'current_number';
|
|
8808
|
+
}
|
|
8809
|
+
interface SenderRetellLongCode {
|
|
8810
|
+
type: 'retell_long_code';
|
|
8811
|
+
}
|
|
8726
8812
|
}
|
|
8727
8813
|
interface AppTool {
|
|
8728
8814
|
/**
|
|
@@ -9232,7 +9318,7 @@ export declare namespace CallCreateWebCallParams {
|
|
|
9232
9318
|
/**
|
|
9233
9319
|
* The LLM model to use
|
|
9234
9320
|
*/
|
|
9235
|
-
model: 'gpt-4.1' | 'gpt-4.1-mini' | 'gpt-5' | 'gpt-5-mini' | 'gpt-5-nano' | 'gpt-5.1' | 'gpt-5.2' | 'gpt-5.4' | 'gpt-5.4-mini' | 'gpt-5.4-nano' | 'gpt-5.5' | 'gpt-5.6-terra' | 'gpt-5.6-luna' | 'gpt-6-astra' | 'gpt-6-sol' | 'gpt-6.1-sol' | 'gpt-6-luna' | 'claude-4.6-sonnet' | 'claude-5-opus' | 'claude-5.5-opus' | 'claude-5-sonnet' | 'claude-5.5-sonnet' | 'claude-5.5-haiku' | 'claude-4.5-haiku' | 'gemini-3.0-flash' | 'gemini-3.1-flash-lite' | 'gemini-3.5-flash' | 'gemini-3.5-flash-lite' | 'gemini-3.6-flash' | 'gemini-3.7-flash' | 'gemini-3.8-flash';
|
|
9321
|
+
model: 'gpt-4.1' | 'gpt-4.1-mini' | 'gpt-5' | 'gpt-5-mini' | 'gpt-5-nano' | 'gpt-5.1' | 'gpt-5.2' | 'gpt-5.4' | 'gpt-5.4-mini' | 'gpt-5.4-nano' | 'gpt-5.5' | 'gpt-5.6-terra' | 'gpt-5.6-luna' | 'gpt-6-astra' | 'gpt-6-sol' | 'gpt-6.1-sol' | 'gpt-6-luna' | 'claude-4.6-sonnet' | 'claude-5-opus' | 'claude-5.5-opus' | 'claude-5-sonnet' | 'claude-5.5-sonnet' | 'claude-5.5-haiku' | 'claude-4.5-haiku' | 'gemini-3.0-flash' | 'gemini-3.1-flash-lite' | 'gemini-3.5-flash' | 'gemini-3.5-flash-lite' | 'gemini-3.6-flash' | 'gemini-3.7-flash' | 'gemini-3.8-flash' | 'gemini-4-argon';
|
|
9236
9322
|
/**
|
|
9237
9323
|
* Type of model choice
|
|
9238
9324
|
*/
|
|
@@ -9241,6 +9327,12 @@ export declare namespace CallCreateWebCallParams {
|
|
|
9241
9327
|
* Whether to use high priority pool with more dedicated resource, default false
|
|
9242
9328
|
*/
|
|
9243
9329
|
high_priority?: boolean;
|
|
9330
|
+
/**
|
|
9331
|
+
* Whether to use the ultrafast tier for much faster response generation, default
|
|
9332
|
+
* false. Only supported by gpt-6.1-sol on voice agents; ignored otherwise. Takes
|
|
9333
|
+
* precedence over high_priority.
|
|
9334
|
+
*/
|
|
9335
|
+
ultrafast?: boolean;
|
|
9244
9336
|
}
|
|
9245
9337
|
interface ModelChoiceS2S {
|
|
9246
9338
|
/**
|
|
@@ -9256,7 +9348,7 @@ export declare namespace CallCreateWebCallParams {
|
|
|
9256
9348
|
/**
|
|
9257
9349
|
* Override Retell LLM configuration settings. Only applicable when using Retell
|
|
9258
9350
|
* LLM as the response engine. Supported attributes - model, s2s_model,
|
|
9259
|
-
* model_temperature, model_high_priority, tool_call_strict_mode,
|
|
9351
|
+
* model_temperature, model_high_priority, model_ultrafast, tool_call_strict_mode,
|
|
9260
9352
|
* knowledge_base_ids, kb_config, start_speaker, begin_after_user_silence_ms,
|
|
9261
9353
|
* begin_message.
|
|
9262
9354
|
*/
|
|
@@ -9284,7 +9376,7 @@ export declare namespace CallCreateWebCallParams {
|
|
|
9284
9376
|
/**
|
|
9285
9377
|
* Select the underlying text LLM. If not set, would default to gpt-5.6-terra.
|
|
9286
9378
|
*/
|
|
9287
|
-
model?: 'gpt-4.1' | 'gpt-4.1-mini' | 'gpt-5' | 'gpt-5-mini' | 'gpt-5-nano' | 'gpt-5.1' | 'gpt-5.2' | 'gpt-5.4' | 'gpt-5.4-mini' | 'gpt-5.4-nano' | 'gpt-5.5' | 'gpt-5.6-terra' | 'gpt-5.6-luna' | 'gpt-6-astra' | 'gpt-6-sol' | 'gpt-6.1-sol' | 'gpt-6-luna' | 'claude-4.6-sonnet' | 'claude-5-opus' | 'claude-5.5-opus' | 'claude-5-sonnet' | 'claude-5.5-sonnet' | 'claude-5.5-haiku' | 'claude-4.5-haiku' | 'gemini-3.0-flash' | 'gemini-3.1-flash-lite' | 'gemini-3.5-flash' | 'gemini-3.5-flash-lite' | 'gemini-3.6-flash' | 'gemini-3.7-flash' | 'gemini-3.8-flash' | null;
|
|
9379
|
+
model?: 'gpt-4.1' | 'gpt-4.1-mini' | 'gpt-5' | 'gpt-5-mini' | 'gpt-5-nano' | 'gpt-5.1' | 'gpt-5.2' | 'gpt-5.4' | 'gpt-5.4-mini' | 'gpt-5.4-nano' | 'gpt-5.5' | 'gpt-5.6-terra' | 'gpt-5.6-luna' | 'gpt-6-astra' | 'gpt-6-sol' | 'gpt-6.1-sol' | 'gpt-6-luna' | 'claude-4.6-sonnet' | 'claude-5-opus' | 'claude-5.5-opus' | 'claude-5-sonnet' | 'claude-5.5-sonnet' | 'claude-5.5-haiku' | 'claude-4.5-haiku' | 'gemini-3.0-flash' | 'gemini-3.1-flash-lite' | 'gemini-3.5-flash' | 'gemini-3.5-flash-lite' | 'gemini-3.6-flash' | 'gemini-3.7-flash' | 'gemini-3.8-flash' | 'gemini-4-argon' | null;
|
|
9288
9380
|
/**
|
|
9289
9381
|
* If set to true, will use high priority pool with more dedicated resource to
|
|
9290
9382
|
* ensure lower and more consistent latency, default to false. This feature usually
|
|
@@ -9298,6 +9390,13 @@ export declare namespace CallCreateWebCallParams {
|
|
|
9298
9390
|
* recommended.
|
|
9299
9391
|
*/
|
|
9300
9392
|
model_temperature?: number;
|
|
9393
|
+
/**
|
|
9394
|
+
* If set to true, will use the ultrafast tier for much faster response generation,
|
|
9395
|
+
* default to false. Only supported by gpt-6.1-sol on voice agents; ignored
|
|
9396
|
+
* otherwise. Takes precedence over model_high_priority. This feature comes with a
|
|
9397
|
+
* higher cost.
|
|
9398
|
+
*/
|
|
9399
|
+
model_ultrafast?: boolean | null;
|
|
9301
9400
|
/**
|
|
9302
9401
|
* Select the underlying speech to speech model. Can only set this or model, not
|
|
9303
9402
|
* both.
|
|
@@ -9382,7 +9481,9 @@ export declare namespace CallRegisterPhoneCallParams {
|
|
|
9382
9481
|
interface AgentOverride {
|
|
9383
9482
|
/**
|
|
9384
9483
|
* Override agent configuration settings. Any properties specified here will
|
|
9385
|
-
* override the base agent configuration for this call.
|
|
9484
|
+
* override the base agent configuration for this call. If a Retell LLM or
|
|
9485
|
+
* Conversation Flow response engine is specified without a version, it uses the
|
|
9486
|
+
* latest version.
|
|
9386
9487
|
*/
|
|
9387
9488
|
agent?: AgentOverride.Agent;
|
|
9388
9489
|
/**
|
|
@@ -9395,7 +9496,7 @@ export declare namespace CallRegisterPhoneCallParams {
|
|
|
9395
9496
|
/**
|
|
9396
9497
|
* Override Retell LLM configuration settings. Only applicable when using Retell
|
|
9397
9498
|
* LLM as the response engine. Supported attributes - model, s2s_model,
|
|
9398
|
-
* model_temperature, model_high_priority, tool_call_strict_mode,
|
|
9499
|
+
* model_temperature, model_high_priority, model_ultrafast, tool_call_strict_mode,
|
|
9399
9500
|
* knowledge_base_ids, kb_config, start_speaker, begin_after_user_silence_ms,
|
|
9400
9501
|
* begin_message.
|
|
9401
9502
|
*/
|
|
@@ -9404,7 +9505,9 @@ export declare namespace CallRegisterPhoneCallParams {
|
|
|
9404
9505
|
namespace AgentOverride {
|
|
9405
9506
|
/**
|
|
9406
9507
|
* Override agent configuration settings. Any properties specified here will
|
|
9407
|
-
* override the base agent configuration for this call.
|
|
9508
|
+
* override the base agent configuration for this call. If a Retell LLM or
|
|
9509
|
+
* Conversation Flow response engine is specified without a version, it uses the
|
|
9510
|
+
* latest version.
|
|
9408
9511
|
*/
|
|
9409
9512
|
interface Agent {
|
|
9410
9513
|
/**
|
|
@@ -9610,12 +9713,9 @@ export declare namespace CallRegisterPhoneCallParams {
|
|
|
9610
9713
|
/**
|
|
9611
9714
|
* Specifies what language(s) the agent will operate in. Accepts either a single
|
|
9612
9715
|
* locale (e.g. `en-US`) or an array of locales for multilingual agents (e.g.
|
|
9613
|
-
* `["en-US","es-ES"]`).
|
|
9614
|
-
* as a scalar, and is stored and returned as the ten locales it used to mean. It
|
|
9615
|
-
* must not appear inside the array form. Send an explicit locale array instead. If
|
|
9616
|
-
* unset, defaults to `en-US`.
|
|
9716
|
+
* `["en-US","es-ES"]`). If unset, defaults to `en-US`.
|
|
9617
9717
|
*/
|
|
9618
|
-
language?: 'en-US' | 'en-IN' | 'en-GB' | 'en-AU' | 'en-NZ' | 'de-DE' | 'es-ES' | 'es-419' | 'hi-IN' | 'fr-FR' | 'fr-CA' | 'ja-JP' | 'pt-PT' | 'pt-BR' | 'zh-CN' | 'ru-RU' | 'it-IT' | 'ko-KR' | 'nl-NL' | 'nl-BE' | 'pl-PL' | 'tr-TR' | 'vi-VN' | 'ro-RO' | 'bg-BG' | 'ca-ES' | 'th-TH' | 'da-DK' | 'fi-FI' | 'el-GR' | 'hu-HU' | 'id-ID' | 'no-NO' | 'sk-SK' | 'sv-SE' | 'lt-LT' | 'lv-LV' | 'cs-CZ' | 'ms-MY' | 'af-ZA' | 'ar-SA' | 'az-AZ' | 'bs-BA' | 'cy-GB' | 'fa-IR' | 'fil-PH' | 'gl-ES' | 'he-IL' | 'hr-HR' | 'hy-AM' | 'is-IS' | 'kk-KZ' | 'kn-IN' | 'mk-MK' | 'mr-IN' | 'ne-NP' | 'sl-SI' | 'sr-RS' | 'sw-KE' | 'ta-IN' | 'ur-IN' | 'yue-CN' | 'uk-UA' |
|
|
9718
|
+
language?: 'en-US' | 'en-IN' | 'en-GB' | 'en-AU' | 'en-NZ' | 'de-DE' | 'es-ES' | 'es-419' | 'hi-IN' | 'fr-FR' | 'fr-CA' | 'ja-JP' | 'pt-PT' | 'pt-BR' | 'zh-CN' | 'ru-RU' | 'it-IT' | 'ko-KR' | 'nl-NL' | 'nl-BE' | 'pl-PL' | 'tr-TR' | 'vi-VN' | 'ro-RO' | 'bg-BG' | 'ca-ES' | 'th-TH' | 'da-DK' | 'fi-FI' | 'el-GR' | 'hu-HU' | 'id-ID' | 'no-NO' | 'sk-SK' | 'sv-SE' | 'lt-LT' | 'lv-LV' | 'cs-CZ' | 'ms-MY' | 'af-ZA' | 'ar-SA' | 'az-AZ' | 'bs-BA' | 'cy-GB' | 'fa-IR' | 'fil-PH' | 'gl-ES' | 'he-IL' | 'hr-HR' | 'hy-AM' | 'is-IS' | 'kk-KZ' | 'kn-IN' | 'mk-MK' | 'mr-IN' | 'ne-NP' | 'sl-SI' | 'sr-RS' | 'sw-KE' | 'ta-IN' | 'ur-IN' | 'yue-CN' | 'uk-UA' | Array<'en-US' | 'en-IN' | 'en-GB' | 'en-AU' | 'en-NZ' | 'de-DE' | 'es-ES' | 'es-419' | 'hi-IN' | 'fr-FR' | 'fr-CA' | 'ja-JP' | 'pt-PT' | 'pt-BR' | 'zh-CN' | 'ru-RU' | 'it-IT' | 'ko-KR' | 'nl-NL' | 'nl-BE' | 'pl-PL' | 'tr-TR' | 'vi-VN' | 'ro-RO' | 'bg-BG' | 'ca-ES' | 'th-TH' | 'da-DK' | 'fi-FI' | 'el-GR' | 'hu-HU' | 'id-ID' | 'no-NO' | 'sk-SK' | 'sv-SE' | 'lt-LT' | 'lv-LV' | 'cs-CZ' | 'ms-MY' | 'af-ZA' | 'ar-SA' | 'az-AZ' | 'bs-BA' | 'cy-GB' | 'fa-IR' | 'fil-PH' | 'gl-ES' | 'he-IL' | 'hr-HR' | 'hy-AM' | 'is-IS' | 'kk-KZ' | 'kn-IN' | 'mk-MK' | 'mr-IN' | 'ne-NP' | 'sl-SI' | 'sr-RS' | 'sw-KE' | 'ta-IN' | 'ur-IN' | 'yue-CN' | 'uk-UA'>;
|
|
9619
9719
|
/**
|
|
9620
9720
|
* Maximum allowed length for the call, will force end the call if reached. The
|
|
9621
9721
|
* minimum value allowed is 60,000 ms (1 min), and maximum value allowed is
|
|
@@ -9641,7 +9741,7 @@ export declare namespace CallRegisterPhoneCallParams {
|
|
|
9641
9741
|
/**
|
|
9642
9742
|
* The model to use for post call analysis. Default to gpt-5.6-terra.
|
|
9643
9743
|
*/
|
|
9644
|
-
post_call_analysis_model?: 'gpt-4.1' | 'gpt-4.1-mini' | 'gpt-5' | 'gpt-5-mini' | 'gpt-5-nano' | 'gpt-5.1' | 'gpt-5.2' | 'gpt-5.4' | 'gpt-5.4-mini' | 'gpt-5.4-nano' | 'gpt-5.5' | 'gpt-5.6-terra' | 'gpt-5.6-luna' | 'gpt-6-astra' | 'gpt-6-sol' | 'gpt-6.1-sol' | 'gpt-6-luna' | 'claude-4.6-sonnet' | 'claude-5-opus' | 'claude-5.5-opus' | 'claude-5-sonnet' | 'claude-5.5-sonnet' | 'claude-5.5-haiku' | 'claude-4.5-haiku' | 'gemini-3.0-flash' | 'gemini-3.1-flash-lite' | 'gemini-3.5-flash' | 'gemini-3.5-flash-lite' | 'gemini-3.6-flash' | 'gemini-3.7-flash' | 'gemini-3.8-flash' | null;
|
|
9744
|
+
post_call_analysis_model?: 'gpt-4.1' | 'gpt-4.1-mini' | 'gpt-5' | 'gpt-5-mini' | 'gpt-5-nano' | 'gpt-5.1' | 'gpt-5.2' | 'gpt-5.4' | 'gpt-5.4-mini' | 'gpt-5.4-nano' | 'gpt-5.5' | 'gpt-5.6-terra' | 'gpt-5.6-luna' | 'gpt-6-astra' | 'gpt-6-sol' | 'gpt-6.1-sol' | 'gpt-6-luna' | 'claude-4.6-sonnet' | 'claude-5-opus' | 'claude-5.5-opus' | 'claude-5-sonnet' | 'claude-5.5-sonnet' | 'claude-5.5-haiku' | 'claude-4.5-haiku' | 'gemini-3.0-flash' | 'gemini-3.1-flash-lite' | 'gemini-3.5-flash' | 'gemini-3.5-flash-lite' | 'gemini-3.6-flash' | 'gemini-3.7-flash' | 'gemini-3.8-flash' | 'gemini-4-argon' | null;
|
|
9645
9745
|
/**
|
|
9646
9746
|
* Integration (Agent Functions) tools run as a dependency graph during teardown,
|
|
9647
9747
|
* after post-call analysis. Each tool can be gated by a condition. On calls the
|
|
@@ -10535,6 +10635,20 @@ export declare namespace CallRegisterPhoneCallParams {
|
|
|
10535
10635
|
* to "prompt".
|
|
10536
10636
|
*/
|
|
10537
10637
|
execution_message_type?: 'prompt' | 'static_text';
|
|
10638
|
+
/**
|
|
10639
|
+
* SMS destination number configuration. If omitted, the message is sent to the
|
|
10640
|
+
* customer number on the call.
|
|
10641
|
+
*/
|
|
10642
|
+
sms_destination?: SendSMSTool.DestinationCustomerNumber | SendSMSTool.DestinationPhoneNumber | unknown;
|
|
10643
|
+
/**
|
|
10644
|
+
* SMS sender number configuration. If omitted, the message is sent from the
|
|
10645
|
+
* agent's phone number.
|
|
10646
|
+
*/
|
|
10647
|
+
sms_sender?: SendSMSTool.SenderCurrentNumber | SendSMSTool.SenderRetellLongCode | unknown;
|
|
10648
|
+
/**
|
|
10649
|
+
* Whether the agent should speak after the SMS tool finishes execution.
|
|
10650
|
+
*/
|
|
10651
|
+
speak_after_execution?: boolean;
|
|
10538
10652
|
/**
|
|
10539
10653
|
* If true, the agent will speak a short line before sending the SMS. If omitted,
|
|
10540
10654
|
* defaults to true (same as end_call / transfer_call tools).
|
|
@@ -10589,6 +10703,27 @@ export declare namespace CallRegisterPhoneCallParams {
|
|
|
10589
10703
|
right?: string;
|
|
10590
10704
|
}
|
|
10591
10705
|
}
|
|
10706
|
+
interface DestinationCustomerNumber {
|
|
10707
|
+
type: 'customer_number';
|
|
10708
|
+
}
|
|
10709
|
+
interface DestinationPhoneNumber {
|
|
10710
|
+
/**
|
|
10711
|
+
* Destination phone number in E.164 format.
|
|
10712
|
+
*/
|
|
10713
|
+
phone_number: string;
|
|
10714
|
+
type: 'phone_number';
|
|
10715
|
+
/**
|
|
10716
|
+
* If true, skip E.164 validation for this phone number (same semantics as
|
|
10717
|
+
* transfer_call ignore_e164_validation).
|
|
10718
|
+
*/
|
|
10719
|
+
ignore_e164_validation?: boolean;
|
|
10720
|
+
}
|
|
10721
|
+
interface SenderCurrentNumber {
|
|
10722
|
+
type: 'current_number';
|
|
10723
|
+
}
|
|
10724
|
+
interface SenderRetellLongCode {
|
|
10725
|
+
type: 'retell_long_code';
|
|
10726
|
+
}
|
|
10592
10727
|
}
|
|
10593
10728
|
interface AppTool {
|
|
10594
10729
|
/**
|
|
@@ -11098,7 +11233,7 @@ export declare namespace CallRegisterPhoneCallParams {
|
|
|
11098
11233
|
/**
|
|
11099
11234
|
* The LLM model to use
|
|
11100
11235
|
*/
|
|
11101
|
-
model: 'gpt-4.1' | 'gpt-4.1-mini' | 'gpt-5' | 'gpt-5-mini' | 'gpt-5-nano' | 'gpt-5.1' | 'gpt-5.2' | 'gpt-5.4' | 'gpt-5.4-mini' | 'gpt-5.4-nano' | 'gpt-5.5' | 'gpt-5.6-terra' | 'gpt-5.6-luna' | 'gpt-6-astra' | 'gpt-6-sol' | 'gpt-6.1-sol' | 'gpt-6-luna' | 'claude-4.6-sonnet' | 'claude-5-opus' | 'claude-5.5-opus' | 'claude-5-sonnet' | 'claude-5.5-sonnet' | 'claude-5.5-haiku' | 'claude-4.5-haiku' | 'gemini-3.0-flash' | 'gemini-3.1-flash-lite' | 'gemini-3.5-flash' | 'gemini-3.5-flash-lite' | 'gemini-3.6-flash' | 'gemini-3.7-flash' | 'gemini-3.8-flash';
|
|
11236
|
+
model: 'gpt-4.1' | 'gpt-4.1-mini' | 'gpt-5' | 'gpt-5-mini' | 'gpt-5-nano' | 'gpt-5.1' | 'gpt-5.2' | 'gpt-5.4' | 'gpt-5.4-mini' | 'gpt-5.4-nano' | 'gpt-5.5' | 'gpt-5.6-terra' | 'gpt-5.6-luna' | 'gpt-6-astra' | 'gpt-6-sol' | 'gpt-6.1-sol' | 'gpt-6-luna' | 'claude-4.6-sonnet' | 'claude-5-opus' | 'claude-5.5-opus' | 'claude-5-sonnet' | 'claude-5.5-sonnet' | 'claude-5.5-haiku' | 'claude-4.5-haiku' | 'gemini-3.0-flash' | 'gemini-3.1-flash-lite' | 'gemini-3.5-flash' | 'gemini-3.5-flash-lite' | 'gemini-3.6-flash' | 'gemini-3.7-flash' | 'gemini-3.8-flash' | 'gemini-4-argon';
|
|
11102
11237
|
/**
|
|
11103
11238
|
* Type of model choice
|
|
11104
11239
|
*/
|
|
@@ -11107,6 +11242,12 @@ export declare namespace CallRegisterPhoneCallParams {
|
|
|
11107
11242
|
* Whether to use high priority pool with more dedicated resource, default false
|
|
11108
11243
|
*/
|
|
11109
11244
|
high_priority?: boolean;
|
|
11245
|
+
/**
|
|
11246
|
+
* Whether to use the ultrafast tier for much faster response generation, default
|
|
11247
|
+
* false. Only supported by gpt-6.1-sol on voice agents; ignored otherwise. Takes
|
|
11248
|
+
* precedence over high_priority.
|
|
11249
|
+
*/
|
|
11250
|
+
ultrafast?: boolean;
|
|
11110
11251
|
}
|
|
11111
11252
|
interface ModelChoiceS2S {
|
|
11112
11253
|
/**
|
|
@@ -11122,7 +11263,7 @@ export declare namespace CallRegisterPhoneCallParams {
|
|
|
11122
11263
|
/**
|
|
11123
11264
|
* Override Retell LLM configuration settings. Only applicable when using Retell
|
|
11124
11265
|
* LLM as the response engine. Supported attributes - model, s2s_model,
|
|
11125
|
-
* model_temperature, model_high_priority, tool_call_strict_mode,
|
|
11266
|
+
* model_temperature, model_high_priority, model_ultrafast, tool_call_strict_mode,
|
|
11126
11267
|
* knowledge_base_ids, kb_config, start_speaker, begin_after_user_silence_ms,
|
|
11127
11268
|
* begin_message.
|
|
11128
11269
|
*/
|
|
@@ -11150,7 +11291,7 @@ export declare namespace CallRegisterPhoneCallParams {
|
|
|
11150
11291
|
/**
|
|
11151
11292
|
* Select the underlying text LLM. If not set, would default to gpt-5.6-terra.
|
|
11152
11293
|
*/
|
|
11153
|
-
model?: 'gpt-4.1' | 'gpt-4.1-mini' | 'gpt-5' | 'gpt-5-mini' | 'gpt-5-nano' | 'gpt-5.1' | 'gpt-5.2' | 'gpt-5.4' | 'gpt-5.4-mini' | 'gpt-5.4-nano' | 'gpt-5.5' | 'gpt-5.6-terra' | 'gpt-5.6-luna' | 'gpt-6-astra' | 'gpt-6-sol' | 'gpt-6.1-sol' | 'gpt-6-luna' | 'claude-4.6-sonnet' | 'claude-5-opus' | 'claude-5.5-opus' | 'claude-5-sonnet' | 'claude-5.5-sonnet' | 'claude-5.5-haiku' | 'claude-4.5-haiku' | 'gemini-3.0-flash' | 'gemini-3.1-flash-lite' | 'gemini-3.5-flash' | 'gemini-3.5-flash-lite' | 'gemini-3.6-flash' | 'gemini-3.7-flash' | 'gemini-3.8-flash' | null;
|
|
11294
|
+
model?: 'gpt-4.1' | 'gpt-4.1-mini' | 'gpt-5' | 'gpt-5-mini' | 'gpt-5-nano' | 'gpt-5.1' | 'gpt-5.2' | 'gpt-5.4' | 'gpt-5.4-mini' | 'gpt-5.4-nano' | 'gpt-5.5' | 'gpt-5.6-terra' | 'gpt-5.6-luna' | 'gpt-6-astra' | 'gpt-6-sol' | 'gpt-6.1-sol' | 'gpt-6-luna' | 'claude-4.6-sonnet' | 'claude-5-opus' | 'claude-5.5-opus' | 'claude-5-sonnet' | 'claude-5.5-sonnet' | 'claude-5.5-haiku' | 'claude-4.5-haiku' | 'gemini-3.0-flash' | 'gemini-3.1-flash-lite' | 'gemini-3.5-flash' | 'gemini-3.5-flash-lite' | 'gemini-3.6-flash' | 'gemini-3.7-flash' | 'gemini-3.8-flash' | 'gemini-4-argon' | null;
|
|
11154
11295
|
/**
|
|
11155
11296
|
* If set to true, will use high priority pool with more dedicated resource to
|
|
11156
11297
|
* ensure lower and more consistent latency, default to false. This feature usually
|
|
@@ -11164,6 +11305,13 @@ export declare namespace CallRegisterPhoneCallParams {
|
|
|
11164
11305
|
* recommended.
|
|
11165
11306
|
*/
|
|
11166
11307
|
model_temperature?: number;
|
|
11308
|
+
/**
|
|
11309
|
+
* If set to true, will use the ultrafast tier for much faster response generation,
|
|
11310
|
+
* default to false. Only supported by gpt-6.1-sol on voice agents; ignored
|
|
11311
|
+
* otherwise. Takes precedence over model_high_priority. This feature comes with a
|
|
11312
|
+
* higher cost.
|
|
11313
|
+
*/
|
|
11314
|
+
model_ultrafast?: boolean | null;
|
|
11167
11315
|
/**
|
|
11168
11316
|
* Select the underlying speech to speech model. Can only set this or model, not
|
|
11169
11317
|
* both.
|