# Patter | Documentation

## Docs

- [Core Concepts](https://patter-06b046ce-feat-observability-otel-attrs-0-6-1.mintlify.app/concepts.md): What Patter is, how a voice call flows through it, and the building blocks you'll use
- [Dashboard](https://patter-06b046ce-feat-observability-otel-attrs-0-6-1.mintlify.app/dev-tools/dashboard.md): Real-time call monitoring dashboard — Vite + React SPA bundled into a single HTML file embedded by both SDKs.
- [Tunneling](https://patter-06b046ce-feat-observability-otel-attrs-0-6-1.mintlify.app/dev-tools/tunneling.md): Expose your local Patter server to the internet for Twilio webhooks.
- [Welcome](https://patter-06b046ce-feat-observability-otel-attrs-0-6-1.mintlify.app/home/index.md): Give your AI agent a phone number. Patter handles telephony, speech-to-text, and text-to-speech so you can focus on your agent.
- [Python SDK](https://patter-06b046ce-feat-observability-otel-attrs-0-6-1.mintlify.app/home/redirects/python.md): Voice AI SDK for Python
- [TypeScript SDK](https://patter-06b046ce-feat-observability-otel-attrs-0-6-1.mintlify.app/home/redirects/typescript.md): Voice AI SDK for TypeScript
- [Agents](https://patter-06b046ce-feat-observability-otel-attrs-0-6-1.mintlify.app/python-sdk/agents.md): Configure voice AI agents with system prompts, tools, engines, and guardrails.
- [Call logging](https://patter-06b046ce-feat-observability-otel-attrs-0-6-1.mintlify.app/python-sdk/call-logging.md): Opt-in per-call filesystem logs: metadata, transcripts, and operational events.
- [Carrier](https://patter-06b046ce-feat-observability-otel-attrs-0-6-1.mintlify.app/python-sdk/carrier.md): Telephony providers: Twilio and Telnyx.
- [Configuration](https://patter-06b046ce-feat-observability-otel-attrs-0-6-1.mintlify.app/python-sdk/configuration.md): All Patter constructor parameters for local mode.
- [Dashboard](https://patter-06b046ce-feat-observability-otel-attrs-0-6-1.mintlify.app/python-sdk/dashboard.md): Embedded web dashboard for real-time call monitoring, latency, and cost analytics.
- [Engines](https://patter-06b046ce-feat-observability-otel-attrs-0-6-1.mintlify.app/python-sdk/engines.md): End-to-end speech-to-speech runtimes (OpenAI Realtime, ElevenLabs ConvAI).
- [Events](https://patter-06b046ce-feat-observability-otel-attrs-0-6-1.mintlify.app/python-sdk/events.md): React to call lifecycle events with async callbacks.
- [Advanced Features](https://patter-06b046ce-feat-observability-otel-attrs-0-6-1.mintlify.app/python-sdk/features.md): Recording, AMD, DTMF, call transfer, barge-in, and more.
- [Guardrails](https://patter-06b046ce-feat-observability-otel-attrs-0-6-1.mintlify.app/python-sdk/guardrails.md): Filter and control AI responses before they reach the caller.
- [LLM](https://patter-06b046ce-feat-observability-otel-attrs-0-6-1.mintlify.app/python-sdk/llm.md): Pick an LLM provider the same way you pick STT and TTS.
- [Local Mode](https://patter-06b046ce-feat-observability-otel-attrs-0-6-1.mintlify.app/python-sdk/local-mode.md): Run a fully self-hosted voice AI server with your own telephony and AI provider keys.
- [MCP — Model Context Protocol](https://patter-06b046ce-feat-observability-otel-attrs-0-6-1.mintlify.app/python-sdk/mcp.md): Plug a Patter agent into MCP servers (Google Workspace, PayPal, Postgres, GitHub, …) without writing wrapper handlers. Tools are discovered at call start and dispatched through the MCP client transparently.
- [Metrics & Cost Tracking](https://patter-06b046ce-feat-observability-otel-attrs-0-6-1.mintlify.app/python-sdk/metrics.md): Per-call cost breakdown, latency analytics, and real-time metrics.
- [Python SDK](https://patter-06b046ce-feat-observability-otel-attrs-0-6-1.mintlify.app/python-sdk/overview.md): Connect AI agents to phone numbers with 4 lines of Python.
- [PatterTool — phone as a tool](https://patter-06b046ce-feat-observability-otel-attrs-0-6-1.mintlify.app/python-sdk/patter-tool.md): Wrap a Patter instance so external agents (LangChain, OpenAI Assistants, Anthropic Claude, Hermes, MCP) can place real phone calls as a single tool invocation.
- [Anthropic](https://patter-06b046ce-feat-observability-otel-attrs-0-6-1.mintlify.app/python-sdk/providers/anthropic.md): Anthropic Claude LLM provider — Messages API with streaming, tool use, and prompt caching.
- [AssemblyAI STT](https://patter-06b046ce-feat-observability-otel-attrs-0-6-1.mintlify.app/python-sdk/providers/assemblyai.md): Universal Streaming speech-to-text via AssemblyAI's v3 WebSocket API.
- [Cartesia](https://patter-06b046ce-feat-observability-otel-attrs-0-6-1.mintlify.app/python-sdk/providers/cartesia.md): Cartesia STT (ink-whisper) and TTS (sonic) providers.
- [Cartesia TTS](https://patter-06b046ce-feat-observability-otel-attrs-0-6-1.mintlify.app/python-sdk/providers/cartesia-tts.md): Sonic-1, Sonic-2, and Sonic-3 voice synthesis via Cartesia's HTTP bytes endpoint.
- [Cerebras](https://patter-06b046ce-feat-observability-otel-attrs-0-6-1.mintlify.app/python-sdk/providers/cerebras.md): Cerebras LLM provider — OpenAI-compatible Inference API with WSE-3 throughput.
- [DeepFilterNet](https://patter-06b046ce-feat-observability-otel-attrs-0-6-1.mintlify.app/python-sdk/providers/deepfilternet-filter.md): Open-source DeepFilterNet3 noise suppression as a Patter AudioFilter.
- [Deepgram STT](https://patter-06b046ce-feat-observability-otel-attrs-0-6-1.mintlify.app/python-sdk/providers/deepgram.md): Streaming speech-to-text via Deepgram's v1 /listen WebSocket API.
- [ElevenLabs ConvAI](https://patter-06b046ce-feat-observability-otel-attrs-0-6-1.mintlify.app/python-sdk/providers/elevenlabs-convai.md): End-to-end speech-to-speech engine backed by an ElevenLabs-hosted Conversational AI agent.
- [ElevenLabs TTS (REST)](https://patter-06b046ce-feat-observability-otel-attrs-0-6-1.mintlify.app/python-sdk/providers/elevenlabs-tts.md): Streaming HTTP/REST TTS adapter for ElevenLabs voices. Simpler and more network-tolerant than the WebSocket variant.
- [ElevenLabs WebSocket](https://patter-06b046ce-feat-observability-otel-attrs-0-6-1.mintlify.app/python-sdk/providers/elevenlabs-websocket.md): Opt-in low-latency WebSocket variant of ElevenLabsTTS. Drop-in API, saves ~50 ms per utterance.
- [Gemini Live](https://patter-06b046ce-feat-observability-otel-attrs-0-6-1.mintlify.app/python-sdk/providers/gemini-live.md): Google Gemini Live native-audio realtime engine — alternative to OpenAI Realtime.
- [Google](https://patter-06b046ce-feat-observability-otel-attrs-0-6-1.mintlify.app/python-sdk/providers/google.md): Google Gemini LLM provider — Developer API or Vertex AI, streaming with function calling.
- [Groq](https://patter-06b046ce-feat-observability-otel-attrs-0-6-1.mintlify.app/python-sdk/providers/groq.md): Groq LLM provider — hardware-accelerated Llama inference via OpenAI-compatible Chat Completions.
- [Inworld TTS](https://patter-06b046ce-feat-observability-otel-attrs-0-6-1.mintlify.app/python-sdk/providers/inworld.md): TTS-2 (sub-200 ms TTFA, 100+ languages, natural-language voice steering) and the TTS-1.5 family via Inworld's HTTP NDJSON streaming endpoint.
- [Krisp Filter](https://patter-06b046ce-feat-observability-otel-attrs-0-6-1.mintlify.app/python-sdk/providers/krisp-filter.md): Proprietary Krisp VIVA noise / echo suppression as a Patter AudioFilter.
- [LMNT TTS](https://patter-06b046ce-feat-observability-otel-attrs-0-6-1.mintlify.app/python-sdk/providers/lmnt.md): Blizzard and Aurora TTS models via the LMNT HTTP API.
- [OpenAI Realtime](https://patter-06b046ce-feat-observability-otel-attrs-0-6-1.mintlify.app/python-sdk/providers/openai-realtime.md): Models, voices, transcription, and reasoning effort for the OpenAI Realtime engine.
- [OpenAI TTS](https://patter-06b046ce-feat-observability-otel-attrs-0-6-1.mintlify.app/python-sdk/providers/openai-tts.md): tts-1, tts-1-hd, and gpt-4o-mini-tts via OpenAI's HTTP TTS endpoint.
- [Rime TTS](https://patter-06b046ce-feat-observability-otel-attrs-0-6-1.mintlify.app/python-sdk/providers/rime.md): Arcana and Mist model families via Rime's HTTP endpoint.
- [Silero VAD](https://patter-06b046ce-feat-observability-otel-attrs-0-6-1.mintlify.app/python-sdk/providers/silero-vad.md): ONNX-backed voice activity detection for fast, accurate barge-in in pipeline mode.
- [Soniox STT](https://patter-06b046ce-feat-observability-otel-attrs-0-6-1.mintlify.app/python-sdk/providers/soniox.md): Soniox real-time streaming speech-to-text for Patter pipeline mode.
- [Speechmatics STT](https://patter-06b046ce-feat-observability-otel-attrs-0-6-1.mintlify.app/python-sdk/providers/speechmatics.md): Speechmatics real-time speech-to-text via the official Voice Agent SDK.
- [Telnyx STT](https://patter-06b046ce-feat-observability-otel-attrs-0-6-1.mintlify.app/python-sdk/providers/telnyx-stt.md): Streaming speech-to-text bundled with your Telnyx telephony plan — single bill, on-network audio.
- [Telnyx TTS](https://patter-06b046ce-feat-observability-otel-attrs-0-6-1.mintlify.app/python-sdk/providers/telnyx-tts.md): Streaming text-to-speech bundled with your Telnyx telephony plan — single bill, on-network audio.
- [Ultravox Realtime](https://patter-06b046ce-feat-observability-otel-attrs-0-6-1.mintlify.app/python-sdk/providers/ultravox-realtime.md): Ultravox managed-agent realtime engine — pure WebSocket, no vendor SDK.
- [Whisper STT (OpenAI)](https://patter-06b046ce-feat-observability-otel-attrs-0-6-1.mintlify.app/python-sdk/providers/whisper.md): OpenAI Whisper REST and GPT-4o transcribe family for Patter pipeline mode.
- [Quickstart](https://patter-06b046ce-feat-observability-otel-attrs-0-6-1.mintlify.app/python-sdk/quickstart.md): Give your AI agent a phone number in four lines of Python.
- [API Reference](https://patter-06b046ce-feat-observability-otel-attrs-0-6-1.mintlify.app/python-sdk/reference.md): Complete reference for all classes, methods, parameters, and types in the Patter Python SDK.
- [STT](https://patter-06b046ce-feat-observability-otel-attrs-0-6-1.mintlify.app/python-sdk/stt.md): Speech-to-text providers supported by Patter.
- [Test Mode](https://patter-06b046ce-feat-observability-otel-attrs-0-6-1.mintlify.app/python-sdk/test-mode.md): Interactive terminal testing for voice agents without telephony, STT, or TTS.
- [Tools & Function Calling](https://patter-06b046ce-feat-observability-otel-attrs-0-6-1.mintlify.app/python-sdk/tools.md): Let your voice agent call APIs, query databases, and take actions during a conversation.
- [Tracing (OpenTelemetry)](https://patter-06b046ce-feat-observability-otel-attrs-0-6-1.mintlify.app/python-sdk/tracing.md): Opt-in OpenTelemetry tracing for STT, LLM, TTS, and tool calls.
- [TTS](https://patter-06b046ce-feat-observability-otel-attrs-0-6-1.mintlify.app/python-sdk/tts.md): Text-to-speech providers supported by Patter.
- [Agents](https://patter-06b046ce-feat-observability-otel-attrs-0-6-1.mintlify.app/typescript-sdk/agents.md): Define your agent's voice, model, tools, and behavior for phone calls.
- [Call logging](https://patter-06b046ce-feat-observability-otel-attrs-0-6-1.mintlify.app/typescript-sdk/call-logging.md): Opt-in per-call filesystem logs: metadata, transcripts, and operational events.
- [Carrier](https://patter-06b046ce-feat-observability-otel-attrs-0-6-1.mintlify.app/typescript-sdk/carrier.md): Telephony providers: Twilio and Telnyx.
- [Configuration](https://patter-06b046ce-feat-observability-otel-attrs-0-6-1.mintlify.app/typescript-sdk/configuration.md): Constructor options for local mode.
- [Dashboard](https://patter-06b046ce-feat-observability-otel-attrs-0-6-1.mintlify.app/typescript-sdk/dashboard.md): Embedded web dashboard for real-time call monitoring, latency, and cost analytics.
- [Engines](https://patter-06b046ce-feat-observability-otel-attrs-0-6-1.mintlify.app/typescript-sdk/engines.md): End-to-end speech-to-speech runtimes (OpenAI Realtime, ElevenLabs ConvAI).
- [Events](https://patter-06b046ce-feat-observability-otel-attrs-0-6-1.mintlify.app/typescript-sdk/events.md): React to call lifecycle events with typed callbacks.
- [Advanced Features](https://patter-06b046ce-feat-observability-otel-attrs-0-6-1.mintlify.app/typescript-sdk/features.md): Recording, AMD, DTMF, call transfer, barge-in, variables, and conversation history.
- [Guardrails](https://patter-06b046ce-feat-observability-otel-attrs-0-6-1.mintlify.app/typescript-sdk/guardrails.md): Filter and control AI agent responses before they reach callers.
- [LLM](https://patter-06b046ce-feat-observability-otel-attrs-0-6-1.mintlify.app/typescript-sdk/llm.md): Pick an LLM provider the same way you pick STT and TTS.
- [Local Mode](https://patter-06b046ce-feat-observability-otel-attrs-0-6-1.mintlify.app/typescript-sdk/local-mode.md): Self-hosted embedded server, webhook endpoints, and WebSocket streams.
- [MCP — Model Context Protocol](https://patter-06b046ce-feat-observability-otel-attrs-0-6-1.mintlify.app/typescript-sdk/mcp.md): Plug a Patter agent into MCP servers (Google Workspace, PayPal, Postgres, GitHub, …) without writing wrapper handlers. Tools are discovered at call start and dispatched through the MCP client transparently.
- [Metrics & Cost Tracking](https://patter-06b046ce-feat-observability-otel-attrs-0-6-1.mintlify.app/typescript-sdk/metrics.md): Per-call cost breakdown, latency analytics, and real-time metrics.
- [TypeScript SDK](https://patter-06b046ce-feat-observability-otel-attrs-0-6-1.mintlify.app/typescript-sdk/overview.md): Connect AI agents to phone numbers with 4 lines of TypeScript.
- [PatterTool — phone as a tool](https://patter-06b046ce-feat-observability-otel-attrs-0-6-1.mintlify.app/typescript-sdk/patter-tool.md): Wrap a Patter instance so external agents (LangChain, OpenAI Assistants, Anthropic Claude, Hermes, MCP) can place real phone calls as a single tool invocation.
- [Anthropic](https://patter-06b046ce-feat-observability-otel-attrs-0-6-1.mintlify.app/typescript-sdk/providers/anthropic.md): Anthropic Claude LLM provider — Messages API with streaming, tool use, and prompt caching.
- [AssemblyAI STT](https://patter-06b046ce-feat-observability-otel-attrs-0-6-1.mintlify.app/typescript-sdk/providers/assemblyai.md): Universal Streaming speech-to-text via AssemblyAI's v3 WebSocket API.
- [Cartesia STT](https://patter-06b046ce-feat-observability-otel-attrs-0-6-1.mintlify.app/typescript-sdk/providers/cartesia.md): Streaming speech-to-text via Cartesia's ink-whisper model.
- [Cartesia TTS](https://patter-06b046ce-feat-observability-otel-attrs-0-6-1.mintlify.app/typescript-sdk/providers/cartesia-tts.md): Sonic-1, Sonic-2, and Sonic-3 voice synthesis via Cartesia's HTTP bytes endpoint.
- [Cerebras](https://patter-06b046ce-feat-observability-otel-attrs-0-6-1.mintlify.app/typescript-sdk/providers/cerebras.md): Cerebras LLM provider — OpenAI-compatible Inference API with WSE-3 throughput.
- [DeepFilterNet](https://patter-06b046ce-feat-observability-otel-attrs-0-6-1.mintlify.app/typescript-sdk/providers/deepfilternet-filter.md): Open-source DeepFilterNet3 noise suppression as a Patter AudioFilter.
- [Deepgram STT](https://patter-06b046ce-feat-observability-otel-attrs-0-6-1.mintlify.app/typescript-sdk/providers/deepgram.md): Streaming speech-to-text via Deepgram's v1 /listen WebSocket API.
- [ElevenLabs ConvAI](https://patter-06b046ce-feat-observability-otel-attrs-0-6-1.mintlify.app/typescript-sdk/providers/elevenlabs-convai.md): End-to-end speech-to-speech engine backed by an ElevenLabs-hosted Conversational AI agent.
- [ElevenLabs TTS (REST)](https://patter-06b046ce-feat-observability-otel-attrs-0-6-1.mintlify.app/typescript-sdk/providers/elevenlabs-tts.md): Streaming HTTP/REST TTS adapter for ElevenLabs voices. Simpler and more network-tolerant than the WebSocket variant.
- [ElevenLabs WebSocket TTS](https://patter-06b046ce-feat-observability-otel-attrs-0-6-1.mintlify.app/typescript-sdk/providers/elevenlabs-websocket.md): Opt-in WebSocket variant of ElevenLabsTTS that trims HTTP setup latency.
- [Gemini Live](https://patter-06b046ce-feat-observability-otel-attrs-0-6-1.mintlify.app/typescript-sdk/providers/gemini-live.md): Google Gemini Live native-audio realtime engine — alternative to OpenAI Realtime.
- [Google](https://patter-06b046ce-feat-observability-otel-attrs-0-6-1.mintlify.app/typescript-sdk/providers/google.md): Google Gemini LLM provider — Developer API streaming with function calling.
- [Groq](https://patter-06b046ce-feat-observability-otel-attrs-0-6-1.mintlify.app/typescript-sdk/providers/groq.md): Groq LLM provider — hardware-accelerated Llama inference via OpenAI-compatible Chat Completions.
- [Inworld TTS](https://patter-06b046ce-feat-observability-otel-attrs-0-6-1.mintlify.app/typescript-sdk/providers/inworld.md): TTS-2 (sub-200 ms TTFA, 100+ languages, natural-language voice steering) and the TTS-1.5 family via Inworld's HTTP NDJSON streaming endpoint.
- [Krisp Filter](https://patter-06b046ce-feat-observability-otel-attrs-0-6-1.mintlify.app/typescript-sdk/providers/krisp-filter.md): Proprietary Krisp VIVA noise / echo suppression as a Patter AudioFilter.
- [LMNT TTS](https://patter-06b046ce-feat-observability-otel-attrs-0-6-1.mintlify.app/typescript-sdk/providers/lmnt.md): Blizzard and Aurora TTS models via the LMNT HTTP API.
- [OpenAI Realtime](https://patter-06b046ce-feat-observability-otel-attrs-0-6-1.mintlify.app/typescript-sdk/providers/openai-realtime.md): Models, voices, transcription, and reasoning effort for the OpenAI Realtime engine.
- [OpenAI TTS](https://patter-06b046ce-feat-observability-otel-attrs-0-6-1.mintlify.app/typescript-sdk/providers/openai-tts.md): tts-1, tts-1-hd, and gpt-4o-mini-tts via OpenAI's HTTP TTS endpoint.
- [Rime TTS](https://patter-06b046ce-feat-observability-otel-attrs-0-6-1.mintlify.app/typescript-sdk/providers/rime.md): Arcana and Mist model families via Rime's HTTP endpoint.
- [Silero VAD](https://patter-06b046ce-feat-observability-otel-attrs-0-6-1.mintlify.app/typescript-sdk/providers/silero-vad.md): ONNX-backed voice activity detection for fast, accurate barge-in in pipeline mode.
- [Soniox STT](https://patter-06b046ce-feat-observability-otel-attrs-0-6-1.mintlify.app/typescript-sdk/providers/soniox.md): Soniox real-time streaming speech-to-text for Patter pipeline mode.
- [Speechmatics STT](https://patter-06b046ce-feat-observability-otel-attrs-0-6-1.mintlify.app/typescript-sdk/providers/speechmatics.md): Speechmatics real-time speech-to-text — Python-only today; TypeScript port pending.
- [Telnyx STT](https://patter-06b046ce-feat-observability-otel-attrs-0-6-1.mintlify.app/typescript-sdk/providers/telnyx-stt.md): Streaming speech-to-text bundled with your Telnyx telephony plan — single bill, on-network audio.
- [Telnyx TTS](https://patter-06b046ce-feat-observability-otel-attrs-0-6-1.mintlify.app/typescript-sdk/providers/telnyx-tts.md): Streaming text-to-speech bundled with your Telnyx telephony plan — single bill, on-network audio.
- [Ultravox Realtime](https://patter-06b046ce-feat-observability-otel-attrs-0-6-1.mintlify.app/typescript-sdk/providers/ultravox-realtime.md): Ultravox managed-agent realtime engine — pure WebSocket, no vendor SDK.
- [Whisper STT (OpenAI)](https://patter-06b046ce-feat-observability-otel-attrs-0-6-1.mintlify.app/typescript-sdk/providers/whisper.md): OpenAI Whisper REST and GPT-4o transcribe family for Patter pipeline mode.
- [Quickstart](https://patter-06b046ce-feat-observability-otel-attrs-0-6-1.mintlify.app/typescript-sdk/quickstart.md): Give your AI agent a phone number in four lines of TypeScript.
- [API Reference](https://patter-06b046ce-feat-observability-otel-attrs-0-6-1.mintlify.app/typescript-sdk/reference.md): Complete type definitions, interfaces, error classes, and exports.
- [STT](https://patter-06b046ce-feat-observability-otel-attrs-0-6-1.mintlify.app/typescript-sdk/stt.md): Speech-to-text providers supported by Patter.
- [Test Mode](https://patter-06b046ce-feat-observability-otel-attrs-0-6-1.mintlify.app/typescript-sdk/test-mode.md): Test your agent in the terminal without telephony, STT, or TTS.
- [Tools](https://patter-06b046ce-feat-observability-otel-attrs-0-6-1.mintlify.app/typescript-sdk/tools.md): Function calling, webhook tools, and system tools for voice agents.
- [Tracing (OpenTelemetry)](https://patter-06b046ce-feat-observability-otel-attrs-0-6-1.mintlify.app/typescript-sdk/tracing.md): Opt-in OpenTelemetry tracing for STT, LLM, TTS, endpointing, barge-in, and tool calls.
- [TTS](https://patter-06b046ce-feat-observability-otel-attrs-0-6-1.mintlify.app/typescript-sdk/tts.md): Text-to-speech providers supported by Patter.