Skip to content

Commit 89d46c2

Browse files
elizabethtrykinelizabethtrykin
committed
Merge branch 'main' into update-openapi-spec-2025-05-15T00-26-00-032Z
2 parents f0fe167 + feae1f9 commit 89d46c2

22 files changed

+4608
-4569
lines changed

‎fern/apis/api/openapi.json

Lines changed: 4169 additions & 4085 deletions
Large diffs are not rendered by default.

‎fern/assistants/voice-formatting-plan.mdx

Lines changed: 16 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -20,21 +20,22 @@ You can turn off formatting if you want the TTS to read the raw LLM output.
2020

2121
When enabled, the formatter runs a series of transformations on your text, each handled by a specific function. Here's the order and what each function does:
2222

23-
| **Step** | **Function Name** | **Description** | **Before** | **After** |
24-
| :------- | :---------------- | :-------------- | :--------- | :-------- |
25-
| 1 | `removeAngleBracketContent` | Removes anything within `<...>`, except for `<break>`, `<spell>`, or double angle brackets `<< >>`. | `Hello <tag> world` | `Hello world` |
26-
| 2 | `removeMarkdownSymbols` | Removes markdown symbols like `_`, `` ` ``, and `~`. Asterisks (`*`) are preserved in this step. | `**Wanted** to say *hi*` | `**Wanted** to say *hi*` |
27-
| 3 | `removePhrasesInAsterisks` | Removes text surrounded by single or double asterisks. | `**Wanted** to say *hi*` | ` to say` |
28-
| 4 | `replaceNewLinesWithPeriods` | Converts new lines (`\n`) to periods for smoother speech. | `Hello world\n to say\nWe have NASA` | `Hello world . to say . We have NASA` |
29-
| 5 | `replaceColonsWithPeriods` | Replaces `:` with `.` for better phrasing. | `price: $42.50` | `price. $42.50` |
30-
| 6 | `formatAcronyms` | Converts known acronyms to lowercase (e.g., NASA → nasa) or spaces out unknown all-caps words unless they contain vowels. | `NASA and .NET` | `nasa and .net` |
31-
| 7 | `formatDollarAmounts` | Converts currency amounts to spoken words. | `$42.50` | `forty two dollars and fifty cents` |
32-
| 8 | `formatEmails` | Replaces `@` with "at" and `.` with "dot" in emails. | `JOHN.DOE@example.COM` | `JOHN dot DOE at example dot COM` |
33-
| 9 | `formatDates` | Converts date strings into spoken date format. | `2023 05 10` | `Wednesday, May 10, 2023` |
34-
| 10 | `formatTimes` | Expands or simplifies time expressions. | `14:00` | `14` |
35-
| 11 | `formatDistances`, `formatUnits`, `formatPercentages`, `formatPhoneNumbers` | Converts units, distances, percentages, and phone numbers into spoken words. | `5km`, `43 lb`, `50%`, `123-456-7890` | `5 kilometers`, `forty three pounds`, `50 percent`, `1 2 3 4 5 6 7 8 9 0` |
36-
| 12 | `formatNumbers` | Formats general numbers: years read as digits, large numbers spelled out, negative and decimal numbers clarified. | `-9`, `2.5`, `2023` | `minus nine`, `two point five`, `2023` |
37-
| 13 | `Applying Replacements` | Applies user-defined final replacements like expanding street abbreviations. | `320 ST 21 RD` | `320 STREET 21 ROAD` |
23+
| **Step** | **Function Name** | **Description** | **Before** | **After** | **Default** | **Precedence** |
24+
| :------- | :---------------- | :-------------- | :--------- | :-------- | :---------- | :------------ |
25+
| 1 | `removeAngleBracketContent` | Removes anything within `<...>`, except for `<break>`, `<spell>`, or double angle brackets `<< >>`. | `Hello <tag> world` | `Hello world` | ✅ | - |
26+
| 2 | `removeMarkdownSymbols` | Removes markdown symbols like `_`, `` ` ``, and `~`. Asterisks (`*`) are preserved in this step. | `**Wanted** to say *hi*` | `**Wanted** to say *hi*` | ✅ | 0 |
27+
| 3 | `removePhrasesInAsterisks` | Removes text surrounded by single or double asterisks. | `**Wanted** to say *hi*` | ` to say` | ❌ | 0 |
28+
| 4 | `replaceNewLinesWithPeriods` | Converts new lines (`\n`) to periods for smoother speech. | `Hello world\n to say\nWe have NASA` | `Hello world . to say . We have NASA` | ✅ | 0 |
29+
| 5 | `replaceColonsWithPeriods` | Replaces `:` with `.` for better phrasing. | `price: $42.50` | `price. $42.50` | ✅ | 0 |
30+
| 6 | `formatAcronyms` | Converts known acronyms to lowercase (e.g., NASA → nasa) or spaces out unknown all-caps words unless they contain vowels. | `NASA and .NET` | `nasa and .net` | ✅ | 0 |
31+
| 7 | `formatDollarAmounts` | Converts currency amounts to spoken words. | `$42.50` | `forty two dollars and fifty cents` | ✅ | 0 |
32+
| 8 | `formatEmails` | Replaces `@` with "at" and `.` with "dot" in emails. | `JOHN.DOE@example.COM` | `JOHN dot DOE at example dot COM` | ✅ | 0 |
33+
| 9 | `formatDates` | Converts date strings into spoken date format. | `2023 05 10` | `Wednesday, May 10, 2023` | ✅ | 0 |
34+
| 10 | `formatTimes` | Expands or simplifies time expressions. | `14:00` | `14` | ✅ | 0 |
35+
| 11 | `formatDistances`, `formatUnits`, `formatPercentages`, `formatPhoneNumbers` | Converts units, distances, percentages, and phone numbers into spoken words. | `5km`, `43 lb`, `50%`, `123-456-7890` | `5 kilometers`, `forty three pounds`, `50 percent`, `1 2 3 4 5 6 7 8 9 0` | ✅ | 0 |
36+
| 12 | `formatNumbers` | Formats general numbers: years read as digits, large numbers spelled out, negative and decimal numbers clarified. | `-9`, `2.5`, `2023` | `minus nine`, `two point five`, `2023` | ✅ | 0 |
37+
| 13 | `removeAsterisks` | Removes all asterisk characters from the text. | `**Bold** and *italic*` | `Bold and italic` | ✅ | 1 |
38+
| 14 | `Applying Replacements` | Applies user-defined final replacements like expanding street abbreviations. | `320 ST 21 RD` | `320 STREET 21 ROAD` | ✅ | - |
3839

3940
---
4041

‎fern/calls/voicemail-detection.mdx

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -62,10 +62,10 @@ For each detection method, you can fine-tune the following parameters:
6262

6363
| Parameter | Description |
6464
| :-------- | :---------- |
65-
| **Initial Detection Delay** | How long to wait (in seconds) before starting voicemail detection |
66-
| **Detection Retry Interval** | How frequently to check for voicemail (in seconds) |
67-
| **Max Detection Retries** | Maximum number of detection attempts before stopping |
68-
| **Max Voicemail Message Wait** | Maximum time to wait before leaving a message (even without beep detection) |
65+
| **<a href="https://docs.vapi.ai/api-reference/assistants/create#request.body.voicemailDetection.vapi.backoffPlan.startAtSeconds" target="_blank">Initial Detection Delay</a>** | How long to wait (in seconds) before starting voicemail detection |
66+
| **<a href="https://docs.vapi.ai/api-reference/assistants/create#request.body.voicemailDetection.vapi.backoffPlan.frequencySeconds" target="_blank">Detection Retry Interval</a>** | How frequently to check for voicemail (in seconds) |
67+
| **<a href="https://docs.vapi.ai/api-reference/assistants/create#request.body.voicemailDetection.vapi.backoffPlan.maxRetries" target="_blank">Max Detection Retries</a>** | Maximum number of detection attempts before stopping |
68+
| **<a href="https://docs.vapi.ai/api-reference/assistants/create#request.body.voicemailDetection.vapi.beepMaxAwaitSeconds" target="_blank">Max Voicemail Message Wait</a>** | Maximum time to wait before leaving a message (even without beep detection) |
6969

7070
These settings allow you to balance:
7171
- **Speed** (how quickly voicemail is detected)

‎fern/changelog/2025-05-13.mdx

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
# GoHighLevel Tools for Calendar and Contact Management
2+
3+
You can now use new [GoHighLevel tools](https://www.gohighlevel.com) in all models, templates, and workflows directly through the [`/tool`](https://api.vapi.ai/api#:~:text=/tool) and [`/tool/{id}`](https://api.vapi.ai/api#:~:text=/tool/%7Bid%7D) endpoints with the following capabilities:
4+
- **Contact Management**:
5+
- [GoHighLevelContactGetTool](https://api.vapi.ai/api#:~:text=GoHighLevelContactGetTool): Fetch contact information from GoHighLevel
6+
- [GoHighLevelContactCreateTool](https://api.vapi.ai/api#:~:text=GoHighLevelContactCreateTool): Create new contacts in GoHighLevel
7+
8+
- **Calendar Management**:
9+
- [GoHighLevelCalendarEventCreateTool](https://api.vapi.ai/api#:~:text=GoHighLevelCalendarEventCreateTool): Schedule new calendar events programmatically
10+
- [GoHighLevelCalendarAvailabilityTool](https://api.vapi.ai/api#:~:text=GoHighLevelCalendarAvailabilityTool): Check calendar availability for scheduling

‎fern/changelog/2025-05-14.mdx

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
1. **Specify Start Node in Workflows with `isStart` Property**: You can now explicitly define the starting point of your workflow by setting the `isStart` property to `true` on any node like [`Say`](https://api.vapi.ai/api#:~:text=Say), [`Gather`](https://api.vapi.ai/api#:~:text=Gather), or [`Hangup`](https://api.vapi.ai/api#:~:text=Hangup).
2+
3+
2. **Updated Model Options in `GroqModel`**: You can now use the following new Assistant modles with [Groq](https://api.vapi.ai/api#:~:text=GroqModel):
4+
- `meta-llama/llama-4-maverick-17b-128e-instruct`
5+
- `meta-llama/llama-4-scout-17b-16e-instruct`
6+
- `mistral-saba-24b`
7+
- `compound-beta`
8+
- `compound-beta-mini`
9+
10+
<Frame caption="New Groq Models">
11+
<img src="../static/images/changelog/new-groq-models.png" alt="New Groq Models" />
12+
</Frame>
13+
14+
<Warning>Note that some older models have been removed, including `llama-3.1-70b-versatile` and `mixtral-8x7b-32768`.</Warning>
15+
16+
3. **New `Kylie` Voice Available in Vapi**: You can now use the new `Kylie` voice when using [`Vapi` as your voice provider](https://dashboard.vapi.ai/assistants#:~:text=Voice%20Configuration). You can learn more in the [Vapi voices documentation](https://docs.vapi.ai/providers/voice/vapi-voicesn).
17+
18+
<Frame caption="New Vapi Voice: Kylie">
19+
<img src="../static/images/changelog/vapi-voice-kylie.png" alt="New Kylie Voice" />
20+
</Frame>

‎fern/changelog/2025-05-15.mdx

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
# New Azure OpenAI GPT 4.1 Models
2+
1. **Access to New Azure OpenAI Models**: You can now use new GPT 4.1 models in Azure OpenAI such as `gpt-4.1-2025-04-14`, `gpt-4.1-mini-2025-04-14`, and `gpt-4.1-nano-2025-04-14`.
3+
4+
<Warning>The above models will be available to configure through the console at a later date. For now, configure your assistant to use these models through [the API](https://docs.vapi.ai/api-reference/assistants/update).</Warning>

‎fern/changelog/2025-05-16.mdx

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
# Strip Asterisks from Transcribed Text with `stripAsterisk` Formatter
2+
3+
1. **New `stripAsterisk` Formatter in [FormatPlan](https://api.vapi.ai/api#:~:text=FormatPlan)**: You can now remove asterisks from transcribed text by adding it to your `Assistant.voice[VOICE_PROVIDER].chunkPlan.formatPlan.formattersEnabled` configuration.
4+
5+
<Info>
6+
Ensure `Assistant.voice[VOICE_PROVIDER].chunkPlan.formatPlan.enabled` is set to `true` to use the `stripAsterisk` formatter.
7+
</Info>

‎fern/customization/custom-voices/elevenlabs.mdx

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,22 +1,22 @@
11
---
2-
title: Elevenlabs
3-
subtitle: Set up a custom Elevenlabs voice in Vapi
2+
title: ElevenLabs
3+
subtitle: Set up a custom ElevenLabs voice in Vapi
44
slug: customization/custom-voices/elevenlabs
55
---
66

7-
This guide outlines the procedure for integrating your cloned voice with 11labs through the Vapi platform.
7+
This guide outlines the procedure for integrating your cloned voice with ElevenLabs through the Vapi platform.
88

99
<Note>An API subscription is required for this process to work.</Note>
1010

1111
<Steps>
12-
<Step title="Obtain an 11labs API subscription">
13-
Visit the [11labs pricing page](https://elevenlabs.io/pricing) and subscribe to an API plan that suits your needs.
12+
<Step title="Obtain an ElevenLabs API subscription">
13+
Visit the [ElevenLabs pricing page](https://elevenlabs.io/pricing) and subscribe to an API plan that suits your needs.
1414
</Step>
1515
<Step title="Retrieve your API key">
16-
Go to the 'Profile + Keys' section on the 11labs website to get your API key.
16+
Go to the 'Profile + Keys' section on the ElevenLabs website to get your API key.
1717
</Step>
1818
<Step title="Enter your API key in Vapi">
19-
Navigate to the [Vapi Provider Key section](https://dashboard.vapi.ai/keys) and input your 11labs API key under the 11labs section.
19+
Navigate to the [Vapi Provider Key section](https://dashboard.vapi.ai/keys) and input your ElevenLabs API key under the ElevenLabs section.
2020

2121
Once you click save, your voice library will sync automatically.
2222
</Step>

‎fern/docs.yml

Lines changed: 3 additions & 60 deletions
Original file line numberDiff line numberDiff line change
@@ -125,40 +125,29 @@ navigation:
125125
contents:
126126
- page: Variables
127127
path: assistants/dynamic-variables.mdx
128-
icon: fa-light fa-square-root-variable
129128
- page: Multilingual support
130129
path: customization/multilingual.mdx
131-
icon: fa-light fa-globe
132130
- page: Personalization with user information
133131
path: assistants/personalization.mdx
134-
icon: fa-light fa-user-pen
135132
- page: Voice formatting plan
136133
path: assistants/voice-formatting-plan.mdx
137-
icon: fa-light fa-table-tree
138134
- page: Background messages
139135
path: assistants/background-messages.mdx
140-
icon: fa-light fa-message
141136
- page: Assistant hooks
142137
path: assistants/assistant-hooks.mdx
143-
icon: fa-light fa-webhook
144138
- section: Model configurations
145139
icon: fa-light fa-waveform-lines
146140
contents:
147141
- page: Speech configuration
148142
path: customization/speech-configuration.mdx
149-
icon: fa-light fa-microphone
150143
- page: Voice fallback plan
151144
path: voice-fallback-plan.mdx
152-
icon: fa-light fa-volume-high
153145
- page: OpenAI realtime speech-to-speech
154146
path: openai-realtime.mdx
155-
icon: fa-light fa-timer
156147
- page: Provider keys
157148
path: customization/provider-keys.mdx
158-
icon: fa-light fa-key
159149
- page: Custom transcriber
160150
path: customization/custom-transcriber.mdx
161-
icon: fa-light fa-microphone
162151
- page: Custom keywords
163152
path: customization/custom-keywords.mdx
164153
icon: fa-light fa-bullseye
@@ -177,13 +166,10 @@ navigation:
177166
contents:
178167
- page: Fine-tuned OpenAI models
179168
path: customization/custom-llm/fine-tuned-openai-models.mdx
180-
icon: fa-light fa-microchip-ai
181169
- page: Bring your own server
182170
path: customization/custom-llm/using-your-server.mdx
183-
icon: fa-light fa-server
184171
- page: Tool calling integration
185172
path: customization/custom-llm/tool-calling-integration.mdx
186-
icon: fa-light fa-toolbox
187173

188174
- section: Best practices
189175
contents:
@@ -208,12 +194,9 @@ navigation:
208194
contents:
209195
- page: SIP telephony
210196
path: advanced/sip/sip.mdx
211-
icon: fa-light fa-signal-stream
212197
- page: SIP trunking
213198
path: advanced/sip/sip-trunk.mdx
214-
icon: fa-light fa-route
215199
- section: Providers
216-
icon: fa-light fa-cubes
217200
contents:
218201
- page: Twilio
219202
path: advanced/sip/sip-twilio.mdx
@@ -267,42 +250,6 @@ navigation:
267250
path: knowledge-base/integrating-with-trieve.mdx
268251
icon: fa-light fa-brain
269252

270-
- section: Workflows
271-
path: workflows.mdx
272-
collapsed: true
273-
icon: fa-light fa-diagram-next
274-
contents:
275-
- section: Nodes
276-
icon: fa-light fa-share-nodes
277-
contents:
278-
- page: Say
279-
path: workflows/nodes/say.mdx
280-
icon: fa-light fa-volume-high
281-
- page: Gather
282-
path: workflows/nodes/gather.mdx
283-
icon: fa-light fa-clipboard-list
284-
- page: API Request
285-
path: workflows/nodes/api-request.mdx
286-
icon: fa-light fa-code
287-
- page: Assistant
288-
path: workflows/nodes/assistant.mdx
289-
icon: fa-light fa-clipboard-question
290-
- page: Transfer
291-
path: workflows/nodes/transfer.mdx
292-
icon: fa-light fa-arrow-right-arrow-left
293-
- page: Hangup
294-
path: workflows/nodes/hangup.mdx
295-
icon: fa-light fa-phone-xmark
296-
- section: Edges
297-
icon: fa-light fa-circle-nodes
298-
contents:
299-
- page: Logical Conditions
300-
path: workflows/edges/logical-conditions.mdx
301-
icon: fa-light fa-code
302-
- page: AI Conditions
303-
path: workflows/edges/ai-conditions.mdx
304-
icon: fa-light fa-brain-circuit
305-
306253
- section: Webhooks
307254
collapsed: true
308255
path: server-url.mdx
@@ -321,6 +268,7 @@ navigation:
321268
path: server-url/server-authentication.mdx
322269
icon: fa-light fa-key
323270

271+
324272
- section: Squads
325273
collapsed: true
326274
icon: fa-light fa-users
@@ -341,31 +289,24 @@ navigation:
341289
contents:
342290
- page: Outbound calls
343291
path: calls/call-outbound.mdx
344-
icon: fa-light fa-phone
345292
- page: WebSocket transport
346293
path: calls/websocket-transport.mdx
347-
icon: fa-light fa-plug
348294
- section: In-call control
349295
icon: fa-light fa-sliders
350296
contents:
351297
- page: Real-time call control
352298
path: calls/call-features.mdx
353-
icon: fa-light fa-ear-listen
354299
- page: Voicemail detection
355300
path: calls/voicemail-detection.mdx
356-
icon: fa-light fa-voicemail
357301
- section: Transfer calls
358302
icon: fa-light fa-phone-arrow-right
359303
contents:
360304
- page: Call forwarding
361305
path: call-forwarding.mdx
362-
icon: fa-light fa-phone-arrow-right
363306
- page: Dynamic call transfers
364307
path: calls/call-dynamic-transfers.mdx
365-
icon: fa-light fa-right-left
366308
- page: On-hold specialist transfer
367309
path: calls/call-handling-with-vapi-and-twilio.mdx
368-
icon: fa-light fa-headset
369310
- page: Call end reasons
370311
path: calls/call-ended-reason.mdx
371312
icon: fa-light fa-phone-hangup
@@ -556,6 +497,8 @@ navigation:
556497
icon: fa-light fa-shield-check
557498
collapsed: true
558499
contents:
500+
- page: JWT authentication
501+
path: customization/jwt-authentication.mdx
559502
- page: GDPR compliance
560503
path: security-and-privacy/GDPR.mdx
561504
- page: HIPAA compliance

0 commit comments

Comments
 (0)