Skip to content

Commit 714deb4

Browse files
docs: add OpenAI Realtime API (#28)
* add realtime api docs * nits
1 parent 1b4a9e6 commit 714deb4

File tree

2 files changed

+18
-0
lines changed

2 files changed

+18
-0
lines changed

fern/docs.yml

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -242,6 +242,8 @@ navigation:
242242
path: tools-calling.mdx
243243
- page: Prompting Guide
244244
path: prompting-guide.mdx
245+
- page: OpenAI Realtime
246+
path: openai-realtime.mdx
245247
- section: Glossary
246248
contents:
247249
- page: Definitions

fern/openai-realtime.mdx

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
---
2+
title: OpenAI Realtime
3+
subtitle: You can use OpenAI's newest speech-to-speech model with your Vapi assistants.
4+
slug: openai-realtime
5+
---
6+
7+
<Note>
8+
The Realtime API is currently in beta, and not recommended for production use by OpenAI. We're excited to have you try this new feature and welcome your [feedback](https://discord.com/invite/pUFNcf2WmH) as we continue to refine and improve the experience.
9+
</Note>
10+
11+
OpenAI’s Realtime API enables developers to use a native speech-to-speech model. Unlike other Vapi configurations which orchestrate a transcriber, model and voice API to simulate speech-to-speech, OpenAI’s Realtime API natively processes audio in and audio out.
12+
13+
To start using it with your Vapi assistants, select `gpt-4o-realtime-preview-2024-10-01` as your model.
14+
- Please note that only OpenAI voices may be selected while using this model. The voice selection will not act as a TTS (text-to-speech) model, but rather as the voice used within the speech-to-speech model.
15+
- Also note that we don’t currently support Knowledge Bases with the Realtime API.
16+
- Lastly, note that our Realtime integration still retains the rest of Vapi's orchestration layer such as the endpointing and interruption models to enable a reliable conversational flow.

0 commit comments

Comments
 (0)