diff --git a/fern/apis/api/openapi.json b/fern/apis/api/openapi.json index a270759b..c16e331c 100644 --- a/fern/apis/api/openapi.json +++ b/fern/apis/api/openapi.json @@ -5109,7 +5109,8 @@ "base-finance", "base-conversationalai", "base-voicemail", - "base-video" + "base-video", + "whisper" ] }, { @@ -5121,7 +5122,11 @@ "type": "string", "description": "This is the language that will be set for the transcription. The list of languages Deepgram supports can be found here: https://developers.deepgram.com/docs/models-languages-overview", "enum": [ + "ar", + "az", + "ba", "bg", + "br", "ca", "cs", "da", @@ -5139,19 +5144,28 @@ "es-419", "es-LATAM", "et", + "eu", "fi", "fr", "fr-CA", + "ha", + "haw", + "he", "hi", "hi-Latn", "hu", "id", + "is", "it", "ja", + "jw", + "kn", "ko", "ko-KR", + "ln", "lt", "lv", + "mk", "ms", "multi", "nl", @@ -5163,6 +5177,11 @@ "ro", "ru", "sk", + "sl", + "sn", + "so", + "sr", + "su", "sv", "sv-SE", "ta", @@ -5170,8 +5189,11 @@ "th", "th-TH", "tr", + "tt", "uk", + "ur", "vi", + "yo", "zh", "zh-CN", "zh-HK", @@ -5878,6 +5900,7 @@ "type": "string", "description": "This is the model that will be used for the transcription.", "enum": [ + "gemini-2.5-flash-preview-04-17", "gemini-2.0-flash-thinking-exp", "gemini-2.0-pro-exp-02-05", "gemini-2.0-flash", @@ -6328,7 +6351,8 @@ "base-finance", "base-conversationalai", "base-voicemail", - "base-video" + "base-video", + "whisper" ] }, { @@ -6340,7 +6364,11 @@ "type": "string", "description": "This is the language that will be set for the transcription. The list of languages Deepgram supports can be found here: https://developers.deepgram.com/docs/models-languages-overview", "enum": [ + "ar", + "az", + "ba", "bg", + "br", "ca", "cs", "da", @@ -6358,19 +6386,28 @@ "es-419", "es-LATAM", "et", + "eu", "fi", "fr", "fr-CA", + "ha", + "haw", + "he", "hi", "hi-Latn", "hu", "id", + "is", "it", "ja", + "jw", + "kn", "ko", "ko-KR", + "ln", "lt", "lv", + "mk", "ms", "multi", "nl", @@ -6382,6 +6419,11 @@ "ro", "ru", "sk", + "sl", + "sn", + "so", + "sr", + "su", "sv", "sv-SE", "ta", @@ -6389,8 +6431,11 @@ "th", "th-TH", "tr", + "tt", "uk", + "ur", "vi", + "yo", "zh", "zh-CN", "zh-HK", @@ -7057,6 +7102,7 @@ "type": "string", "description": "This is the model that will be used for the transcription.", "enum": [ + "gemini-2.5-flash-preview-04-17", "gemini-2.0-flash-thinking-exp", "gemini-2.0-pro-exp-02-05", "gemini-2.0-flash", @@ -7464,7 +7510,7 @@ "maxLength": 1000 }, "value": { - "type": "object", + "type": "string", "description": "This is the value you want to compare against the parameter.", "maxLength": 1000 } @@ -8592,6 +8638,7 @@ "type": "string", "description": "The model to use for the knowledge base", "enum": [ + "gemini-2.5-flash-preview-04-17", "gemini-2.0-flash-thinking-exp", "gemini-2.0-pro-exp-02-05", "gemini-2.0-flash", @@ -9897,6 +9944,7 @@ "type": "string", "description": "This is the Google model that will be used.", "enum": [ + "gemini-2.5-flash-preview-04-17", "gemini-2.0-flash-thinking-exp", "gemini-2.0-pro-exp-02-05", "gemini-2.0-flash", @@ -10314,7 +10362,9 @@ "gpt-4.1-nano", "gpt-4.5-preview", "chatgpt-4o-latest", + "o3", "o3-mini", + "o4-mini", "o1-preview", "o1-preview-2024-09-12", "o1-mini", @@ -10351,7 +10401,9 @@ "gpt-4.1-nano", "gpt-4.5-preview", "chatgpt-4o-latest", + "o3", "o3-mini", + "o4-mini", "o1-preview", "o1-preview-2024-09-12", "o1-mini", @@ -10390,7 +10442,9 @@ "gpt-4.1-nano", "gpt-4.5-preview", "chatgpt-4o-latest", + "o3", "o3-mini", + "o4-mini", "o1-preview", "o1-preview-2024-09-12", "o1-mini", @@ -10912,6 +10966,14 @@ "type": "array", "items": { "oneOf": [ + { + "$ref": "#/components/schemas/Start", + "title": "Start" + }, + { + "$ref": "#/components/schemas/Assistant", + "title": "Assistant" + }, { "$ref": "#/components/schemas/Say", "title": "Say" @@ -11608,6 +11670,12 @@ "AzureVoice": { "type": "object", "properties": { + "cachingEnabled": { + "type": "boolean", + "description": "This is the flag to toggle voice caching for the assistant.", + "example": true, + "default": true + }, "provider": { "type": "string", "description": "This is the voice provider that will be used.", @@ -11718,6 +11786,12 @@ "CartesiaVoice": { "type": "object", "properties": { + "cachingEnabled": { + "type": "boolean", + "description": "This is the flag to toggle voice caching for the assistant.", + "example": true, + "default": true + }, "provider": { "type": "string", "description": "This is the voice provider that will be used.", @@ -11796,6 +11870,12 @@ "CustomVoice": { "type": "object", "properties": { + "cachingEnabled": { + "type": "boolean", + "description": "This is the flag to toggle voice caching for the assistant.", + "example": true, + "default": true + }, "provider": { "type": "string", "description": "This is the voice provider that will be used. Use `custom-voice` for providers that are not natively supported.", @@ -11836,6 +11916,12 @@ "DeepgramVoice": { "type": "object", "properties": { + "cachingEnabled": { + "type": "boolean", + "description": "This is the flag to toggle voice caching for the assistant.", + "example": true, + "default": true + }, "provider": { "type": "string", "description": "This is the voice provider that will be used.", @@ -11949,6 +12035,12 @@ "ElevenLabsVoice": { "type": "object", "properties": { + "cachingEnabled": { + "type": "boolean", + "description": "This is the flag to toggle voice caching for the assistant.", + "example": true, + "default": true + }, "provider": { "type": "string", "description": "This is the voice provider that will be used.", @@ -12078,6 +12170,12 @@ "HumeVoice": { "type": "object", "properties": { + "cachingEnabled": { + "type": "boolean", + "description": "This is the flag to toggle voice caching for the assistant.", + "example": true, + "default": true + }, "provider": { "type": "string", "description": "This is the voice provider that will be used.", @@ -12131,6 +12229,12 @@ "LMNTVoice": { "type": "object", "properties": { + "cachingEnabled": { + "type": "boolean", + "description": "This is the flag to toggle voice caching for the assistant.", + "example": true, + "default": true + }, "provider": { "type": "string", "description": "This is the voice provider that will be used.", @@ -12187,6 +12291,12 @@ "NeuphonicVoice": { "type": "object", "properties": { + "cachingEnabled": { + "type": "boolean", + "description": "This is the flag to toggle voice caching for the assistant.", + "example": true, + "default": true + }, "provider": { "type": "string", "description": "This is the voice provider that will be used.", @@ -12255,6 +12365,12 @@ "OpenAIVoice": { "type": "object", "properties": { + "cachingEnabled": { + "type": "boolean", + "description": "This is the flag to toggle voice caching for the assistant.", + "example": true, + "default": true + }, "provider": { "type": "string", "description": "This is the voice provider that will be used.", @@ -12329,6 +12445,12 @@ "PlayHTVoice": { "type": "object", "properties": { + "cachingEnabled": { + "type": "boolean", + "description": "This is the flag to toggle voice caching for the assistant.", + "example": true, + "default": true + }, "provider": { "type": "string", "description": "This is the voice provider that will be used.", @@ -12493,6 +12615,12 @@ "RimeAIVoice": { "type": "object", "properties": { + "cachingEnabled": { + "type": "boolean", + "description": "This is the flag to toggle voice caching for the assistant.", + "example": true, + "default": true + }, "provider": { "type": "string", "description": "This is the voice provider that will be used.", @@ -12659,6 +12787,12 @@ "SmallestAIVoice": { "type": "object", "properties": { + "cachingEnabled": { + "type": "boolean", + "description": "This is the flag to toggle voice caching for the assistant.", + "example": true, + "default": true + }, "provider": { "type": "string", "description": "This is the voice provider that will be used.", @@ -12788,6 +12922,12 @@ "TavusVoice": { "type": "object", "properties": { + "cachingEnabled": { + "type": "boolean", + "description": "This is the flag to toggle voice caching for the assistant.", + "example": true, + "default": true + }, "provider": { "type": "string", "description": "This is the voice provider that will be used.", @@ -12864,6 +13004,12 @@ "VapiVoice": { "type": "object", "properties": { + "cachingEnabled": { + "type": "boolean", + "description": "This is the flag to toggle voice caching for the assistant.", + "example": true, + "default": true + }, "provider": { "type": "string", "description": "This is the voice provider that will be used.", @@ -12965,6 +13111,12 @@ "FallbackAzureVoice": { "type": "object", "properties": { + "cachingEnabled": { + "type": "boolean", + "description": "This is the flag to toggle voice caching for the assistant.", + "example": true, + "default": true + }, "provider": { "type": "string", "description": "This is the voice provider that will be used.", @@ -13013,6 +13165,12 @@ "FallbackCartesiaVoice": { "type": "object", "properties": { + "cachingEnabled": { + "type": "boolean", + "description": "This is the flag to toggle voice caching for the assistant.", + "example": true, + "default": true + }, "provider": { "type": "string", "description": "This is the voice provider that will be used.", @@ -13083,6 +13241,12 @@ "FallbackCustomVoice": { "type": "object", "properties": { + "cachingEnabled": { + "type": "boolean", + "description": "This is the flag to toggle voice caching for the assistant.", + "example": true, + "default": true + }, "provider": { "type": "string", "description": "This is the voice provider that will be used. Use `custom-voice` for providers that are not natively supported.", @@ -13115,6 +13279,12 @@ "FallbackDeepgramVoice": { "type": "object", "properties": { + "cachingEnabled": { + "type": "boolean", + "description": "This is the flag to toggle voice caching for the assistant.", + "example": true, + "default": true + }, "provider": { "type": "string", "description": "This is the voice provider that will be used.", @@ -13220,6 +13390,12 @@ "FallbackElevenLabsVoice": { "type": "object", "properties": { + "cachingEnabled": { + "type": "boolean", + "description": "This is the flag to toggle voice caching for the assistant.", + "example": true, + "default": true + }, "provider": { "type": "string", "description": "This is the voice provider that will be used.", @@ -13341,6 +13517,12 @@ "FallbackHumeVoice": { "type": "object", "properties": { + "cachingEnabled": { + "type": "boolean", + "description": "This is the flag to toggle voice caching for the assistant.", + "example": true, + "default": true + }, "provider": { "type": "string", "description": "This is the voice provider that will be used.", @@ -13386,6 +13568,12 @@ "FallbackLMNTVoice": { "type": "object", "properties": { + "cachingEnabled": { + "type": "boolean", + "description": "This is the flag to toggle voice caching for the assistant.", + "example": true, + "default": true + }, "provider": { "type": "string", "description": "This is the voice provider that will be used.", @@ -13434,6 +13622,12 @@ "FallbackNeuphonicVoice": { "type": "object", "properties": { + "cachingEnabled": { + "type": "boolean", + "description": "This is the flag to toggle voice caching for the assistant.", + "example": true, + "default": true + }, "provider": { "type": "string", "description": "This is the voice provider that will be used.", @@ -13494,6 +13688,12 @@ "FallbackOpenAIVoice": { "type": "object", "properties": { + "cachingEnabled": { + "type": "boolean", + "description": "This is the flag to toggle voice caching for the assistant.", + "example": true, + "default": true + }, "provider": { "type": "string", "description": "This is the voice provider that will be used.", @@ -13560,6 +13760,12 @@ "FallbackPlayHTVoice": { "type": "object", "properties": { + "cachingEnabled": { + "type": "boolean", + "description": "This is the flag to toggle voice caching for the assistant.", + "example": true, + "default": true + }, "provider": { "type": "string", "description": "This is the voice provider that will be used.", @@ -13716,6 +13922,12 @@ "FallbackRimeAIVoice": { "type": "object", "properties": { + "cachingEnabled": { + "type": "boolean", + "description": "This is the flag to toggle voice caching for the assistant.", + "example": true, + "default": true + }, "provider": { "type": "string", "description": "This is the voice provider that will be used.", @@ -13874,6 +14086,12 @@ "FallbackSmallestAIVoice": { "type": "object", "properties": { + "cachingEnabled": { + "type": "boolean", + "description": "This is the flag to toggle voice caching for the assistant.", + "example": true, + "default": true + }, "provider": { "type": "string", "description": "This is the voice provider that will be used.", @@ -13950,6 +14168,12 @@ "FallbackTavusVoice": { "type": "object", "properties": { + "cachingEnabled": { + "type": "boolean", + "description": "This is the flag to toggle voice caching for the assistant.", + "example": true, + "default": true + }, "provider": { "type": "string", "description": "This is the voice provider that will be used.", @@ -14018,6 +14242,12 @@ "FallbackVapiVoice": { "type": "object", "properties": { + "cachingEnabled": { + "type": "boolean", + "description": "This is the flag to toggle voice caching for the assistant.", + "example": true, + "default": true + }, "provider": { "type": "string", "description": "This is the voice provider that will be used.", @@ -15475,6 +15705,14 @@ "type": "string", "description": "This is not returned in the API." }, + "apiKey": { + "type": "string", + "description": "This is not returned in the API." + }, + "apiSecret": { + "type": "string", + "description": "This is not returned in the API." + }, "accountSid": { "type": "string" }, @@ -15487,7 +15725,6 @@ }, "required": [ "provider", - "authToken", "accountSid" ] }, @@ -15699,9 +15936,171 @@ "type" ] }, + "FunctionCallAssistantHookAction": { + "type": "object", + "properties": { + "async": { + "type": "boolean", + "description": "This determines if the tool is async.\n\nIf async, the assistant will move forward without waiting for your server to respond. This is useful if you just want to trigger something on your server.\n\nIf sync, the assistant will wait for your server to respond. This is useful if want assistant to respond with the result from your server.\n\nDefaults to synchronous (`false`).", + "example": false + }, + "messages": { + "type": "array", + "description": "These are the messages that will be spoken to the user as the tool is running.\n\nFor some tools, this is auto-filled based on special fields like `tool.destinations`. For others like the function tool, these can be custom configured.", + "items": { + "oneOf": [ + { + "$ref": "#/components/schemas/ToolMessageStart", + "title": "ToolMessageStart" + }, + { + "$ref": "#/components/schemas/ToolMessageComplete", + "title": "ToolMessageComplete" + }, + { + "$ref": "#/components/schemas/ToolMessageFailed", + "title": "ToolMessageFailed" + }, + { + "$ref": "#/components/schemas/ToolMessageDelayed", + "title": "ToolMessageDelayed" + } + ] + } + }, + "type": { + "type": "string", + "enum": [ + "function" + ], + "description": "The type of tool. \"function\" for Function tool." + }, + "function": { + "description": "This is the function definition of the tool.\n\nFor `endCall`, `transferCall`, and `dtmf` tools, this is auto-filled based on tool-specific fields like `tool.destinations`. But, even in those cases, you can provide a custom function definition for advanced use cases.\n\nAn example of an advanced use case is if you want to customize the message that's spoken for `endCall` tool. You can specify a function where it returns an argument \"reason\". Then, in `messages` array, you can have many \"request-complete\" messages. One of these messages will be triggered if the `messages[].conditions` matches the \"reason\" argument.", + "allOf": [ + { + "$ref": "#/components/schemas/OpenAIFunction" + } + ] + }, + "server": { + "description": "This is the server that will be hit when this tool is requested by the model.\n\nAll requests will be sent with the call object among other things. You can find more details in the Server URL documentation.\n\nThis overrides the serverUrl set on the org and the phoneNumber. Order of precedence: highest tool.server.url, then assistant.serverUrl, then phoneNumber.serverUrl, then org.serverUrl.", + "allOf": [ + { + "$ref": "#/components/schemas/Server" + } + ] + } + }, + "required": [ + "type" + ] + }, + "AssistantHookFilter": { + "type": "object", + "properties": { + "type": { + "type": "string", + "description": "This is the type of filter - currently only \"oneOf\" is supported", + "enum": [ + "oneOf" + ], + "maxLength": 1000 + }, + "key": { + "type": "string", + "description": "This is the key to filter on (e.g. \"call.endedReason\")", + "maxLength": 1000 + }, + "oneOf": { + "description": "This is the array of possible values to match against", + "type": "array", + "items": { + "type": "string", + "maxLength": 1000 + } + } + }, + "required": [ + "type", + "key", + "oneOf" + ] + }, + "AssistantHookCallEnding": { + "type": "object", + "properties": { + "on": { + "type": "string", + "description": "This is the event that triggers this hook", + "enum": [ + "call.ending" + ], + "maxLength": 1000 + }, + "do": { + "type": "array", + "description": "This is the set of actions to perform when the hook triggers", + "items": { + "oneOf": [ + { + "$ref": "#/components/schemas/TransferAssistantHookAction", + "title": "TransferAssistantHookAction" + }, + { + "$ref": "#/components/schemas/FunctionCallAssistantHookAction", + "title": "FunctionCallAssistantHookAction" + } + ] + } + }, + "filters": { + "description": "This is the set of filters that must match for the hook to trigger", + "type": "array", + "items": { + "$ref": "#/components/schemas/AssistantHookFilter" + } + } + }, + "required": [ + "on", + "do" + ] + }, + "VoicemailDetectionBackoffPlan": { + "type": "object", + "properties": { + "startAtSeconds": { + "type": "number", + "description": "This is the number of seconds to wait before starting the first retry attempt.", + "minimum": 0, + "default": 5 + }, + "frequencySeconds": { + "type": "number", + "description": "This is the interval in seconds between retry attempts.", + "minimum": 2.5, + "default": 5 + }, + "maxRetries": { + "type": "number", + "description": "This is the maximum number of retry attempts before giving up.", + "minimum": 1, + "maximum": 10, + "default": 6 + } + } + }, "GoogleVoicemailDetectionPlan": { "type": "object", "properties": { + "beepMaxAwaitSeconds": { + "type": "number", + "description": "This is the maximum duration from the start of the call that we will wait for a voicemail beep, before speaking our message\n\n- If we detect a voicemail beep before this, we will speak the message at that point.\n\n- Setting too low a value means that the bot will start speaking its voicemail message too early. If it does so before the actual beep, it will get cut off. You should definitely tune this to your use case.\n\n@default 30\n@min 0\n@max 60", + "minimum": 0, + "maximum": 30, + "default": 30 + }, "provider": { "type": "string", "description": "This is the provider to use for voicemail detection.", @@ -15709,22 +16108,29 @@ "google" ] }, - "voicemailExpectedDurationSeconds": { - "type": "number", - "description": "This is how long should we listen in order to determine if we were sent to voicemail or not?\n\n@default 15", - "minimum": 5, - "maximum": 60, - "default": 25 + "backoffPlan": { + "description": "This is the backoff plan for the voicemail detection.", + "allOf": [ + { + "$ref": "#/components/schemas/VoicemailDetectionBackoffPlan" + } + ] } }, "required": [ - "provider", - "voicemailExpectedDurationSeconds" + "provider" ] }, "OpenAIVoicemailDetectionPlan": { "type": "object", "properties": { + "beepMaxAwaitSeconds": { + "type": "number", + "description": "This is the maximum duration from the start of the call that we will wait for a voicemail beep, before speaking our message\n\n- If we detect a voicemail beep before this, we will speak the message at that point.\n\n- Setting too low a value means that the bot will start speaking its voicemail message too early. If it does so before the actual beep, it will get cut off. You should definitely tune this to your use case.\n\n@default 30\n@min 0\n@max 60", + "minimum": 0, + "maximum": 30, + "default": 30 + }, "provider": { "type": "string", "description": "This is the provider to use for voicemail detection.", @@ -15732,17 +16138,17 @@ "openai" ] }, - "voicemailExpectedDurationSeconds": { - "type": "number", - "description": "This is how long should we listen in order to determine if we were sent to voicemail or not?\n\n@default 15", - "minimum": 5, - "maximum": 60, - "default": 25 + "backoffPlan": { + "description": "This is the backoff plan for the voicemail detection.", + "allOf": [ + { + "$ref": "#/components/schemas/VoicemailDetectionBackoffPlan" + } + ] } }, "required": [ - "provider", - "voicemailExpectedDurationSeconds" + "provider" ] }, "TwilioVoicemailDetectionPlan": { @@ -16382,72 +16788,6 @@ } } }, - "AssistantHookFilter": { - "type": "object", - "properties": { - "type": { - "type": "string", - "description": "This is the type of filter - currently only \"oneOf\" is supported", - "enum": [ - "oneOf" - ], - "maxLength": 1000 - }, - "key": { - "type": "string", - "description": "This is the key to filter on (e.g. \"call.endedReason\")", - "maxLength": 1000 - }, - "oneOf": { - "description": "This is the array of possible values to match against", - "type": "array", - "items": { - "type": "string", - "maxLength": 1000 - } - } - }, - "required": [ - "type", - "key", - "oneOf" - ] - }, - "AssistantHookActionBase": { - "type": "object", - "properties": {} - }, - "AssistantHooks": { - "type": "object", - "properties": { - "on": { - "type": "string", - "description": "This is the event that triggers this hook", - "enum": [ - "call.ending" - ], - "maxLength": 1000 - }, - "filters": { - "description": "This is the set of filters that must match for the hook to trigger", - "type": "array", - "items": { - "$ref": "#/components/schemas/AssistantHookFilter" - } - }, - "do": { - "description": "This is the set of actions to perform when the hook triggers", - "type": "array", - "items": { - "$ref": "#/components/schemas/AssistantHookActionBase" - } - } - }, - "required": [ - "on", - "do" - ] - }, "KeypadInputPlan": { "type": "object", "properties": { @@ -16683,6 +17023,10 @@ { "$ref": "#/components/schemas/TwilioVoicemailDetectionPlan", "title": "Twilio" + }, + { + "$ref": "#/components/schemas/VapiVoicemailDetectionPlan", + "title": "Vapi" } ] }, @@ -16701,6 +17045,7 @@ "transcript", "tool-calls", "tool-calls-result", + "tool.completed", "transfer-update", "user-interrupted", "voice-input", @@ -16736,6 +17081,7 @@ "transcript", "tool-calls", "tool-calls-result", + "tool.completed", "transfer-update", "user-interrupted", "voice-input", @@ -17116,6 +17462,18 @@ } } }, + "hooks": { + "type": "array", + "description": "This is a set of actions that will be performed on certain events.", + "items": { + "oneOf": [ + { + "$ref": "#/components/schemas/AssistantHookCallEnding", + "title": "AssistantHookCallEnding" + } + ] + } + }, "name": { "type": "string", "description": "This is the name of the assistant.\n\nThis is required when you want to transfer between assistants in a call.", @@ -17210,13 +17568,6 @@ } ] }, - "hooks": { - "description": "This is a set of actions that will be performed on certain events.", - "type": "array", - "items": { - "$ref": "#/components/schemas/AssistantHooks" - } - }, "keypadInputPlan": { "$ref": "#/components/schemas/KeypadInputPlan" } @@ -17433,6 +17784,10 @@ { "$ref": "#/components/schemas/TwilioVoicemailDetectionPlan", "title": "Twilio" + }, + { + "$ref": "#/components/schemas/VapiVoicemailDetectionPlan", + "title": "Vapi" } ] }, @@ -17451,6 +17806,7 @@ "transcript", "tool-calls", "tool-calls-result", + "tool.completed", "transfer-update", "user-interrupted", "voice-input", @@ -17486,6 +17842,7 @@ "transcript", "tool-calls", "tool-calls-result", + "tool.completed", "transfer-update", "user-interrupted", "voice-input", @@ -17866,6 +18223,18 @@ } } }, + "hooks": { + "type": "array", + "description": "This is a set of actions that will be performed on certain events.", + "items": { + "oneOf": [ + { + "$ref": "#/components/schemas/AssistantHookCallEnding", + "title": "AssistantHookCallEnding" + } + ] + } + }, "variableValues": { "type": "object", "description": "These are values that will be used to replace the template variables in the assistant messages and other text-based fields.\nThis uses LiquidJS syntax. https://liquidjs.com/tutorials/intro-to-liquid.html\n\nSo for example, `{{ name }}` will be replaced with the value of `name` in `variableValues`.\n`{{\"now\" | date: \"%b %d, %Y, %I:%M %p\", \"America/New_York\"}}` will be replaced with the current date and time in New York.\n Some VAPI reserved defaults:\n - *customer* - the customer object" @@ -17964,13 +18333,6 @@ } ] }, - "hooks": { - "description": "This is a set of actions that will be performed on certain events.", - "type": "array", - "items": { - "$ref": "#/components/schemas/AssistantHooks" - } - }, "keypadInputPlan": { "$ref": "#/components/schemas/KeypadInputPlan" } @@ -18036,6 +18398,55 @@ "members" ] }, + "TransferPhoneNumberHookAction": { + "type": "object", + "properties": { + "type": { + "type": "string", + "description": "This is the type of action - must be \"transfer\"", + "enum": [ + "transfer" + ] + }, + "destination": { + "description": "This is the destination details for the transfer - can be a phone number or SIP URI", + "oneOf": [ + { + "$ref": "#/components/schemas/TransferDestinationNumber", + "title": "NumberTransferDestination" + }, + { + "$ref": "#/components/schemas/TransferDestinationSip", + "title": "SipTransferDestination" + } + ] + } + }, + "required": [ + "type" + ] + }, + "SayPhoneNumberHookAction": { + "type": "object", + "properties": { + "type": { + "type": "string", + "description": "This is the type of action - must be \"say\"", + "enum": [ + "say" + ] + }, + "exact": { + "type": "string", + "description": "This is the message to say", + "maxLength": 4000 + } + }, + "required": [ + "type", + "exact" + ] + }, "PhoneNumberHookCallRinging": { "type": "object", "properties": { @@ -18110,6 +18521,14 @@ "type": "string", "description": "This is the Twilio Auth Token that will be used to handle this phone number." }, + "twilioApiKey": { + "type": "string", + "description": "This is the Twilio API Key that will be used to handle this phone number. If AuthToken is provided, this will be ignored." + }, + "twilioApiSecret": { + "type": "string", + "description": "This is the Twilio API Secret that will be used to handle this phone number. If AuthToken is provided, this will be ignored." + }, "name": { "type": "string", "description": "This is the name of the phone number. This is just for your own reference.", @@ -18134,8 +18553,7 @@ }, "required": [ "twilioPhoneNumber", - "twilioAccountSid", - "twilioAuthToken" + "twilioAccountSid" ] }, "CreateCustomerDTO": { @@ -19567,6 +19985,14 @@ "type": "array", "items": { "oneOf": [ + { + "$ref": "#/components/schemas/Start", + "title": "Start" + }, + { + "$ref": "#/components/schemas/Assistant", + "title": "Assistant" + }, { "$ref": "#/components/schemas/Say", "title": "Say" @@ -19899,6 +20325,10 @@ { "$ref": "#/components/schemas/TwilioVoicemailDetectionPlan", "title": "Twilio" + }, + { + "$ref": "#/components/schemas/VapiVoicemailDetectionPlan", + "title": "Vapi" } ] }, @@ -19917,6 +20347,7 @@ "transcript", "tool-calls", "tool-calls-result", + "tool.completed", "transfer-update", "user-interrupted", "voice-input", @@ -19952,6 +20383,7 @@ "transcript", "tool-calls", "tool-calls-result", + "tool.completed", "transfer-update", "user-interrupted", "voice-input", @@ -20332,6 +20764,18 @@ } } }, + "hooks": { + "type": "array", + "description": "This is a set of actions that will be performed on certain events.", + "items": { + "oneOf": [ + { + "$ref": "#/components/schemas/AssistantHookCallEnding", + "title": "AssistantHookCallEnding" + } + ] + } + }, "name": { "type": "string", "description": "This is the name of the assistant.\n\nThis is required when you want to transfer between assistants in a call.", @@ -20426,13 +20870,6 @@ } ] }, - "hooks": { - "description": "This is a set of actions that will be performed on certain events.", - "type": "array", - "items": { - "$ref": "#/components/schemas/AssistantHooks" - } - }, "keypadInputPlan": { "$ref": "#/components/schemas/KeypadInputPlan" }, @@ -20691,6 +21128,10 @@ { "$ref": "#/components/schemas/TwilioVoicemailDetectionPlan", "title": "Twilio" + }, + { + "$ref": "#/components/schemas/VapiVoicemailDetectionPlan", + "title": "Vapi" } ] }, @@ -20709,6 +21150,7 @@ "transcript", "tool-calls", "tool-calls-result", + "tool.completed", "transfer-update", "user-interrupted", "voice-input", @@ -20744,6 +21186,7 @@ "transcript", "tool-calls", "tool-calls-result", + "tool.completed", "transfer-update", "user-interrupted", "voice-input", @@ -21124,6 +21567,18 @@ } } }, + "hooks": { + "type": "array", + "description": "This is a set of actions that will be performed on certain events.", + "items": { + "oneOf": [ + { + "$ref": "#/components/schemas/AssistantHookCallEnding", + "title": "AssistantHookCallEnding" + } + ] + } + }, "name": { "type": "string", "description": "This is the name of the assistant.\n\nThis is required when you want to transfer between assistants in a call.", @@ -21218,13 +21673,6 @@ } ] }, - "hooks": { - "description": "This is a set of actions that will be performed on certain events.", - "type": "array", - "items": { - "$ref": "#/components/schemas/AssistantHooks" - } - }, "keypadInputPlan": { "$ref": "#/components/schemas/KeypadInputPlan" } @@ -21432,6 +21880,14 @@ "twilioAuthToken": { "type": "string", "description": "This is the Twilio Auth Token for the phone number." + }, + "twilioApiKey": { + "type": "string", + "description": "This is the Twilio API Key for the phone number." + }, + "twilioApiSecret": { + "type": "string", + "description": "This is the Twilio API Secret for the phone number." } }, "required": [ @@ -21441,8 +21897,7 @@ "createdAt", "updatedAt", "number", - "twilioAccountSid", - "twilioAuthToken" + "twilioAccountSid" ] }, "VonagePhoneNumber": { @@ -21912,6 +22367,14 @@ "type": "string", "description": "This is the Twilio Auth Token for the phone number." }, + "twilioApiKey": { + "type": "string", + "description": "This is the Twilio API Key for the phone number." + }, + "twilioApiSecret": { + "type": "string", + "description": "This is the Twilio API Secret for the phone number." + }, "name": { "type": "string", "description": "This is the name of the phone number. This is just for your own reference.", @@ -21937,8 +22400,7 @@ "required": [ "provider", "number", - "twilioAccountSid", - "twilioAuthToken" + "twilioAccountSid" ] }, "CreateVonagePhoneNumberDTO": { @@ -22288,6 +22750,14 @@ "twilioAuthToken": { "type": "string", "description": "This is the Twilio Auth Token for the phone number." + }, + "twilioApiKey": { + "type": "string", + "description": "This is the Twilio API Key for the phone number." + }, + "twilioApiSecret": { + "type": "string", + "description": "This is the Twilio API Secret for the phone number." } } }, @@ -25816,6 +26286,14 @@ "type": "array", "items": { "oneOf": [ + { + "$ref": "#/components/schemas/Start", + "title": "Start" + }, + { + "$ref": "#/components/schemas/Assistant", + "title": "Assistant" + }, { "$ref": "#/components/schemas/Say", "title": "Say" @@ -30080,6 +30558,14 @@ "type": "string", "description": "This is not returned in the API." }, + "apiKey": { + "type": "string", + "description": "This is not returned in the API." + }, + "apiSecret": { + "type": "string", + "description": "This is not returned in the API." + }, "id": { "type": "string", "description": "This is the unique identifier for the credential." @@ -30110,7 +30596,6 @@ }, "required": [ "provider", - "authToken", "id", "orgId", "createdAt", @@ -31496,6 +31981,14 @@ "type": "string", "description": "This is not returned in the API." }, + "apiKey": { + "type": "string", + "description": "This is not returned in the API." + }, + "apiSecret": { + "type": "string", + "description": "This is not returned in the API." + }, "name": { "type": "string", "description": "This is the name of credential. This is just for your reference.", @@ -35840,6 +36333,10 @@ "error": { "type": "string", "description": "This is the error if the tool call was not successful. This is added to the conversation history.\n\nFurther, if this is returned, assistant will speak:\n1. the `message`, if it exists and is of type `request-failed`\n2. a `request-failed` message from `tool.messages`, if it exists\n3. a response generated by the model, if neither exist" + }, + "metadata": { + "type": "object", + "description": "This is optional metadata for the tool call result to be sent to the client." } }, "required": [ @@ -36260,6 +36757,10 @@ "secondsFromStart": { "type": "number", "description": "The number of seconds from the start of the conversation." + }, + "metadata": { + "type": "object", + "description": "The metadata for the tool call result." } }, "required": [ @@ -36498,7 +36999,8 @@ "enum": [ "twilio", "google", - "openai" + "openai", + "vapi" ] }, "promptTextTokens": {