--output file.pdf\nhail email domain register --kind hail_mail\nhail email domain register --kind custom --domain acme.com # send + receive on your own domain\nhail email domain list\n\nprintf '%s' \"$YOUR_API_KEY\" | hail providers set llm \\\n --provider openai-compatible \\\n --base-url https://api.your-agent.dev/v1 \\\n --model your-model \\\n --key - # standing BYO brain (also: tts, stt)\n\nhail tail # cross-channel event stream\nhail tail call: # narrow by resource type\n\nhail mcp endpoint # Streamable HTTP URL for the MCP server\nhail completion zsh # source <(hail completion zsh)\nhail version\n```\n\n**Python** (`pip install hail-sdk`):\n\n```python\nimport asyncio\nfrom hail import Client\n\nasync def main():\n async with Client() as client: # reads $HAIL_API_KEY\n call = await client.calls.create(\n to=\"+15551234567\",\n recipient_consent=True,\n system_prompt=\"You are calling to confirm a reschedule.\",\n )\n async for event in client.events.tail(id=f\"call:{call.id}\"):\n print(event.kind, event.payload)\n\nasyncio.run(main())\n```\n\n**HTTP** ([OpenAPI spec](https://github.com/hail-hq/hail/blob/main/openapi/openapi.yaml), [API reference](https://hail.so/docs/api)):\n\n```bash\ncurl -X POST http://localhost:8080/calls \\\n -H \"Authorization: Bearer $HAIL_API_KEY\" \\\n -H \"Content-Type: application/json\" \\\n -d '{\"to\":\"+15551234567\",\"recipient_consent\":true,\"system_prompt\":\"...\"}'\n```\n\n**MCP** (Claude.ai, Claude Code, ChatGPT, Cursor, …): local clients can use\n`http://localhost:8081`. Web-based clients require a publicly reachable HTTPS\nendpoint. See the [MCP setup guide](https://github.com/hail-hq/hail/blob/main/docs/public/mcp.md).\n\n## Bring your own LLM\n\nHail always runs the telephony and the voice pipeline. The brain is pluggable, at two levels:\n\n- **Per call** — pass an `llm` block to `POST /calls`; different brains for different calls.\n- **Standing** — save an endpoint once (`hail providers set llm …`); every call your org places uses it.\n\nAny OpenAI chat-completions-compatible endpoint works. A complete runnable example lives in [docs/public/byo-llm.md](https://github.com/hail-hq/hail/blob/main/docs/public/byo-llm.md). TTS and STT are pluggable the same way (`hail providers set tts|stt …`).\n\n## Tenets\n\n1. **Clear comms.** Explicit OpenAPI contracts. No hidden behavior.\n2. **Simple code.** Boring is best. No abstraction before it has two uses.\n3. **Brief docs.** Each page fits on one screen. Setup takes 10 minutes from a fresh clone.\n4. **Self-hostable.** Docker Compose runs Hail's API, voicebot, MCP server,\n Postgres, and MinIO; LiveKit Cloud and channel providers remain external.\n5. **Pluggable brain.** [BYO LLM endpoint](https://github.com/hail-hq/hail/blob/main/docs/public/byo-llm.md), or Hail's bundled fallback. The voice pipeline and transport are always Hail's.\n6. **Agent-first docs.** AI agents are first-class readers. Runnable examples first; links to canonical sources, not paraphrase.\n\n## Milestones\n\nA checked box is a released feature. Per-artifact changelogs (GitHub Releases for the CLI, PyPI notes for the SDK) record which version shipped it.\n\n### Phone calls\n\n- Outbound\n - [x] Twilio\n - [ ] Telnyx\n- Inbound\n - [ ] Twilio\n\n### SMS\n\n- Outbound\n - [x] Twilio\n- Inbound\n - [x] Twilio\n\n### Email\n\n- Outbound\n - [x] AWS SES\n - [x] Custom sender domains (own DNS, automatic DKIM + MAIL FROM)\n- Inbound\n - [x] AWS SES\n - [x] Custom domains (receive on verified domains)\n\n### Voice pipeline\n\n- Languages\n - [x] 39 call languages with automatic STT routing and per-language turn detection — see [docs/languages.md](https://github.com/hail-hq/hail/blob/main/docs/languages.md)\n- STT\n - [x] Deepgram\n - [x] Speechmatics\n - [ ] Whisper\n - [ ] AssemblyAI\n- TTS\n - [x] Cartesia\n - [x] ElevenLabs\n - [ ] Deepgram Aura\n- VAD\n - [x] Silero\n- Turn detection\n - [x] LiveKit turn-detector\n- LLM — system-prompt mode\n - [x] Fallback: OpenAI → Gemini → Anthropic, fast models\n- LLM — BYO-endpoint mode\n - [x] OpenAI chat-completions-compatible ([docs](https://github.com/hail-hq/hail/blob/main/docs/public/byo-llm.md))\n- Recording\n - [ ] S3 upload\n - [ ] Diarization\n\n### Distribution\n\n- API\n - [x] OpenAPI spec + [hosted reference](https://hail.so/docs/api)\n- CLI\n - [x] `hail` binary via GitHub Releases\n- MCP server\n - [x] Remote Streamable HTTP endpoint included with each Hail deployment\n - ~~PyPI stdio package~~ — deliberately not shipped; see [MCP setup](https://github.com/hail-hq/hail/blob/main/docs/public/mcp.md)\n- Python SDK\n - [x] `hail-sdk` on PyPI, imports as `hail`\n\n### Infrastructure\n\n- [x] Docker Compose scaffold\n- Self-hosted LiveKit SFU\n - [ ] docker compose integration\n\n## Architecture\n\nThe path of an outbound call:\n\n```\nAI agent ──► Hail API ──dispatch──► Voicebot ──► LiveKit Cloud ──SIP──► Twilio ──► 📞\n```\n\nFull diagram and service breakdown: [docs/public/architecture.md](https://github.com/hail-hq/hail/blob/main/docs/public/architecture.md). All docs are published at [hail.so/docs](https://hail.so/docs) and live as plain markdown in [docs/public/](https://github.com/hail-hq/hail/blob/main/docs/public/).\n\n## Contributing\n\nSee [docs/public/contributing.md](https://github.com/hail-hq/hail/blob/main/docs/public/contributing.md). Short version: fork, branch, conventional commits, pull request. Provider adapters go in `core/hailhq/core/providers/`; new env vars update `.env.example` in the same commit.\n\n## License\n\nCode: [AGPL-3.0-or-later](https://github.com/hail-hq/hail/blob/main/LICENSE) — run a modified Hail as a service, release your source.\nPricing dataset (`costs/`): [CC-BY-4.0](https://github.com/hail-hq/hail/blob/main/costs/LICENSE) — use the JSON with attribution.\n","changelogMarkdown","videoKey","requiredSecretsJson","publishedAt","priceCents","trialDays",0,"upstream",{"_105":106,"_107":108,"_109":110,"_111":112,"_113":114,"_115":116},"requiredSecrets",[],"tags",[98,99,100,101,102,103,104],"assets",[],"stats",{"_96":85,"_97":85},"ratingAvg","reviewCount","ai-agents","email","livekit","sms","telephony","twilio","voice-ai","topics",[98,99,100,117,101,102,103,104],"license","AGPL-3.0","language","Python","registryName","io.github.hail-hq/hail-mcp","homepage","https://hail.so/mcp","packages",[],"mcp","ENV",{"_120":121,"_122":123,"_124":125},"ENVIRONMENT","production","TURNSTILE_SITE_KEY","0x4AAAAAAB8-rEI2gNDf_QhU","SENTRY_DSN","https://45fd1229f78089d5c3ee78be128030e1@o4510583261757440.ingest.de.sentry.io/4510584253448272"]