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
Copy file name to clipboardExpand all lines: README.md
+12-12Lines changed: 12 additions & 12 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -8,14 +8,14 @@ A complete starter project for building voice AI apps with [LiveKit Agents for N
8
8
9
9
The starter project includes:
10
10
11
-
- A simple voice AI assistant based on the [AI Voice Assistant quickstart](https://docs.livekit.io/agents/v0/quickstarts/voice-agent/)
12
-
- Voice AI pipeline based on [OpenAI](https://docs.livekit.io/agents/v0/integrations/openai/overview/#llm), [Cartesia](https://docs.livekit.io/agents/v0/integrations/cartesia/#tts), and [Deepgram](https://docs.livekit.io/agents/v0/integrations/deepgram/#stt)
13
-
- Easily integrate your preferred [LLM](https://docs.livekit.io/agents/v0/integrations/overview/#llm-integrations), [STT](https://docs.livekit.io/agents/v0/integrations/overview/#stt-integrations), and [TTS](https://docs.livekit.io/agents/v0/integrations/overview/#tts-integrations) instead, or swap to a realtime model like the [OpenAI Realtime API](https://docs.livekit.io/agents/v0/integrations/openai/realtime/)
14
-
-[LiveKit Turn Detector](https://docs.livekit.io/agents/v0/voice-agent/#turn-detection-model) for contextually-aware speaker detection, with multilingual support
11
+
- A simple voice AI assistant based on the [AI Voice Assistant quickstart](https://docs.livekit.io/agents/start/voice-ai/)
12
+
- Voice AI pipeline based on [OpenAI](https://docs.livekit.io/agents/integrations/llm/openai/), [Cartesia](https://docs.livekit.io/agents/integrations/tts/cartesia/), and [Deepgram](https://docs.livekit.io/agents/integrations/stt/deepgram/)
13
+
- Easily integrate your preferred [LLM](https://docs.livekit.io/agents/integrations/llm/), [STT](https://docs.livekit.io/agents/integrations/stt/), and [TTS](https://docs.livekit.io/agents/integrations/tts/) instead, or swap to a realtime model like the [OpenAI Realtime API](https://docs.livekit.io/agents/integrations/realtime/openai)
14
+
-[LiveKit Turn Detector](https://docs.livekit.io/agents/build/turns/turn-detector/) for contextually-aware speaker detection, with multilingual support
- Integrated [metrics and logging](https://docs.livekit.io/agents/v0/build/metrics/)
17
17
18
-
This starter app is compatible with any [custom web/mobile frontend](https://docs.livekit.io/agents/v0/voice-agent/client-apps/) or [SIP-based telephony](https://docs.livekit.io/agents/v0/voice-agent/telephony/).
18
+
This starter app is compatible with any [custom web/mobile frontend](https://docs.livekit.io/agents/start/frontend/) or [SIP-based telephony](https://docs.livekit.io/agents/start/telephony/).
19
19
20
20
## Dev Setup
21
21
@@ -33,9 +33,9 @@ Set up the environment by copying `.env.example` to `.env.local` and filling in
33
33
-`LIVEKIT_URL`: Use [LiveKit Cloud](https://cloud.livekit.io/) or [run your own](https://docs.livekit.io/home/self-hosting/)
34
34
-`LIVEKIT_API_KEY`
35
35
-`LIVEKIT_API_SECRET`
36
-
-`OPENAI_API_KEY`: [Get a key](https://platform.openai.com/api-keys) or use your [preferred LLM provider](https://docs.livekit.io/agents/v0/integrations/overview/#llm-integrations)
37
-
-`DEEPGRAM_API_KEY`: [Get a key](https://console.deepgram.com/) or use your [preferred STT provider](https://docs.livekit.io/agents/v0/integrations/overview/#stt-integrations)
38
-
-`CARTESIA_API_KEY`: [Get a key](https://play.cartesia.ai/keys) or use your [preferred TTS provider](https://docs.livekit.io/agents/v0/integrations/overview/#tts-integrations)
36
+
-`OPENAI_API_KEY`: [Get a key](https://platform.openai.com/api-keys) or use your [preferred LLM provider](https://docs.livekit.io/agents/integrations/llm/)
37
+
-`DEEPGRAM_API_KEY`: [Get a key](https://console.deepgram.com/) or use your [preferred STT provider](https://docs.livekit.io/agents/integrations/stt/)
38
+
-`CARTESIA_API_KEY`: [Get a key](https://play.cartesia.ai/keys) or use your [preferred TTS provider](https://docs.livekit.io/agents/integrations/tts/)
39
39
40
40
You can load the LiveKit environment automatically using the [LiveKit CLI](https://docs.livekit.io/home/cli/cli-setup):
41
41
@@ -45,7 +45,7 @@ lk app env -w .env.local
45
45
46
46
## Run the agent
47
47
48
-
Before your first run, you must download certain models such as [Silero VAD](https://docs.livekit.io/agents/v0/voice-agent/#voice-activity-detection-vad-/) and the [LiveKit turn detector](https://docs.livekit.io/agents/v0/voice-agent/#turn-detection-model):
48
+
Before your first run, you must download certain models such as [Silero VAD](https://docs.livekit.io/agents/integrations/vad/) and the [LiveKit turn detector](https://docs.livekit.io/agents/build/turns/turn-detector/):
49
49
50
50
```console
51
51
pnpm run download-files
@@ -75,9 +75,9 @@ Get started quickly with our pre-built frontend starter apps, or add telephony s
75
75
|**React Native**|[`livekit-examples/voice-assistant-react-native`](https://github.com/livekit-examples/voice-assistant-react-native)| Native mobile app with React Native & Expo |
76
76
|**Android**|[`livekit-examples/agent-starter-android`](https://github.com/livekit-examples/agent-starter-android)| Native Android app with Kotlin & Jetpack Compose |
77
77
|**Web Embed**|[`livekit-examples/agent-starter-embed`](https://github.com/livekit-examples/agent-starter-embed)| Voice AI widget for any website |
78
-
|**Telephony**|[📚 Documentation](https://docs.livekit.io/agents/v0/voice-agent/telephony/)| Add inbound or outbound calling to your agent |
78
+
|**Telephony**|[📚 Documentation](https://docs.livekit.io/agents/start/telephony/)| Add inbound or outbound calling to your agent |
79
79
80
-
For advanced customization, see the [complete frontend guide](https://docs.livekit.io/agents/v0/voice-agent/client-apps/).
80
+
For advanced customization, see the [complete frontend guide](https://docs.livekit.io/agents/start/frontend/).
81
81
82
82
## Using this template repo for your own project
83
83
@@ -89,7 +89,7 @@ Once you've started your own project based on this repo, you should:
89
89
90
90
## Deploying to production
91
91
92
-
This project is production-ready and includes a working `Dockerfile`. To deploy it to LiveKit Cloud or another environment, see the [deploying to production](https://docs.livekit.io/agents/v0/deployment/) guide.
92
+
This project is production-ready and includes a working `Dockerfile`. To deploy it to LiveKit Cloud or another environment, see the [deploying to production](https://docs.livekit.io/agents/ops/deployment/) guide.
0 commit comments