You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
-**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:
-**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`)
-**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>
Copy file name to clipboardExpand all lines: fern/workflows.mdx
+11-11Lines changed: 11 additions & 11 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,6 +1,6 @@
1
1
---
2
2
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").
4
4
slug: workflows
5
5
---
6
6
@@ -25,7 +25,7 @@ Begin by creating an assistant on the Assistants page and providing the required
25
25
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.
26
26
27
27
### Step 4: Build Your Workflow
28
-
In the Workflow Builder, you will see a "Start" call node. Click the <iclassName="fa-solid fa-plus"></i> button at the bottom of this node to select your first verb. Use the <iclassName="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 <iclassName="fa-solid fa-plus"></i> button at the bottom of this node to select your first **task**. Use the <iclassName="fa-solid fa-plus"></i> button to add further steps as needed.
@@ -46,27 +46,27 @@ Begin by creating an assistant on the Assistants page and providing the required
46
46
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.
47
47
</Info>
48
48
49
-
## Available Verbs
49
+
## Available Tasks
50
50
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:
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.
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.
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.
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.
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.
Copy file name to clipboardExpand all lines: fern/workflows/tasks/api-request.mdx
+4-4Lines changed: 4 additions & 4 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,12 +1,12 @@
1
1
---
2
-
title: API Request Verb
2
+
title: API Request Task
3
3
subtitle: Interface with external APIs
4
-
slug: /workflows/verbs/api-request
4
+
slug: /workflows/tasks/api-request
5
5
---
6
6
7
7
## Overview
8
8
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.
10
10
11
11
## Configuration
12
12
@@ -22,4 +22,4 @@ The **API Request** verb enables your workflow to interact with external APIs. I
22
22
23
23
## Usage
24
24
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.
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.
10
10
11
11
## Configuration
12
12
@@ -18,4 +18,4 @@ Define one or more variables to gather from the user with:
18
18
19
19
## Usage
20
20
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.
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.
10
10
11
11
## Configuration
12
12
@@ -15,4 +15,4 @@ The **Say** verb outputs a spoken message to the user without expecting a respon
15
15
16
16
## Usage
17
17
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.
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.
10
10
11
11
## Configuration
12
12
13
13
-**Phone Number:** Enter a valid destination number for the call transfer.
14
14
15
15
## Usage
16
16
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.
0 commit comments