LiveKit docs llms.txt · AI Docs Browser · mdream
[llms.txt Tools](https://mdream.dev/llms-txt/livekit/llms-txt)
# LiveKit docs llms.txt
Browse LiveKit docs documentation as markdown. Click any page in the sidebar to view it, or copy the full llms.txt for your AI tools.
docs.livekit.io/llms.txt
[Raw llms.txt](https://docs.livekit.io/llms.txt) [Raw llms-full.txt](https://docs.livekit.io/llms-full.txt)
Copy Markdown [](https://docs.livekit.io/llms.txt)
llms.txt
Overview
LiveKit Cloud
plugin system
Web
Swift
Android
Flutter
React Native
Unity
Python
Node.js
Rust
C++
ESP32
Ingress
Introduction
Overview
About LiveKit
Coding agent support
LiveKit 101 video course
Community resources
Overview
LiveKit CLI
LiveKit Cloud
Connecting to LiveKit
Overview
Room management
Participant management
Track management
Webhooks & events
Building AI agents
Room service API
Recipes
Build Agents
Introduction
Voice AI quickstart
Agent Builder
Agent Console
Agent Embed Widget
Prompting guide
Overview
Overview
Audio customization
Background audio
Wakeword detection
Text & transcriptions
Modality-aware instructions
Overview
Images
Video
Overview
Agent sessions
Chat context
Tasks & task groups
Workflows
Supervisor pattern
Overview
Function tools
Toolsets
Async tools
Model Context Protocol (MCP)
Forwarding to the frontend
Tool loop design
Pipeline nodes & hooks
Overview
Turn detector
Adaptive interruption handling
Silero VAD plugin
Turn-taking tuning
Agents & handoffs
External data & RAG
Fallback strategies
Overview
Test framework
Overview
GetNameTask
GetEmailTask
GetAddressTask
GetDOBTask
GetPhoneNumberTask
GetCreditCardTask
GetDtmfTask
WarmTransferTask
Overview
EndCallTool
send_dtmf_events
Overview
Startup modes
Server lifecycle
Agent dispatch
Job lifecycle
Server options
Overview
Pipeline types
LiveKit Inference
Overview
Hosted by LiveKit
DeepSeek
Gemini
Kimi
OpenAI
xAI
Anthropic
Amazon Bedrock
Baseten
Cerebras
Fireworks
Groq
LangChain
Letta
Mistral AI
Ollama
Azure OpenAI
OpenRouter
OVHCloud
Perplexity
Sarvam
Telnyx
Together AI
OpenAI-compatible LLMs
Overview
Speechmatics
AssemblyAI
Cartesia
Deepgram
ElevenLabs
xAI
Amazon Transcribe
Azure AI Speech
Azure OpenAI
Baseten
Clova
fal
Gladia
Gnani
Google Cloud
Gradium
Groq
Inworld
Mistral AI
Nvidia
OpenAI
OVHCloud
Sarvam
Simplismart
SLNG
Smallest AI
Soniox
Spitch
Overview
Cartesia
Deepgram
ElevenLabs
Fish Audio
Inworld
Rime
xAI
AsyncAI
Amazon Polly
Azure AI Speech
Azure OpenAI
Baseten
Camb.ai
Gemini
Gnani
Google Cloud
Gradium
Groq
Hume
Kokoro
LMNT
MiniMax
Mistral AI
Murf AI
Neuphonic
Nvidia
OpenAI
Resemble AI
Respeecher
Sarvam
Simplismart
SLNG
Smallest AI
Soniox
Speechify
Speechmatics
Spitch
Custom voices
Overview
Gemini Live API
Amazon Nova Sonic
OpenAI Realtime API
Azure OpenAI Realtime API
NVIDIA PersonaPlex
Phonic Speech-to-speech
Ultravox Realtime
xAI Grok Voice Agent API
Overview
Anam
Avatario
AvatarTalk
Beyond Presence
bitHuman
D-ID
Hedra
Keyframe
LemonSlice
LiveAvatar
Protoface
Runway
Simli
Tavus
TruGen
Overview
OpenAI LLM
Realtime API
OpenAI TTS
OpenAI STT
Overview
Gemini LLM
Gemini Live API
Gemini TTS
Google Cloud TTS
Google Cloud STT
Overview
Azure AI Speech TTS
Azure AI Speech STT
Azure OpenAI Realtime API
Azure OpenAI LLM
Azure OpenAI TTS
Azure OpenAI STT
Overview
Amazon Bedrock LLM
Amazon Polly TTS
Amazon Transcribe STT
Amazon Nova Sonic
Overview
Grok Voice Agent API
xAI LLM
xAI TTS
xAI STT
Overview
Groq LLM
Groq TTS
Groq STT
Cerebras
Agents framework
Turn handling options
Events and error handling
Agent dispatch service API
LiveKit CLI
Inference LLM parameters
Agent Frontends
Introduction
React voice agent quickstart
Overview
React
SwiftUI
Android
Flutter
React Native
Web embed
Overview
Session management
Overview
Token server
Token endpoints
Custom token generation
Agent state
Realtime media and data
Virtual avatars
Overview
Media controls
Prebuilt
Custom
Chat components
LiveKit SDKs
UI Component SDKs
Server APIs
Tokens & grants
Telephony
Introduction
Phone numbers
SIP trunk setup
Overview
Twilio
Telnyx
Plivo
Wavix
Sinch
Overview
WhatsApp
Twilio
Overview
DTMF
Answering machine detection
Region pinning
Overview
Call forwarding
Agent-assisted transfer
HD voice
Secure trunking
Overview
Workflow & setup
Inbound trunk
Dispatch rule
Twilio Voice integration
Overview
Workflow & setup
Outbound trunk
Outbound calls
Testing your setup
SIP primer
SIP participant
SIP handshake
Codecs negotiation & support
Phone Numbers API
SIP API
Server APIs
Connectors API
Troubleshooting
WebRTC Transport
Introduction
Overview
React
Unity (WebGL)
Swift
Android (Compose)
Android
Flutter
React Native
Expo
C++
Overview
Camera & microphone
Screen sharing
Subscribing to tracks
Processing raw tracks
Frame metadata
Noise & echo cancellation
Codecs & more
Overview
Overview
RoomComposite & web egress
Participant & TrackComposite egress
Track egress
Auto egress
Output & streaming options
Custom recording templates
Overview
Encoder configuration
Transcoding configuration
Overview
Sending text
Sending files & bytes
Remote procedure calls
Data tracks
Data packets
Overview
Participant attributes
Room metadata
Overview
Get started
E2EE with agents
Overview
Running locally
Deployment
Virtual machines
Kubernetes
Distributed multi-region
Firewall configuration
Benchmarks
Egress
Ingress
SIP server
LiveKit SDKs
Egress API
Ingress API
Server APIs
Manage & Deploy
Introduction
Overview
Quickstart
Deployment management
Secrets management
Logs
Log drains
Builds and Dockerfiles
Self-hosted deployments
Overview
Insights in LiveKit Cloud
Data hooks
Export traces
Overview
Overview
Region pinning
Agent deployment
Sandbox
Configuring firewalls
Quotas & limits
Billing
Analytics API
LiveKit CLI
Server APIs
Events and error handling
LiveKit SFU
Reference
Overview
Recipes
Access tokens & grants
Overview
Project commands
Agent commands
Docs search
Docs MCP server
Python
Node.js
Turn handling options
Events and error handling
Agent dispatch service API
Inference LLM parameters
JavaScript
Swift
Android
Flutter
React Native
Unity
Unity (WebGL)
Node.js
Rust
C++
Python
Go
ESP32
Agents UI (Shadcn)
React
SwiftUI
Android
Flutter
Go
Node
Rust
Ruby
Kotlin/Java
Python
PHP
LiveKit SFU
Signaling Protocol
SIP primer
SIP participant
SIP handshake
Codecs negotiation & support
SIP API
Phone Numbers API
Troubleshooting
Node.js
Python
Agents v1.x to v1.5 (Node.js)
SDK v1 to v2 migration
Room service API
Egress API
Egress examples
Ingress API
React Components
Installation
Best practices
Building blocks
LiveKitRoom component
Contexts
Loop components
Custom components
Style components
Rendering video tracks
Rendering audio tracks
useAgent
useAudioPlayback
useAudioWaveform
useChat
useChatToggle
useClearPinButton
useConnectionQualityIndicator
useConnectionState
useCreateLayoutContext
useDataChannel
useDisconnectButton
useEnsureCreateLayoutContext
useEnsureLayoutContext
useEnsureParticipant
useEnsureRoom
useEnsureSession
useEnsureTrackRef
useEvents
useFacingMode
useFocusToggle
useGridLayout
useIsEncrypted
useIsMuted
useIsRecording
useIsSpeaking
useKrispNoiseFilter
useLayoutContext
useLiveKitRoom
useLocalParticipant
useLocalParticipantPermissions
useMaybeLayoutContext
useMaybeParticipantContext
useMaybeRoomContext
useMaybeSessionContext
useMaybeTrackRefContext
useMediaDevices
useMediaDeviceSelect
useMultibandTrackVolume
usePagination
useParticipantAttribute
useParticipantAttributes
useParticipantContext
useParticipantInfo
useParticipantPermissions
useParticipants
useParticipantTile
useParticipantTracks
usePersistentUserChoices
usePinnedTracks
usePreviewDevice
usePreviewTracks
useRemoteParticipant
useRemoteParticipants
useRoomContext
useRoomInfo
useRpc
useSequentialRoomConnectDisconnect
useSession
useSessionContext
useSessionMessages
useSortedParticipants
useSpeakingParticipants
useStartAudio
useStartVideo
useSwipe
useTextStream
useToken
useTrackByName
useTrackMutedIndicator
useTrackRefContext
useTracks
useTrackToggle
useTrackTranscription
useTrackVolume
useTranscriptions
useVisualStableUpdate
useVoiceAssistant
AudioConference
AudioTrack
AudioVisualizer
BarVisualizer
CarouselLayout
Chat
ChatEntry
ChatToggle
ClearPinButton
ConnectionQualityIndicator
ConnectionState
ConnectionStateToast
ControlBar
DisconnectButton
FocusLayout
FocusLayoutContainer
FocusToggle
GridLayout
LayoutContext
LayoutContextProvider
LiveKitRoom
MediaDeviceMenu
MediaDeviceSelect
ParticipantAudioTile
ParticipantContext
ParticipantContextIfNeeded
ParticipantLoop
ParticipantName
ParticipantTile
PreJoin
RoomAudioRenderer
RoomContext
RoomName
SessionProvider
StartAudio
StartMediaButton
Toast
TrackLoop
TrackMutedIndicator
TrackRefContext
TrackToggle
VideoConference
VideoTrack
VoiceAssistantControlBar
Agents UI Components
Overview
AgentSessionView - 01
AgentControlBar
AgentTrackControl
AgentTrackToggle
AgentAudioVisualizerBar
AgentAudioVisualizerGrid
AgentAudioVisualizerRadial
AgentAudioVisualizerWave
AgentAudioVisualizerAura
AgentSessionProvider
AgentDisconnectButton
StartAudioButton
AgentChatIndicator
AgentChatTranscript
NextJS API Token Route
ReactShaderToy
Android Components
Installation
API Reference
Samples
Building Blocks
Rendering a single Track
RoomScope
Scopes
Recipes
Voice AI quickstart
SwiftUI Voice Agent
Next.js Voice Agent
Flutter Voice Agent
React Native Voice Agent
Android Voice Agent
Web Embed Voice Agent
Python Voice Agent
Warm Transfer
Node.js Voice Agent
Context Variables
Interrupt User
Interruptible tools
LLM Content Filter
Simple Content Filter
LLM Output Replacement
LLM Metrics
MCP Agent
RPC + State Agent
Uninterruptable Agent
Change Language
Transcriber
Keyword Detection
Pipeline Translator
TTS Translator
STT Metrics
VAD Metrics
Echo Agent
Using Twilio Voice
IVR Agent
Company Directory
Recording Consent
Phone Caller
SIP Lifecycle
Answer Incoming Calls
Survey Caller
Agent-assisted warm transfer
Call forwarding using SIP REFER
Secure trunking for SIP calls
Region pinning for SIP
Agents telephony integration
Background audio example in Node.js
TTS Comparison
TTS Metrics
Playing Audio
Sound Repeater
LivePaint
Gemini Vision Assistant
Raspberry Pi Transcriber
Rover Teleop
Pan-Tilt Teleop
C++ Examples
Medical Office Triage
Healthcare Agent
Personal Shopper
Restaurant Agent
Drive-thru agent
Front-desk agent
Moviefone
LlamaIndex RAG
Realtime model metrics
Tavus Avatar Agent
LemonSlice Avatar Agent
VR Spatial Video
LangChain LangGraph
LangChain Agent
LangChain Deep Agent
## What is LiveKit docs's llms.txt?
LiveKit docs publishes an `/llms.txt` file that provides AI systems with a structured index of its documentation. It follows the [llms.txt specification](https://llmstxt.org), organizing links to guides, API references, and tutorials under section headings so that LLMs like ChatGPT, Claude, and Gemini can quickly understand what LiveKit docs offers and where to find details.
Issues
Spec
12
Sections
677
Links
89.2 KB
Size
~22.8k
Tokens
Sections: Overview · Introduction · Build Agents · Agent Frontends · Telephony · WebRTC Transport · and 6 more
## Add LiveKit docs Docs to Your AI Assistant
Select your tool to see how to add LiveKit docs's llms.txt as a documentation source.
Cursor
Windsurf
Claude Code
ChatGPT
Zed
Copilot
1. 1
Open any chat or composer panel
2. 2
Type @Docs and select "Add new doc"
3. 3
Paste the URL: https://docs.livekit.io/llms.txt
4. 4
Wait for the green dot (indexing complete)
5. 5
Reference @Docs in chat when asking about LiveKit docs
Cursor crawls the URL and indexes all subpages. Add a trailing slash to index child pages too.
## Spec Compliance 110 errors
## Frequently Asked Questions
Where is LiveKit docs's llms.txt file?
LiveKit docs publishes its llms.txt at https://docs.livekit.io/llms.txt. This file provides a structured, markdown-formatted index of LiveKit docs's documentation that AI systems can consume to understand the project's APIs, guides, and references.
How do I use LiveKit docs's llms.txt with AI coding assistants?
Copy the llms.txt content and paste it into your AI assistant (Cursor, Windsurf, Claude, ChatGPT) as context. This gives the AI an accurate map of LiveKit docs's documentation so it can provide better code suggestions and answers about LiveKit docs.
What does LiveKit docs's llms.txt contain?
LiveKit docs's llms.txt contains 12 sections and 677 documentation links in 89.2 KB (~22.8k tokens). Key sections include Overview, Introduction, Build Agents, Agent Frontends, Telephony, WebRTC Transport.
How many tokens does LiveKit docs's llms.txt use?
The concise llms.txt index is approximately 22.8k tokens (89.2 KB). Most AI assistants can fit this within their context window. For the full expanded documentation, look for an llms-full.txt variant which embeds all content inline.
What is LiveKit docs?
LiveKit is a platform for building voice and realtime AI applications. LiveKit Cloud is the hosted commercial offering based on the open-source LiveKit project.. LiveKit docs's llms.txt file helps AI systems understand this by providing a structured overview of its documentation, making it easier for developers to get accurate AI-assisted help when working with LiveKit docs.
Can I generate an llms.txt for my own project?
Yes. Use the free llms.txt generator at mdream.dev/tools/llms-txt/generator to crawl your site and produce a spec-compliant llms.txt file. You can also validate existing files with the llms.txt validator.
## Browse More llms.txt Files
[Coolify Open Source PaaS](https://mdream.dev/llms-txt/livekit/llms-txt/coolify) [Ant Design - Enterprise-class React UI library An enterprise-class UI design language and React UI library](https://mdream.dev/llms-txt/livekit/llms-txt/ant-design) [--banner:js hack from https://github.com/evanw/esbuild/pull/2067 You can progressively stream response payloads through Lambda function URLs, including as an Amazon CloudFront origin, along with using the AWS SDK or using Lambda’s invoke API. You can not use Amazon API Gateway and Application Load Balancer to progressively stream response payloads, but you can use the functionality to return larger payloads. (https://aws.amazon.com/blogs/compute/introducing-aws-lambda-response-streaming/)](https://mdream.dev/llms-txt/livekit/llms-txt/middy) [Opik Documentation Debug, evaluate, and monitor your LLM applications, RAG systems, and agentic workflows with comprehensive tracing, automated evaluations, and production-ready dashboards.](https://mdream.dev/llms-txt/livekit/llms-txt/opik) [Temporal Platform Documentation Build invincible applications](https://mdream.dev/llms-txt/livekit/llms-txt/temporal) [MCP Toolbox for Databases - Documentation Index MCP Toolbox for Databases is an open source MCP server for databases. It enables you to develop tools easier, faster, and more securely by handling the complexities such as connection pooling, authentication, and more.](https://mdream.dev/llms-txt/livekit/llms-txt/genai-toolbox) [HTTP/3 explained A document describing the HTTP/3 and QUIC protocols](https://mdream.dev/llms-txt/livekit/llms-txt/http3-explained) [Checkly Docs Puppeteer example scripts for running Headless Chrome from Node.](https://mdream.dev/llms-txt/livekit/llms-txt/puppeteer-examples)
[View all 99 projects ](https://mdream.dev/llms-txt/livekit/llms-txt)
## Related Tools
[llms.txt Generator
Generate an llms.txt for your own project.](https://mdream.dev/llms-txt/livekit/tools/llms-txt/generator) [llms.txt Validator
Validate your llms.txt against the official spec.](https://mdream.dev/llms-txt/livekit/tools/llms-txt/validator)
© 2026 [Harlan Wilton](https://github.com/harlan-zw) · [MIT](https://github.com/harlan-zw/mdream/blob/main/license)
[GitHub](https://github.com/harlan-zw/mdream) [Discord](https://discord.com/invite/275MBUBvgP)