# Egma

## Docs

- [Introduction to Egma: Voice Agent Testing Platform](https://docs.egma.ai/introduction.md): Understand what Egma is, how simulation testing and production monitoring work, and which voice agent platforms it integrates with out of the box.
- [Quickstart: From Install to First Simulation Verdict](https://docs.egma.ai/quickstart.md): Install the Egma CLI, connect your Retell or LiveKit agent, auto-generate a test suite, and see your first simulation verdicts in one wizard session.
- [Self-Hosting Egma: Deploy on Your Own Infrastructure](https://docs.egma.ai/self-hosting.md): Run Egma with Docker Compose — set required secrets, configure LLM and speech providers, enable phone simulation, and invite your team.
- [Agents and Connections: How Egma Reaches Your Agent](https://docs.egma.ai/concepts/agents-and-connections.md): Learn how Egma models your voice agents and the connections it uses to reach them — via Retell or LiveKit — during simulation and testing.
- [Tests and Runs: Simulate and Evaluate Voice Agents](https://docs.egma.ai/concepts/tests-and-runs.md): Understand how Egma test files are structured, how runs execute them as live simulations, and what each of the four verdicts means.
- [Graders: LLM-Based Judges for Voice Agent Behavior](https://docs.egma.ai/concepts/graders.md): Learn how Egma's LLM-based graders evaluate conversations, how to configure params and scope, and the difference between required and diagnostic graders.
- [Telemetry: Ingest OTLP Traces from Your Live Agents](https://docs.egma.ai/concepts/telemetry.md): Send OTLP traces from your production voice agents to Egma, then read them as turn-by-turn transcripts and run graders against them.
- [Connect Your Retell Voice Agent to Egma for Testing](https://docs.egma.ai/integrations/retell.md): Register your Retell agent with Egma in one command. Choose text or phone reach, seal your credentials, and start running simulations.
- [Egma Python SDK: Mock Tools for LiveKit Voice Agents](https://docs.egma.ai/integrations/python-sdk.md): Add one line to your LiveKit agent entrypoint and Egma intercepts tool calls during simulations — zero impact on production behavior, guaranteed.
- [Egma CLI — Your Voice Agent Testing Command Center](https://docs.egma.ai/cli/overview.md): Install and run @egma/cli to connect voice agents, generate test suites, and launch simulations — all from one interactive wizard or scriptable commands.
- [Egma CLI Command Reference — All Commands and Flags](https://docs.egma.ai/cli/commands.md): Full reference for every Egma CLI command: usage syntax, key flags, exit codes, and environment variables for scripting and CI pipelines.
- [Egma Test Files — Format, Structure, and Sync Workflow](https://docs.egma.ai/cli/test-files.md): Learn the egma/ folder layout, test file anatomy, mock-tools format, and the pull → review → push workflow for keeping local files in sync with Egma.
- [Environment Variables Reference for Egma Self-Hosting](https://docs.egma.ai/configuration/environment-variables.md): Complete reference for every environment variable Egma reads on startup — required secrets, optional defaults, and the commands that generate safe values.
- [Configuring Platform Settings on a Self-Hosted Egma](https://docs.egma.ai/configuration/platform-settings.md): Configure the LLM persona, speech providers, VAD, phone trunk, and judge defaults for your self-hosted Egma instance using the CLI or the API.
- [Authentication, API Keys, and Member Roles in Egma](https://docs.egma.ai/configuration/authentication.md): Sign up, sign in, get an API key via the CLI or dashboard, understand key scoping, revoke keys, and manage team members and roles in Egma.
- [Egma REST API Overview: Base URL, Auth, and Conventions](https://docs.egma.ai/api/overview.md): Understand the Egma REST API: base URL, authentication, JSON conventions, cursor pagination, error format, rate limits, and OTLP trace ingest.
- [API Key Authentication and Key Management for Egma](https://docs.egma.ai/api/authentication.md): Create, use, list, and revoke Egma API keys. Learn about key scoping, the one-time secret display, key rotation, and authentication error codes.
- [Register and Manage Voice Agents with the Egma API](https://docs.egma.ai/api/agents.md): Register voice agents, attach provider connections, and list or retrieve agents by id. Connections are always reached through their agent.
- [Create and Manage Versioned Test Scenarios via API](https://docs.egma.ai/api/tests.md): Create, edit, and list simulation test scenarios. Every edit mints an immutable version; optimistic locking prevents silent overwrites.
- [Configure Project-Level Mock Tools for Simulations](https://docs.egma.ai/api/mock-tools.md): Create, update, delete, and list project-level mock tools that intercept agent tool calls during simulations with controlled responses and delays.
- [Start, Follow, and Cancel Agent Simulation Runs via API](https://docs.egma.ai/api/runs.md): Start test runs against a connection, stream live status events, retrieve full results with verdicts, and cancel runs in progress.
- [Graders: Configure Judgment Criteria for Your Project](https://docs.egma.ai/api/graders.md): Create, update, and delete project graders — copies of library entries that judge your agent's conversations in simulations and production.
- [Grader Library: Browse and Activate Judgment Templates](https://docs.egma.ai/api/grader-library.md): Browse Egma's catalog of grader definitions. Each entry is a reusable judgment template you activate for your project by creating a grader copy.
- [Traces: Ingest and Query Conversation Telemetry via OTLP](https://docs.egma.ai/api/traces.md): Send OpenTelemetry spans from your voice agent to Egma and query them back with time-windowed list and single-trace detail endpoints.
- [API Keys: Create, List, and Revoke API Credentials](https://docs.egma.ai/api/api-keys.md): Create API keys for programmatic access, list your active keys, and revoke any key instantly. The secret is shown exactly once at creation time.
- [Members: Invite, Assign Roles, and Remove Team Members](https://docs.egma.ai/api/members.md): List organization members, send invitations, change roles, remove members, and deactivate accounts. Invite and member management requires the admin role.