# Documentation | SimZ Instructions for AI Agents: - For clean Markdown of any page, append `.md` to the page URL - For section-specific indexes, append `/llms.txt` to any section URL - For AI client integration (Claude Code, Cursor, etc.), connect to the MCP server at https://docs.simz.com/_mcp/server ## Docs - [Welcome](https://docs.simz.com/overview/overview/welcome.md): Start here to understand SimZ onboarding, billing, lead intake, and webhooks. - [Login and Account Access](https://docs.simz.com/overview/overview/login-and-account-access.md): Learn how customers access the SimZ onboarding portal. - [Onboarding Checklist](https://docs.simz.com/overview/overview/onboarding-checklist.md): The recommended order for completing SimZ customer onboarding. - [Recharge and Billing Basics](https://docs.simz.com/overview/overview/recharge-and-billing-basics.md): Understand credits, usage, invoices, payment methods, and plan information. - [Support and Service Status](https://docs.simz.com/overview/overview/support-and-service-status.md): Learn how to get help and monitor SimZ service health. - [Company Context](https://docs.simz.com/overview/onboarding/company-context.md): Provide the business context SimZ needs to configure your AI workflows. - [File Uploads](https://docs.simz.com/overview/onboarding/file-uploads.md): Upload the documents SimZ should use during setup and review. - [API Integrations](https://docs.simz.com/overview/onboarding/api-integrations.md): Describe CRM, webhook, and third-party service integrations during onboarding. - [Submit for Review](https://docs.simz.com/overview/onboarding/submit-for-review.md): Send your completed onboarding package to the SimZ team. - [Drafts and Progress](https://docs.simz.com/overview/onboarding/drafts-and-progress.md): Save onboarding work before final submission. - [Account Activation and Login](https://docs.simz.com/overview/sim-z-portal/account-activation-and-login.md): Activate your SimZ Portal account from the set-password email and sign in for the first time. - [Portal Features](https://docs.simz.com/overview/sim-z-portal/portal-features.md): A tour of the SimZ Portal — dashboard, active calls, agents, call history, call audit, webhooks, and account settings. - [Managing Team Members](https://docs.simz.com/overview/sim-z-portal/managing-team-members.md): Invite teammates, approve self-registrations, and manage roles and account status as a company admin. - [Plans and Usage](https://docs.simz.com/overview/billing/plans-and-usage.md): Understand SimZ subscription plans, usage, and billing period data. - [Credits and Recharge](https://docs.simz.com/overview/billing/credits-and-recharge.md): View credit balance, transactions, promo credits, and recharge options. - [Payment Methods](https://docs.simz.com/overview/billing/payment-methods.md): Manage saved payment methods for SimZ billing. - [Invoices](https://docs.simz.com/overview/billing/invoices.md): View invoice lists, monthly invoices, details, and PDFs. - [Promo Codes](https://docs.simz.com/overview/billing/promo-codes.md): Redeem eligible promo codes for SimZ credits. - [Quickstart](https://docs.simz.com/overview/lead-receive-api/quickstart.md): Submit your first leads to a SimZ agent. - [API Keys](https://docs.simz.com/overview/lead-receive-api/api-keys.md): Use company API keys for the Lead Receive API. - [Submit Leads](https://docs.simz.com/overview/lead-receive-api/submit-leads.md): Request format and behavior for lead submission. - [Batch Management](https://docs.simz.com/overview/lead-receive-api/batch-management.md): Check batch status and pause, resume, or cancel accepted lead backlog. - [Phone Numbers and Validation](https://docs.simz.com/overview/lead-receive-api/phone-numbers-and-validation.md): How SimZ validates and normalizes submitted lead phone numbers. - [Custom Data](https://docs.simz.com/overview/lead-receive-api/custom-data.md): Attach client-defined metadata to leads and webhook payloads. - [Dynamic Variables](https://docs.simz.com/overview/lead-receive-api/dynamic-variables.md): Register your own prompt variables and send a value for each lead. - [Errors and Rate Limits](https://docs.simz.com/overview/lead-receive-api/errors-and-rate-limits.md): Understand common Lead Receive API errors and retry behavior. - [Answer Machine Detection](https://docs.simz.com/overview/call-life-cycle/answer-machine-detection.md): How SimZ avoids spending AI time and call credits on voicemail, answering machines, and fax lines. - [Silence Handling and Auto Hangup](https://docs.simz.com/overview/call-life-cycle/silence-handling-and-auto-hangup.md): How SimZ responds to a silent client after a call connects, and when it can end the call automatically. - [Quickstart](https://docs.simz.com/overview/call-export-api/quickstart.md): Pull your company's call history, transcripts and recordings into your own system. - [Calls, Transcripts and Recordings](https://docs.simz.com/overview/call-export-api/calls-transcripts-and-recordings.md): The three Call Export endpoints and the artifact status model. - [Errors and Rate Limits](https://docs.simz.com/overview/call-export-api/errors-and-rate-limits.md): Error codes, rate limits and retry guidance for the Call Export API. - [Webhook Events](https://docs.simz.com/overview/webhooks/webhook-events.md): Receive SimZ call lifecycle and audit events at your endpoint. - [Configure Webhooks](https://docs.simz.com/overview/webhooks/configure-webhooks.md): Create and manage webhook endpoints for SimZ events. - [Verify Signatures](https://docs.simz.com/overview/webhooks/verify-signatures.md): Verify SimZ webhook signatures with HMAC-SHA256. - [Delivery Logs and Retries](https://docs.simz.com/overview/webhooks/delivery-logs-and-retries.md): Understand webhook attempts, retry settings, timeouts, and logs. - [Manual Webhook Retry](https://docs.simz.com/overview/webhooks/manual-webhook-retry.md): Manually redeliver webhook events from the SimZ delivery logs. - [Webhook Testing](https://docs.simz.com/overview/webhooks/webhook-testing.md): Send test payloads to validate your webhook endpoint. - [Changelog](https://docs.simz.com/overview/resources/changelog.md): Product and documentation updates for SimZ clients - [Changelog (all entries)](https://docs.simz.com/overview/resources/changelog/llms.txt) - [FAQ](https://docs.simz.com/overview/resources/faq.md): Frequently asked questions about SimZ onboarding, billing, APIs, and webhooks. - [Troubleshooting](https://docs.simz.com/overview/resources/troubleshooting.md): Common fixes for login, onboarding, API, webhook, and billing issues. - [Status Values](https://docs.simz.com/overview/resources/status-values.md): Reference for common SimZ statuses used in docs and APIs. - [API Reference Overview](https://docs.simz.com/api-reference/overview/api-reference-overview.md): Public SimZ API reference for submitting leads and exporting call history. ## API Docs - [Submit leads to an agent](https://docs.simz.com/api-reference/sim-z-integration-api/lead-receive/submit-leads.md): SimZ Integration API > Lead Receive - [Get batch status](https://docs.simz.com/api-reference/sim-z-integration-api/batch-management/get-batch-status.md): SimZ Integration API > Batch Management - [Pause a batch](https://docs.simz.com/api-reference/sim-z-integration-api/batch-management/pause-batch.md): SimZ Integration API > Batch Management - [Resume a paused batch](https://docs.simz.com/api-reference/sim-z-integration-api/batch-management/resume-batch.md): SimZ Integration API > Batch Management - [Cancel a batch](https://docs.simz.com/api-reference/sim-z-integration-api/batch-management/cancel-batch.md): SimZ Integration API > Batch Management - [Pause all dispatchable batches](https://docs.simz.com/api-reference/sim-z-integration-api/batch-management/pause-all-batches.md): SimZ Integration API > Batch Management - [Cancel all controllable batches](https://docs.simz.com/api-reference/sim-z-integration-api/batch-management/cancel-all-batches.md): SimZ Integration API > Batch Management - [List calls in a time window](https://docs.simz.com/api-reference/sim-z-integration-api/call-export/list-calls.md): SimZ Integration API > Call Export - [Retrieve transcripts for specific calls](https://docs.simz.com/api-reference/sim-z-integration-api/call-export/retrieve-calls.md): SimZ Integration API > Call Export - [Download a call recording](https://docs.simz.com/api-reference/sim-z-integration-api/call-export/download-recording.md): SimZ Integration API > Call Export ## OpenAPI Specification - [OpenAPI JSON](https://docs.simz.com/openapi.json): raw OpenAPI 3.1 specification for this API, JSON format - [OpenAPI YAML](https://docs.simz.com/openapi.yaml): raw OpenAPI 3.1 specification for this API, YAML format