Skip to content

Commit e7b7a8f

Browse files
committed
Merge remote-tracking branch 'origin/main' into fern/update-api-specs
2 parents fb09c09 + 6e1e2d2 commit e7b7a8f

File tree

10 files changed

+117
-51
lines changed

10 files changed

+117
-51
lines changed

fern/changelog/2025-02-17.mdx

Lines changed: 66 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,66 @@
1+
## What's New
2+
3+
### Compliance & Security Enhancements
4+
- **New [CompliancePlan](https://api.vapi.ai/api#:~:text=CompliancePlan) Consolidates HIPAA and PCI Compliance Settings**: You should now enable HIPAA and PCI compliance settings with `Assistant.compliancePlan.hipaaEnabled` and `Assistant.compliancePlan.pciEnabled` which both default to `false` (replacing the old HIPAA and PCI flags on `Assistant` and `AssistantOverrides`).
5+
6+
- **Phone Number Status Tracking**: You can now view your phone number `status` with `GET /phone-number/{id}` for all phone number types ([Bring Your Own Number](https://api.vapi.ai/api#:~:text=ByoPhoneNumber), [Vapi](https://api.vapi.ai/api#:~:text=VapiPhoneNumber), [Twilio](https://api.vapi.ai/api#:~:text=TwilioPhoneNumber), [Vonage](https://api.vapi.ai/api#:~:text=VonagePhoneNumber)) for better monitoring.
7+
8+
### Advanced Call Control
9+
10+
- **Assistant Hooks System**: You can now use [`AssistantHooks`](https://api.vapi.ai/api#:~:text=AssistantHooks) to support `call.ending` events with customizable filters and actions
11+
- Enable transfer actions through [`TransferAssistantHookAction`](https://api.vapi.ai/api#:~:text=TransferAssistantHookAction). For example:
12+
```javascript
13+
{
14+
"hooks": [{
15+
"on": "call.ending",
16+
"do": [{
17+
"type": "transfer",
18+
"destination": {
19+
// Your transfer configuration
20+
}
21+
}]
22+
}]
23+
}
24+
```
25+
26+
- Conditionally execute hooks with `Assistant.hooks.filter`. For example, trigger different hooks for call completed, system errors, or customer hangup / transfer:
27+
28+
```json
29+
{
30+
"assistant": {
31+
"hooks": [{
32+
"filters": [{
33+
"type": "oneOf",
34+
"key": "call.endedReason",
35+
"oneOf": ["pipeline-error-custom-llm-500-server-error", "pipeline-error-custom-llm-llm-failed"]
36+
}]
37+
}
38+
]
39+
}
40+
}
41+
```
42+
43+
### Model & Voice Updates
44+
45+
- **New Models Added**: You can now use new models inside `Assistant.model[provider="google", "openai", "xai"]` and `Assistant.fallbackModels[provider="google", "openai", "xai"]`
46+
- Google: Gemini 2.0 series (`flash-thinking-exp`, `pro-exp-02-05`, `flash`, `flash-lite-preview`)
47+
- OpenAI: o3 mini `o3-mini`
48+
- xAI: Grok 2 `grok-2`
49+
50+
<Frame caption="Assistant Models">
51+
<img src="../static/images/changelog/assistant-models.png" alt="New Assistant Models" />
52+
</Frame>
53+
54+
- **New `PlayDialog` Model for [PlayHT Voices](https://api.vapi.ai/api#:~:text=PlayHTVoice)**: You can now use the `PlayDialog` model in `Assistant.voice[provider="playht"].model["PlayDialog"]`.
55+
56+
- **New `nova-3` and `nova-3-general` Models for [Deepgram Transcriber](https://api.vapi.ai/api#:~:text=DeepgramTranscriber)**: You can now use the `nova-3` and `nova-3-general` models in `Assistant.transcriber[provider="deepgram"].model["nova-3", "nova-3-general"]`
57+
58+
### API Improvements
59+
60+
- **Workflow Updates**: You can now send a [`workflow.node.started`](https://api.vapi.ai/api#:~:text=ClientMessageWorkflowNodeStarted) message to track the start of a workflow node for better call flow tracking
61+
62+
- **Analytics Enhancement**: Added subscription table and concurrency columns in [POST /analytics](https://api.vapi.ai/api#/Analytics/AnalyticsController_query) for richer queries about your subscriptions and concurrent calls.
63+
64+
### Deprecations
65+
66+
<Warning>The `/logs` endpoints are now marked as deprecated - plan to update your implementation accordingly.</Warning>

fern/docs.yml

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -138,18 +138,18 @@ navigation:
138138
- section: Workflows
139139
path: workflows.mdx
140140
contents:
141-
- section: Verbs
141+
- section: Tasks
142142
contents:
143143
- page: Say
144-
path: workflows/verbs/say.mdx
144+
path: workflows/tasks/say.mdx
145145
- page: Gather
146-
path: workflows/verbs/gather.mdx
146+
path: workflows/tasks/gather.mdx
147147
- page: API Request
148-
path: workflows/verbs/api-request.mdx
148+
path: workflows/tasks/api-request.mdx
149149
- page: Transfer
150-
path: workflows/verbs/transfer.mdx
150+
path: workflows/tasks/transfer.mdx
151151
- page: Hangup
152-
path: workflows/verbs/hangup.mdx
152+
path: workflows/tasks/hangup.mdx
153153
- section: Conditions
154154
contents:
155155
- page: Logical Conditions
@@ -185,9 +185,9 @@ navigation:
185185
- page: Silent Transfers
186186
path: squads/silent-transfers.mdx
187187
- section: Test
188+
hidden: true
188189
contents:
189190
- page: Manual Testing
190-
hidden: true
191191
path: test/manual-testing.mdx
192192
- page: Voice AI Testing
193193
path: test/voice-testing.mdx
53.2 KB
Loading

fern/workflows.mdx

Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
---
22
title: Introduction to Workflows
3-
subtitle: Break down AI conversations into a visual workflow made up of discrete steps ("verbs") and branches between them ("conditions").
3+
subtitle: Break down AI conversations into a visual workflow made up of discrete steps ("tasks") and branches between them ("conditions").
44
slug: workflows
55
---
66

@@ -25,7 +25,7 @@ Begin by creating an assistant on the Assistants page and providing the required
2525
Click the "Create Workflow" button. A prompt will appear asking you to create a new workflow by entering a unique title, or attach to an existing workflow.
2626

2727
### Step 4: Build Your Workflow
28-
In the Workflow Builder, you will see a "Start" call node. Click the <i className="fa-solid fa-plus"></i> button at the bottom of this node to select your first verb. Use the <i className="fa-solid fa-plus"></i> button to add further steps as needed.
28+
In the Workflow Builder, you will see a "Start" call node. Click the <i className="fa-solid fa-plus"></i> button at the bottom of this node to select your first **task**. Use the <i className="fa-solid fa-plus"></i> button to add further steps as needed.
2929

3030
<Frame background="subtle">
3131
<img src="./static/images/workflows/workflow-builder-example.png" alt="Workflow Builder Interface" />
@@ -46,27 +46,27 @@ Begin by creating an assistant on the Assistants page and providing the required
4646
Please let us know about any bugs you find by [submitting a bug report](https://roadmap.vapi.ai/bug-reports). We also welcome feature requests and suggestions - you can [submit those here](https://roadmap.vapi.ai/feature-requests). For discussions about workflows and our product roadmap, please [join our Discord community](https://discord.com/invite/pUFNcf2WmH) to connect with our team.
4747
</Info>
4848

49-
## Available Verbs
49+
## Available Tasks
5050

51-
Workflows break down your AI voice agent's behavior into discrete, manageable actions called verbs. Each verb encapsulates a specific function within the conversation flow. Detailed configuration options let you tailor each step to your requirements. The available verbs are:
51+
Workflows break down your AI voice agent's behavior into discrete, manageable actions called **tasks**. Each **task** encapsulates a specific function within the conversation flow. Detailed configuration options let you tailor each step to your requirements. The available tasks are:
5252

5353
<CardGroup cols={2}>
54-
<Card title="Say" icon="message" href="/workflows/verbs/say">
55-
Outputs a message to the user without expecting a response. Configure this verb by specifying static text or providing a prompt for the LLM to generate dynamic text.
54+
<Card title="Say" icon="message" href="/workflows/tasks/say">
55+
Outputs a message to the user without expecting a response. Configure this **task** by specifying static text or providing a prompt for the LLM to generate dynamic text.
5656
</Card>
57-
<Card title="Gather" icon="microphone" href="/workflows/verbs/gather">
57+
<Card title="Gather" icon="microphone" href="/workflows/tasks/gather">
5858
Collects input from the user. Define the variables by specifying a name, a detailed description of the expected input, and the data type (string, number, or boolean). Mark each variable as required or optional.
5959
</Card>
6060
<Card title="Ask (Coming Soon)" icon="question-circle">
6161
Asks a question and uses AI conditions to evaluate the response and determine the next step. This enables natural conversational flow without needing to explicitly gather variables, as the AI interprets the semantic meaning of responses.
6262
</Card>
63-
<Card title="API Request" icon="code" href="/workflows/verbs/apiRequest">
63+
<Card title="API Request" icon="code" href="/workflows/tasks/apiRequest">
6464
Makes calls to external APIs using GET or POST methods. Configure request headers and body, and define extraction rules to capture specific data from the JSON response. Optionally, enable asynchronous execution so that the workflow proceeds while awaiting the API response.
6565
</Card>
66-
<Card title="Transfer" icon="phone-arrow-right" href="/workflows/verbs/transfer">
66+
<Card title="Transfer" icon="phone-arrow-right" href="/workflows/tasks/transfer">
6767
Transfers the active call to an external phone number. Ensure you provide a valid phone number in the configuration.
6868
</Card>
69-
<Card title="Hangup" icon="phone-slash" href="/workflows/verbs/hangup">
69+
<Card title="Hangup" icon="phone-slash" href="/workflows/tasks/hangup">
7070
Terminates the call, signaling the end of the conversation.
7171
</Card>
7272
</CardGroup>
@@ -84,4 +84,4 @@ Conditions allow you to create branching paths in your workflow based on differe
8484
</Card>
8585
</CardGroup>
8686

87-
For detailed configuration instructions and advanced settings, please refer to our dedicated documentation pages for each verb.
87+
For detailed configuration instructions and advanced settings, please refer to our dedicated documentation pages for each task.

fern/workflows/verbs/api-request.mdx renamed to fern/workflows/tasks/api-request.mdx

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,12 @@
11
---
2-
title: API Request Verb
2+
title: API Request Task
33
subtitle: Interface with external APIs
4-
slug: /workflows/verbs/api-request
4+
slug: /workflows/tasks/api-request
55
---
66

77
## Overview
88

9-
The **API Request** verb enables your workflow to interact with external APIs. It supports both GET and POST methods, allowing the integration of external data and services.
9+
The **API Request** task enables your workflow to interact with external APIs. It supports both GET and POST methods, allowing the integration of external data and services.
1010

1111
## Configuration
1212

@@ -22,4 +22,4 @@ The **API Request** verb enables your workflow to interact with external APIs. I
2222

2323
## Usage
2424

25-
Use the API Request verb to fetch information from an external API to use in your workflow, or to update information in your CRM or database. API Requests take on the functionality of [tool calls](/tools/introduction) from single-prompt assistants.
25+
Use the API Request task to fetch information from an external API to use in your workflow, or to update information in your CRM or database. API Requests take on the functionality of [tool calls](/tools/introduction) from single-prompt assistants.
Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,12 @@
11
---
2-
title: Gather Verb
2+
title: Gather Task
33
subtitle: Collect input from users
4-
slug: /workflows/verbs/gather
4+
slug: /workflows/tasks/gather
55
---
66

77
## Overview
88

9-
The **Gather** verb collects input from users during an interaction. It is used to capture variables that will be referenced later in your workflow.
9+
The **Gather** task collects input from users during an interaction. It is used to capture variables that will be referenced later in your workflow.
1010

1111
## Configuration
1212

@@ -18,4 +18,4 @@ Define one or more variables to gather from the user with:
1818

1919
## Usage
2020

21-
Use the Gather verb when you need to prompt users for information—such as their name, email, or ZIP code—that will drive subsequent conversation steps.
21+
Use the Gather task when you need to prompt users for information—such as their name, email, or ZIP code—that will drive subsequent conversation steps.

fern/workflows/tasks/hangup.mdx

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
---
2+
title: Hangup Task
3+
subtitle: Terminate the call
4+
slug: /workflows/tasks/hangup
5+
---
6+
7+
## Overview
8+
9+
The **Hangup** task ends an active call, marking the conclusion of a conversation. It is typically used as the final step in your workflow.
10+
11+
## Configuration
12+
13+
This task requires little to no configuration, as its purpose is solely to terminate the call.
14+
15+
## Usage
16+
17+
Place the Hangup task at the end of your workflow to close the conversation gracefully.
Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,12 @@
11
---
2-
title: Say Verb
2+
title: Say Task
33
subtitle: Output a message to the user
4-
slug: /workflows/verbs/say
4+
slug: /workflows/tasks/say
55
---
66

77
## Overview
88

9-
The **Say** verb outputs a spoken message to the user without expecting a response. Use this verb to provide instructions, notifications, or other information during a call.
9+
The **Say** task outputs a spoken message to the user without expecting a response. Use this task to provide instructions, notifications, or other information during a call.
1010

1111
## Configuration
1212

@@ -15,4 +15,4 @@ The **Say** verb outputs a spoken message to the user without expecting a respon
1515

1616
## Usage
1717

18-
Add the Say verb when you need to deliver clear, concise information to your user. It works well as an initial greeting or when confirming actions.
18+
Add the Say task when you need to deliver clear, concise information to your user. It works well as an initial greeting or when confirming actions.
Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,17 +1,17 @@
11
---
2-
title: Transfer Call Verb
2+
title: Transfer Call Task
33
subtitle: Redirect calls to an external number
4-
slug: /workflows/verbs/transfer
4+
slug: /workflows/tasks/transfer
55
---
66

77
## Overview
88

9-
The **Transfer Call** verb transfers an active call to a designated external phone number. This enables routing calls to other departments or external contacts.
9+
The **Transfer Call** task transfers an active call to a designated external phone number. This enables routing calls to other departments or external contacts.
1010

1111
## Configuration
1212

1313
- **Phone Number:** Enter a valid destination number for the call transfer.
1414

1515
## Usage
1616

17-
Use the Transfer Call verb to escalate or redirect a call as needed. Ensure the provided phone number is formatted correctly for a smooth transfer experience.
17+
Use the Transfer Call task to escalate or redirect a call as needed. Ensure the provided phone number is formatted correctly for a smooth transfer experience.

fern/workflows/verbs/hangup.mdx

Lines changed: 0 additions & 17 deletions
This file was deleted.

0 commit comments

Comments
 (0)