Skip to content

Commit 8426b5a

Browse files
committed
add workflows section
1 parent 7827414 commit 8426b5a

File tree

13 files changed

+49
-16
lines changed

13 files changed

+49
-16
lines changed

fern/assistants.mdx

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,12 @@
11
---
2-
title: Introduction
2+
title: Introduction to Assistants
33
subtitle: The core building-block of voice agents on Vapi.
44
slug: assistants
55
---
66

7-
**Assistant** is a fancy word for an AI configuration that can be used across phone calls and Vapi clients. Your voice assistant can augment your customer support and
8-
experience for call centers, business websites, mobile apps, and much more.
7+
[**Assistant**](/api-reference/assistants/create) is a fancy word for an AI configuration that can be used across phone calls and Vapi clients. Your voice assistant can augment your customer support and experience for call centers, business websites, mobile apps, and much more.
8+
9+
<EndpointResponseSnippet endpoint='POST /assistant' />
910

1011
## Core Components
1112

@@ -18,7 +19,7 @@ There are three core components that make up an assistant:
1819
These components can be configured, mixed, and matched for your specific use case.
1920

2021
<Info>
21-
View all configurable properties in the [API Reference](/api-reference/assistants/create-assistant)
22+
View all configurable properties in the [API Reference](/api-reference/assistants/create-assistant).
2223
</Info>
2324

2425
## Key Features

fern/blocks.mdx

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,14 @@
11
---
2-
title: Introduction
2+
title: Introduction to Blocks
33
subtitle: Breaking down bot conversations into smaller, more manageable prompts
44
slug: blocks
55
---
66

7+
<Warning>
8+
**Blocks** is being deprecated in favor of [Workflows](/workflows). We recommend using Workflows for all new development as it provides a more powerful and flexible way to structure conversational AI. We're working on migration tools to help transition existing Blocks implementations to Workflows.
9+
</Warning>
710

8-
9-
We're currently running a beta for **Blocks**, an upcoming feature from [Vapi.ai](http://vapi.ai/) aimed at improving bot conversations. The problem we've noticed is that single LLM prompts are prone to hallucinations, unreliable tool calls, and can’t handle many-step complex instructions.
11+
We're currently running a beta for [**Blocks**](/api-reference/blocks/create), an upcoming feature from [Vapi.ai](http://vapi.ai/) aimed at improving bot conversations. The problem we've noticed is that single LLM prompts are prone to hallucinations, unreliable tool calls, and can’t handle many-step complex instructions.
1012

1113
**By breaking the conversation into smaller, more manageable prompts**, we can guarantee the bot will do this, then that, or if this happens, then that happens. It’s like having a checklist for conversations — less room for error, more room for getting things right.
1214

fern/docs.yml

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -138,6 +138,18 @@ navigation:
138138
- section: Workflows
139139
path: workflows.mdx
140140
contents:
141+
- section: Verbs
142+
contents:
143+
- page: Say
144+
path: workflows/verbs/say.mdx
145+
- page: Gather
146+
path: workflows/verbs/gather.mdx
147+
- page: API Request
148+
path: workflows/verbs/apiRequest.mdx
149+
- page: Transfer
150+
path: workflows/verbs/transfer.mdx
151+
- page: Hangup
152+
path: workflows/verbs/hangup.mdx
141153
- page: Tasks
142154
path: workflows/tasks.mdx
143155
- section: Blocks

fern/introduction.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
---
2-
title: Introduction
2+
title: Introduction to Vapi
33
subtitle: Vapi is the Voice AI platform for developers.
44
slug: introduction
55
---

fern/knowledge-base/knowledge-base.mdx

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
---
2-
title: Creating Custom Knowledge Bases for Your Voice AI Assistants
2+
title: Introduction to Knowledge Bases
33
subtitle: >-
44
Learn how to create and integrate custom knowledge bases into your voice AI
55
assistants.
@@ -8,7 +8,7 @@ slug: knowledge-base
88

99
## **What is Vapi's Knowledge Base?**
1010

11-
A Knowledge Base is a collection of custom files that contain information on specific topics or domains. By integrating a Knowledge Base into your voice AI assistant, you can enable it to provide more accurate and informative responses to user queries. This is currently available in Vapi via the API, and will be on the dashboard soon.
11+
A [**Knowledge Base**](/api-reference/knowledge-bases/create) is a collection of custom files that contain information on specific topics or domains. By integrating a Knowledge Base into your voice AI assistant, you can enable it to provide more accurate and informative responses to user queries. This is currently available in Vapi via the API, and will be on the dashboard soon.
1212

1313
### **Why Use a Knowledge Base?**
1414

@@ -18,6 +18,10 @@ Using a Knowledge Base with your voice AI assistant offers several benefits:
1818
- **Enhanced capabilities**: A Knowledge Base enables your assistant to answer complex queries and provide detailed responses to user inquiries.
1919
- **Customization**: With a Knowledge Base, you can tailor your assistant's responses to specific domains or topics, making it more effective and informative.
2020

21+
<Info>
22+
Knowledge Bases are configured through the API, view all configurable properties in the [API Reference](/api-reference/knowledge-bases/create-knowledge-base).
23+
</Info>
24+
2125
## **How to Create a Knowledge Base**
2226

2327
To create a Knowledge Base, follow these steps:

fern/squads.mdx

Lines changed: 6 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,17 +1,20 @@
11
---
2-
title: Squads
2+
title: Introduction to Squads (Multi-Assistant Conversations)
33
subtitle: Use Squads to handle complex workflows and tasks.
44
slug: squads
55
---
66

7-
87
Sometimes, complex workflows are easier to manage with multiple assistants.
98
You can think of each assistant in a Squad as a leg of a conversation tree.
109
For example, you might have one assistant for lead qualification, which transfers to another for booking an appointment if they’re qualified.
1110

1211
Prior to Squads you would put all functionality in one assistant, but Squads were added to break up the complexity of larger prompts into smaller specialized assistants with specific tools and fewer goals.
1312
Squads enable calls to transfer assistants mid-conversation, while maintaining full conversation context.
1413

14+
<Info>
15+
View all configurable properties in the [API Reference](/api-reference/squads/create-squad).
16+
</Info>
17+
1518
## Usage
1619

1720
To use Squads, you can create a `squad` when starting a call and specify `members` as a list of assistants and destinations.
@@ -45,7 +48,7 @@ Transfers are specified by assistant name and are used when the model recognizes
4548
```
4649

4750

48-
## Best practices
51+
## Best Practices
4952

5053
The following are some best practices for using Squads to reduce errors:
5154

fern/tools/introduction.mdx

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,10 @@
11
---
2-
title: Introduction
2+
title: Introduction to Tools
33
subtitle: Extend your assistant's capabilities with powerful function calling tools.
44
slug: tools
55
---
66

7-
**Tools** allow your assistant to take actions beyond just conversation. They enable your assistant to perform tasks like transferring calls, accessing external data, or triggering actions in your application. Tools can be either built-in default tools provided by Vapi or custom tools that you create.
7+
[**Tools**](/api-reference/tools/create) allow your assistant to take actions beyond just conversation. They enable your assistant to perform tasks like transferring calls, accessing external data, or triggering actions in your application. Tools can be either built-in default tools provided by Vapi or custom tools that you create.
88

99
There are three types of tools available:
1010

@@ -13,7 +13,7 @@ There are three types of tools available:
1313
3. **Integration Tools**: Pre-built integrations with platforms like [Make](https://www.make.com/en/integrations/vapi) and GoHighLevel (GHL) that let you trigger automated workflows via voice.
1414

1515
<Info>
16-
Tools are configured as part of your assistant's model configuration. You can find the complete API reference [here](/api-reference/assistants/create-assistant).
16+
Tools are configured as part of your assistant's model configuration. You can find the complete API reference [here](/api-reference/tools/create-tool).
1717
</Info>
1818

1919
## Available Tools

fern/workflows.mdx

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
---
2+
title: Introduction to Workflows
3+
subtitle: Breaking down AI conversations into discrete steps
4+
slug: workflows
5+
---
6+
7+
<Success intent="launch">
8+
Workflows is now available to all Vapi users. Start building more reliable and structured conversational AI today.
9+
</Success>
10+
11+
Workflows is a new way to build conversational AI. It allows you to break down AI conversations into discrete steps, and then orchestrate those steps in a way that is easy to manage and modify.

fern/workflows/verbs/apiRequest.mdx

Whitespace-only changes.

fern/workflows/verbs/gather.mdx

Whitespace-only changes.

0 commit comments

Comments
 (0)