# HAPI

## Docs

- [Configuration](https://mintlify.wiki/tiann/hapi/advanced/configuration.md): Complete reference for HAPI environment variables and settings
- [Namespaces](https://mintlify.wiki/tiann/hapi/advanced/namespaces.md): Multi-user isolation for shared HAPI hubs
- [Runner](https://mintlify.wiki/tiann/hapi/advanced/runner.md): Background daemon for long-running AI coding sessions
- [Worktrees](https://mintlify.wiki/tiann/hapi/advanced/worktrees.md): Git worktree support for parallel branch development
- [Claude Code](https://mintlify.wiki/tiann/hapi/agents/claude-code.md): Run Claude Code sessions with remote control via HAPI
- [Codex](https://mintlify.wiki/tiann/hapi/agents/codex.md): Run OpenAI-based coding sessions with HAPI
- [Cursor Agent](https://mintlify.wiki/tiann/hapi/agents/cursor-agent.md): Run Cursor Agent CLI sessions with HAPI remote control
- [Gemini](https://mintlify.wiki/tiann/hapi/agents/gemini.md): Run Google Gemini coding sessions via ACP with HAPI
- [OpenCode](https://mintlify.wiki/tiann/hapi/agents/opencode.md): Run OpenCode sessions with HAPI remote control
- [Authentication](https://mintlify.wiki/tiann/hapi/api/authentication.md): Authenticate and obtain JWT tokens
- [Git & Files](https://mintlify.wiki/tiann/hapi/api/git-files.md): Access git status, diffs, and file contents
- [API Introduction](https://mintlify.wiki/tiann/hapi/api/introduction.md): Overview of the HAPI REST API, WebSocket API, and SSE
- [Machines](https://mintlify.wiki/tiann/hapi/api/machines.md): List machines and spawn sessions
- [Messages](https://mintlify.wiki/tiann/hapi/api/messages.md): Send and retrieve messages
- [Permissions](https://mintlify.wiki/tiann/hapi/api/permissions.md): Approve or deny permission requests
- [Push Notifications](https://mintlify.wiki/tiann/hapi/api/push-notifications.md): Subscribe to web push notifications
- [RPC](https://mintlify.wiki/tiann/hapi/api/rpc.md): Remote procedure call system
- [Sessions](https://mintlify.wiki/tiann/hapi/api/sessions.md): Manage coding sessions
- [Socket.IO Events](https://mintlify.wiki/tiann/hapi/api/socket-events.md): Detailed event reference for client and server events
- [Socket.IO Overview](https://mintlify.wiki/tiann/hapi/api/socket-overview.md): Real-time WebSocket communication
- [Server-Sent Events (SSE)](https://mintlify.wiki/tiann/hapi/api/sse.md): Real-time event streaming from hub to web clients
- [Voice](https://mintlify.wiki/tiann/hapi/api/voice.md): Get ElevenLabs conversation tokens for voice assistant
- [Authentication Commands](https://mintlify.wiki/tiann/hapi/cli/auth-commands.md): Manage CLI authentication and API tokens
- [Diagnostics](https://mintlify.wiki/tiann/hapi/cli/diagnostics.md): System diagnostics and troubleshooting for HAPI CLI
- [Environment Variables](https://mintlify.wiki/tiann/hapi/cli/environment-variables.md): Configure HAPI CLI behavior with environment variables
- [Hub Command](https://mintlify.wiki/tiann/hapi/cli/hub-command.md): Start the bundled HAPI hub server
- [CLI Overview](https://mintlify.wiki/tiann/hapi/cli/overview.md): Run Claude Code, Codex, Cursor Agent, Gemini, or OpenCode sessions from your terminal
- [Runner Commands](https://mintlify.wiki/tiann/hapi/cli/runner-commands.md): Manage the background service that runs sessions
- [Session Commands](https://mintlify.wiki/tiann/hapi/cli/session-commands.md): Start and manage AI agent sessions with HAPI
- [Settings File](https://mintlify.wiki/tiann/hapi/cli/settings-file.md): Understanding and managing the HAPI settings.json file
- [Agents](https://mintlify.wiki/tiann/hapi/concepts/agents.md): Multi-agent support, agent flavors, and agent-specific features in HAPI
- [Architecture](https://mintlify.wiki/tiann/hapi/concepts/architecture.md): Technical architecture and components of the HAPI platform
- [How It Works](https://mintlify.wiki/tiann/hapi/concepts/how-it-works.md): Session lifecycle, data flow, and mode switching in HAPI
- [Sessions](https://mintlify.wiki/tiann/hapi/concepts/sessions.md): Understanding HAPI sessions, metadata, state, and lifecycle
- [Cloudflare Tunnel](https://mintlify.wiki/tiann/hapi/deployment/cloudflare-tunnel.md): Deploy HAPI with Cloudflare Tunnel for secure remote access without exposing ports
- [Deploy with Relay](https://mintlify.wiki/tiann/hapi/deployment/relay.md): Use HAPI's public relay with end-to-end encryption for zero-configuration remote access
- [Self-Hosted Deployment](https://mintlify.wiki/tiann/hapi/deployment/self-hosted.md): Run HAPI hub without relay using public IP or reverse proxy
- [Tailscale](https://mintlify.wiki/tiann/hapi/deployment/tailscale.md): Deploy HAPI with Tailscale for secure private network access
- [Permissions](https://mintlify.wiki/tiann/hapi/features/permissions.md): Control what your AI agents can do with granular permission modes
- [Progressive Web App](https://mintlify.wiki/tiann/hapi/features/pwa.md): Install HAPI on your phone for a native app-like experience
- [Remote Control](https://mintlify.wiki/tiann/hapi/features/remote-control.md): Seamlessly switch between local terminal and remote devices
- [Telegram Integration](https://mintlify.wiki/tiann/hapi/features/telegram.md): Control HAPI sessions from Telegram with Mini App and notifications
- [Remote Terminal](https://mintlify.wiki/tiann/hapi/features/terminal.md): Access a remote terminal in your coding sessions from any device
- [Voice Assistant](https://mintlify.wiki/tiann/hapi/features/voice-assistant.md): Control your AI coding agent with voice using ElevenLabs
- [Installation](https://mintlify.wiki/tiann/hapi/installation.md): Complete setup guide for HAPI CLI, Hub, and Runner
- [Introduction](https://mintlify.wiki/tiann/hapi/introduction.md): A local-first platform for running AI coding agents with remote control
- [Quickstart](https://mintlify.wiki/tiann/hapi/quickstart.md): Get HAPI running in under 2 minutes
- [FAQ](https://mintlify.wiki/tiann/hapi/resources/faq.md): Frequently asked questions about HAPI
- [Troubleshooting](https://mintlify.wiki/tiann/hapi/resources/troubleshooting.md): Common issues and solutions for HAPI
- [Why HAPI?](https://mintlify.wiki/tiann/hapi/resources/why-hapi.md): Understanding the differences between HAPI and Happy

## OpenAPI Specs

- [openapi](https://mintlify.wiki/tiann/hapi/api-reference/openapi.json)