# Voice Agents

## Docs

- [Create AI Assistant](https://docs.miraiminds.co/api-reference/assistant/create-ai-assistant.md): Creates a new AI assistant with the specified configuration. The `variant.type` determines the assistant's behavior and the required `variant.config` structure.
- [Get AI Assistant](https://docs.miraiminds.co/api-reference/assistant/get-ai-assistant.md): Fetches a single assistant by ID. Returns the full internal assistant configuration including variant config, agent identity, callSettings, analysisPlan, and knowledgeBase.
- [List AI Assistants](https://docs.miraiminds.co/api-reference/assistant/list-ai-assistants.md): Returns all assistants in the current workspace. Each item carries the **same payload** as the get-by-id endpoint (`GET /v1/admin/assistant/get/{assistantId}`), so no field selection is needed. Takes no query parameters or request body.
- [Update AI Assistant](https://docs.miraiminds.co/api-reference/assistant/update-ai-assistant.md): Updates an existing assistant's configuration. All fields are optional — only the provided fields will be updated. The variant type cannot be changed. Any active campaigns for this assistant will be briefly paused and resumed during the update.
- [Abort Call](https://docs.miraiminds.co/api-reference/call/abort-call.md): Aborts a call that is queued or scheduled for retry. This operation is allowed when the call has no status (initial queue) or has a status of: 'busy', 'failed', 'no-answer', 'rescheduled', 'validation-failed'. It is NOT allowed if the call is 'in-progress', 'completed', 'ended', 'timeout', or alread…
- [Call Events Webhook](https://docs.miraiminds.co/api-reference/call/call-events-webhook.md): Receives call status and action events
- [Initiate AI Call](https://docs.miraiminds.co/api-reference/call/initiate-ai-call.md)
- [Initiate AI Web Call](https://docs.miraiminds.co/api-reference/call/initiate-ai-web-call.md)
- [Receive Shiprocket NDR webhook](https://docs.miraiminds.co/api-reference/call/receive-shiprocket-ndr-webhook.md): Queues an NDR follow-up call for an assistant whose `variant.type` is `ndr_followup`. If `variant.config.ndr_followup.webhookToken` is configured, send the same value in the `x-api-key` header.
- [Update Call Payload](https://docs.miraiminds.co/api-reference/call/update-call-payload.md): Updates the `payload` of a queued call recipient. Allowed only when the call has not yet been attempted.
- [Introduction](https://docs.miraiminds.co/api-reference/introduction.md): Complete reference for the Voice Agents REST API.
- [Complete Knowledge Base Upload](https://docs.miraiminds.co/api-reference/knowledge-base/complete-knowledge-base-upload.md): Finalises an upload session and triggers background processing (chunking, indexing, embedding). Returns a `knowledgeBaseId` you can use to poll status.
- [Delete Knowledge Base Collection](https://docs.miraiminds.co/api-reference/knowledge-base/delete-knowledge-base-collection.md): Permanently deletes a knowledge base collection and all its indexed data. This action cannot be undone.
- [Get Knowledge Base File](https://docs.miraiminds.co/api-reference/knowledge-base/get-knowledge-base-file.md): Returns a single knowledge base file by ID including its processing status. Poll this endpoint after completing an upload to check when `status` changes to `ready`. Once `ready`, add the file to `knowledgeBase.documents` on the assistant.
- [List Knowledge Base Files](https://docs.miraiminds.co/api-reference/knowledge-base/list-knowledge-base-files.md): Returns all uploaded knowledge base files for the current workspace. Use the returned file URL to set in `knowledgeBase.documents` on an assistant. Use the `collectionName` if manually configuring the RAG tool.
- [Start Knowledge Base Upload Session](https://docs.miraiminds.co/api-reference/knowledge-base/start-knowledge-base-upload-session.md): Creates an upload session for a new knowledge base document. Returns a `sessionId` used for the subsequent chunk upload and complete calls.
- [Upload Knowledge Base Chunk](https://docs.miraiminds.co/api-reference/knowledge-base/upload-knowledge-base-chunk.md): Uploads a single chunk of a file to an existing upload session. Send chunks sequentially starting from `chunkIndex: 0`. Use `multipart/form-data` with a `chunk` binary field and a `chunkIndex` form field.
- [Onboard a custom workspace](https://docs.miraiminds.co/api-reference/onboarding/onboard-a-custom-workspace.md): Creates a new **custom** workspace under the authenticated organization. Use this where you build assistants from scratch with your own system prompts and variables. The organization is resolved from the public/private key pair. A default outbound telephony number is auto-assigned in production.
- [Onboard a Shopify store (Shopify merchants only)](https://docs.miraiminds.co/api-reference/onboarding/onboard-a-shopify-store-shopify-merchants-only.md): Shopify-specific onboarding. Uploads the store's identity, trust metrics, and policies. Returns the Workspace ID and Billing Configuration. **For all other integrations, use `POST /v2/workspace/onboard/custom` instead.**
- [Archive Organization or Workspace](https://docs.miraiminds.co/api-reference/organization/archive-organization-or-workspace.md): Archives an organization or workspace by ID. When archiving an organization, all associated workspaces, assistants and campaigns are also archived in a cascading manner. When archiving a workspace, all its associated assistants and campaigns are archived. Requires admin or organization_admin role.
- [Unarchive Organization or Workspace](https://docs.miraiminds.co/api-reference/organization/unarchive-organization-or-workspace.md): Unarchives a previously archived organization or workspace by ID. When unarchiving an organization, all associated workspaces, assistants and campaigns are also unarchived in a cascading manner. When unarchiving a workspace, the parent organization must not be archived; if the parent organization is…
- [platform health status](https://docs.miraiminds.co/api-reference/setting/platform-health-status.md): Returns whether the platform is currently under maintenance. No authentication required.
- [Get a single demo flow](https://docs.miraiminds.co/api-reference/showcase/get-a-single-demo-flow.md)
- [Get a single real customer call](https://docs.miraiminds.co/api-reference/showcase/get-a-single-real-customer-call.md)
- [List demo flows](https://docs.miraiminds.co/api-reference/showcase/list-demo-flows.md): Returns the product demo flows shown in the showcase page. These are produced demos of each use case, not real customer recordings.
- [List real customer call recordings](https://docs.miraiminds.co/api-reference/showcase/list-real-customer-call-recordings.md): Returns real call recordings made for live stores. Optionally filter by call category or language.
- [Purchase an available phone number](https://docs.miraiminds.co/api-reference/telephony/purchase-an-available-phone-number.md): Purchases a phone number for the organization from the telephony provider. The organization is charged the setup fee and recurring monthly rate; a `402` is returned if the organization has insufficient credit balance.
- [Release a purchased phone number](https://docs.miraiminds.co/api-reference/telephony/release-a-purchased-phone-number.md): Releases a previously purchased phone number back to the provider and marks the record as `released`. Recurring billing for the number stops.
- [Search available phone numbers](https://docs.miraiminds.co/api-reference/telephony/search-available-phone-numbers.md): Returns a list of phone numbers available to purchase from the configured telephony provider, filtered by country and (optionally) a matching pattern.
- [Create an API tool](https://docs.miraiminds.co/api-reference/tools/create-an-api-tool.md): Creates a user-defined API tool the assistant can call. The `name` must be unique within the workspace (a slug is auto-generated from it).
- [Delete an API tool](https://docs.miraiminds.co/api-reference/tools/delete-an-api-tool.md): Soft-deletes an API tool owned by the current workspace.
- [List workspace API tools](https://docs.miraiminds.co/api-reference/tools/list-workspace-api-tools.md): Lists all user-defined API tools owned by the current workspace.
- [Update an API tool](https://docs.miraiminds.co/api-reference/tools/update-an-api-tool.md): Updates an existing API tool. All fields are optional — only provided fields are updated.
- [Get Voice Gallery](https://docs.miraiminds.co/api-reference/voice-gallery/get-voice-gallery.md)
- [Assistant Sandbox](https://docs.miraiminds.co/developers/assistant-sandbox.md): Test and iterate on your voice assistant's system prompt in real-time without affecting your production configuration.
- [Call Lifecycle & Webhooks](https://docs.miraiminds.co/developers/call-lifecycle-events.md): Understand the lifecycle of a voice call and how to handle webhook events.
- [Create Assistant](https://docs.miraiminds.co/developers/create-assistant.md): Create a new voice assistant with specific configuration.
- [Customer Lifecycle](https://docs.miraiminds.co/developers/customer-lifecycle.md): End-to-end guide for onboarding a brand, creating an AI agent, initiating calls, aborting them, and handling webhook events.
- [Developer Introduction](https://docs.miraiminds.co/developers/introduction.md): Get started with the Voice Agents API to build programmatic voice interactions.
- [Make a Call](https://docs.miraiminds.co/developers/make-a-call.md): Trigger an outbound call from a specific voice assistant to a target phone number.
- [Webhook Signature Verification](https://docs.miraiminds.co/developers/webhook-signature.md): Learn how to verify webhook signatures to ensure authenticity and integrity.
- [Campaign Management](https://docs.miraiminds.co/general/campaign.md): Learn how to create and manage voice campaigns with CSV data or API integration
- [Frequently Asked Questions](https://docs.miraiminds.co/general/faq.md): Answers to all your questions
- [Voice Agent Overview](https://docs.miraiminds.co/general/overview.md): Understand what voice agents are, how they work, and how they can transform your customer interactions.
- [Roadmap](https://docs.miraiminds.co/general/roadmap.md): What is shipping next — tiers, node graphs, the orchestration platform, model APIs, voices and integrations — with target dates.
- [Billing & tiers](https://docs.miraiminds.co/general/tiers.md): What a minute costs, how minutes are counted, what each tier can do, and what happens at zero balance.
- [Abandon Cart Recovery](https://docs.miraiminds.co/guides/abandon-cart-recovery.md): Complete guide to setting up automated abandon cart recovery using Voice Agents with GoKwik integration and Shopify coupon automation.
- [How Discounts Work](https://docs.miraiminds.co/guides/how-discounts-work.md): Understanding the intelligent discount system with applied and additional discounts, including how voice agents offer context-aware deals during calls.
- [Mirai Voice](https://docs.miraiminds.co/index.md): AI voice agents that make real phone calls — ₹1 a minute, on our own infrastructure in India.
- [Google Calendar](https://docs.miraiminds.co/integrations/google-calendar.md): Voice agent can access and book your google calendar on call
- [Klaviyo Integration](https://docs.miraiminds.co/integrations/klaviyo.md): Integrate Voice Agent with Klaviyo
- [Limechat Integration](https://docs.miraiminds.co/integrations/limechat.md): Connect your Limechat account to enable voice agents for customer support and automated messaging assistance.
- [Shopify Integration](https://docs.miraiminds.co/integrations/shopify.md): Connect your Shopify store to enable voice agents for customer support, order management, and automated sales assistance.
- [WhatsApp Integration](https://docs.miraiminds.co/integrations/whatsapp.md): Connect WhatsApp Business API with Voice Agents to enable seamless customer communication through voice and text messaging.
- [B2B](https://docs.miraiminds.co/usecases/b2b.md): Voice Agents has deep integration with shopify
- [Healthcare](https://docs.miraiminds.co/usecases/healthcare.md): Voice Agents has deep integration with shopify
- [Retail](https://docs.miraiminds.co/usecases/retail.md): Voice Agents has deep integration with shopify
- [Assistants](https://docs.miraiminds.co/v1/assistants.md): Create, read, list and update v1 assistants — prompts, identity, variants, call settings and analysis plans.
- [Calls](https://docs.miraiminds.co/v1/calls.md): Initiate outbound calls, start web calls, abort queued calls and update a queued call's payload.
- [Knowledge base](https://docs.miraiminds.co/v1/knowledge-base.md): Upload documents for retrieval-augmented answers — chunked upload, indexing status, collections.
- [v1 API (stable)](https://docs.miraiminds.co/v1/overview.md): The original Voice Agents API — workspaces, assistants, calls, telephony, tools and knowledge base.
- [Telephony](https://docs.miraiminds.co/v1/telephony.md): Search, purchase and release phone numbers from the number pool.
- [API tools](https://docs.miraiminds.co/v1/tools.md): Give an assistant HTTP tools it can call mid-conversation.
- [Webhooks](https://docs.miraiminds.co/v1/webhooks.md): v1 lifecycle events, the action events, and the x-signature verification scheme.
- [Workspaces & organizations](https://docs.miraiminds.co/v1/workspaces.md): Onboard a workspace, archive and unarchive organizations and workspaces.
- [Agents](https://docs.miraiminds.co/v2/agents.md): Create, read, update and delete the reusable configuration a call runs.
- [Calls](https://docs.miraiminds.co/v2/calls.md): Place outbound calls, inspect their status, abort them, and list history.
- [Errors](https://docs.miraiminds.co/v2/errors.md): One error envelope, every status code and error code, and what to do about each.
- [FAQ](https://docs.miraiminds.co/v2/faq.md): Short answers to the questions developers actually ask about the Mirai Voice API.
- [Limits & compliance](https://docs.miraiminds.co/v2/limits.md): Rate limits, concurrency, payload ceilings, and the India calling-window and DNC rules you are responsible for.
- [Migrating from v1](https://docs.miraiminds.co/v2/migration.md): Endpoint-by-endpoint and field-by-field mapping from the v1 API to v2, and what has no v2 equivalent yet.
- [API overview](https://docs.miraiminds.co/v2/overview.md): REST API for placing AI voice calls. One auth header, predictable envelopes, server-minted IDs.
- [Quickstart](https://docs.miraiminds.co/v2/quickstart.md): Get a key, create an agent, place a real call and receive the webhook — in five minutes.
- [Voices](https://docs.miraiminds.co/v2/voices.md): Choosing a voice_id for your agent, and the one caveat about the language field.
- [Wallet](https://docs.miraiminds.co/v2/wallet.md): Check your prepaid balance and read the transaction ledger.
- [Webhooks](https://docs.miraiminds.co/v2/webhooks.md): Signed lifecycle events — event types, signature verification, retries and idempotency.

## OpenAPI Specs

- [swagger](https://api.voice-agents.miraiminds.co/swagger.yaml)