> ## Documentation Index > Fetch the complete documentation index at: https://docs.miraiminds.co/llms.txt > Use this file to discover all available pages before exploring further. # Update a destination > Rename it, move it to a new URL, replace its headers or pause it (`enabled: false`). Pausing holds queued requests; their 24-hour deadline keeps running. Send the current `if_revision`. ## OpenAPI ````yaml /api-reference/openapi.json patch /v2/webhooks/endpoints/{webhook_endpoint_id} openapi: 3.1.0 info: title: Mirai Voice API version: 2026-10-20.turn-taking description: >- The v2 API for voice agents, calls, campaigns, phone numbers and speech. Every request carries `Authorization: Bearer sk_live_…`. Generated from the API's own contract and its Postman collection. servers: - url: https://sandbox.voice.miraiminds.co description: 'Sandbox: trial workspaces, before your company goes live' - url: https://prod.voice.miraiminds.co description: 'Production: workspaces that have gone live' security: - bearerAuth: [] tags: - name: Agents description: >- An agent is what a call runs: its prompt (or a node flow, see the Flows section), voice, language and limits. Write it once and dial it as often as you like; each call fills in its own `variables`. Every save creates a new revision. You can read old revisions, roll back to one, and publish a draft when it is ready. None of the requests here place a call or charge your wallet. - name: Calls description: >- Place a call, follow it while it runs, then read what happened: the transcript, the recording, the post-call analysis. `POST /v2/calls` answers before the phone rings, with an id. Everything after that is about that id. Every call has a live event stream, phone calls included, so your own dashboard can show a call as it happens. Live control works on browser calls (`channel: "web"`) and realtime sessions only; a phone call answers it with `400 unsupported_channel`. - name: Flows description: >- A node-based agent runs the call as a graph of steps. Each node has its own instructions, and the agent moves to the next node when a transition's condition is met, so a call with branches (wrong person, not now, reschedule) stays easy to follow and to change. The usual path: draft a graph from a brief or from recordings of your real calls, check it, test it with simulated calls, then save it on an agent. Drafting, transcribing and testing use AI models and charge your wallet; checking, saving and reading are free. Full guide: https://docs.miraiminds.co/v2/node-agents - name: Tools and secrets description: >- Connect your own APIs to an agent. A tool runs at one of three moments: * `pre_call`, before dialling: fetch context for the greeting, or skip the call. * `on_call`, when the agent decides to use it mid-conversation: look something up, book something. * `post_call`, after the call has settled: send the outcome to your CRM, schedule a call back. The order here is the order you'd use them in: see what's available, store your credential as a secret, add a tool, test it against your endpoint, then read each call's tool runs. Tools themselves cost nothing extra. Tool definitions use Mirai's own templates, like `{{ args.date }}` and `{{ secrets.crm_key }}`. A definition that doesn't validate comes back as a list, so you can fix everything at once: `{"error": "invalid_tools", "details": [{"path", "message"}]}`. Everything else uses the usual `{"error": {"code", "message"}}`. - name: Campaigns description: >- Call a whole list with one agent. Upload contacts, say which days and hours the campaign may ring, and start it. From then on it dials by itself: it paces itself, waits overnight, retries calls that didn't connect, skips numbers on your do-not-call list, and pauses itself when its budget or your wallet runs out. Campaign calls are ordinary calls. They show up in `GET /v2/calls`, send the same `call.*` webhooks and bill the same per-minute rate. In a sandbox workspace every campaign runs and bills at T5 (₹5 a minute), whatever tier you ask for. Money on a campaign is in **paise**: `"budget_paise": 50000` is ₹500. The requests run top to bottom: create saves `campaign_id`, and the rest use it. Starting a campaign rings every contact on it, so put numbers you're allowed to call in the bodies first. - name: Do-not-call list description: >- Numbers your campaigns will never dial. The list covers every campaign in the workspace, including ones that are already running: it's checked at the moment a contact is about to be called, so a number added mid-campaign is skipped from then on. A skipped contact stays in its campaign as `suppressed` and costs nothing. It doesn't apply to single calls placed with `POST /v2/calls`; check the list yourself before those if you need to. It's your own list, not the national DND register, and adding a number here doesn't meet your DND obligations. - name: Phone numbers description: >- The numbers your agents answer. Each one comes from the **Telephony** section: * **Rented from Mirai.** Once the rental is active, the number shows up here by itself (`ownership: managed`). * **From your own Plivo account.** Connect the account in Telephony, list its numbers, then bring one here with [Import a Plivo number](/api-reference/phone-numbers/import-a-plivo-number) (`ownership: customer`). Plivo keeps billing you for it. After that it's two steps, in this order: [Assign an agent](/api-reference/phone-numbers/assign-an-agent) (who answers), then [Turn on incoming calls](/api-reference/phone-numbers/turn-on-incoming-calls). `state` is `imported` until calls are on and `ready` after; `error` means the last attempt to turn calls on failed, and `setup_error` says why. Every change sends the number's current `version`, and each change raises it by one. If you're not sure what it is, read the number first; a stale version is a 409 `conflict` and changes nothing. To call out from one of your numbers, place a call with `phone_number_id` set to its id once it is `ready` (Indian destinations only). Calls on your numbers are billed like any other call. Every number also says how it is doing in `health`: `state` is `active`, `warming` (its first week, at half its pool's pace), `resting`, `cooling` (rested three times in a day; waits for you) or `retired`, with this hour's attempts and seven days of answers. You can rest, resume and retire your own numbers; a resting or retired number still answers calls to it. - name: Phone pools description: >- A pool is a group of your own phone numbers that a campaign, an agent or a single call can ring from. Each call takes the number best placed for it: a number a contact has already been rung from stays theirs on a retry, numbers in the contact's own circle come first, and the pool's pace (`max_per_hour`, per number) is held across every campaign and API call at once. A number whose answers drop well below its pool-mates' rests on its own for 45 minutes. Point a campaign at a pool with `pool_id` on [Create a campaign](/api-reference/campaigns/create-a-campaign), an agent with `calls_from: {"pool_id": …}`, or one call with `pool_id` on [Place a call](/api-reference/calls/place-a-call). `pool_id` and `phone_number_id` never go together. With nothing chosen, calls come from the agent's setting, then the pool marked `default_for_campaigns`, then the Mirai shared line. A call's `calls_from_source` is `pool` (with `pool_id`) when a pool picked its number. A single call on a pool whose numbers are all resting or at their pace this hour answers 409 `pool_busy` with `Retry-After`; one with no number that can call, 409 `pool_unavailable`. A campaign doesn't fail: it waits and carries on. `purpose` is what the calls are for: `outreach` (promotional), `reminders`, `support` or `other`. It sets the starting pace: 40 an hour for support, 60 otherwise. Pools are free; numbers are billed as numbers. - name: Telephony description: >- Getting a phone number for your agent. There are two ways, and a workspace can use both. **1. Rent a number from Mirai.** ₹500 a month, paid as ₹1,500 from your wallet every three months, renewing until you turn it off. Indian numbers need a business verification that Plivo approves once: read the requirements, submit your details and documents, then refresh until it's `accepted`. After that: search, quote, rent. The rented number appears in **Phone numbers** by itself. **2. Connect your own Plivo account.** Plivo keeps billing you directly. Connect it with your Auth ID and Auth Token, list the numbers it owns, and bring one over with [Import a Plivo number](/api-reference/phone-numbers/import-a-plivo-number). A Plivo main account can also rent new numbers through the same search → quote → rent requests, with its connection id as `account`. Either way you finish in **Phone numbers**: assign the agent that answers, then turn on incoming calls. The last two requests verify your own phone, so the workspace can ring it from Mirai's shared test number (test calls are placed from the Numbers page in the console). Indian (+91) numbers only for now. If phone numbers aren't available on the host you're calling, every request here answers 503 `telephony_unavailable`. - name: Transcriptions description: >- Turn a recorded call (or any recording) into a transcript with speakers and timestamps. Hindi, English, Gujarati and mixed speech are written the way they were spoken, never translated. ₹18 per hour of audio; failed and degraded jobs are free. - name: Speech to text description: >- Speech to text in ten languages, two ways: send one recording and get its text back in the same request ([Transcribe a recording](/api-reference/speech-to-text/transcribe-a-recording)), or stream live audio over one WebSocket per call and read partial transcripts while people speak, then one final transcript per utterance. Language codes: hi-IN, en-IN, gu-IN, mr-IN, pa-IN, bn-IN, ta-IN, te-IN, kn-IN or ml-IN. `wss://sandbox.voice.miraiminds.co/v1/audio/transcriptions/stream?language_code=hi-IN&encoding=mulaw&sample_rate=8000&endpointing=manual` (`wss://prod.voice.miraiminds.co` once your company has gone live), with the header `Authorization: Bearer sk_live_YOUR_API_KEY`. 8 or 16 kHz, 16-bit PCM, μ-law or A-law. A browser uses `?token=` from [Mint stream tokens](/api-reference/speech-to-text/mint-stream-tokens) instead, because it cannot set headers on a WebSocket. Send JSON text frames: `{"event": "speech_start"}`, then `{"event": "audio_input", "audio": ""}` as the audio arrives, then `{"event": "speech_end"}`; `{"event": "end"}` closes the session. You receive `session.begin` first, `transcript.partial` while an utterance is open, exactly one `transcript.final` per utterance, and `session.end` with `audio_seconds_billed` and `cost_paise`. Every event, both endpointing modes, limits and errors: https://docs.miraiminds.co/v2/stt-quickstart - name: Text to speech description: >- Turn text into speech in one request, and read back what each request cost. - name: Wallet description: >- Your prepaid balance and every line that moved it. Calls, text to speech, flow drafts, transcriptions and number rentals all debit the same wallet. - name: Webhooks description: >- Get call events at your own HTTPS URL, signed, retried and kept for 30 days. 1. [Create a destination](/api-reference/webhooks/create-a-destination) with your URL. Save the `signing_secret` from that answer: it is shown once. 2. [Subscribe a destination to events](/api-reference/webhooks/subscribe-a-destination-to-events), for one agent or the whole workspace. `call.completed` arrives when a call ends; `call.processing.completed` when the recording, transcript, results and post-call tools have all settled. 3. [Send a test event](/api-reference/webhooks/send-a-test-event). It is a real POST to your URL with made-up call data and `test: true`. No call is placed. Every request carries `X-Mirai-Signature: t=,v1=`, an HMAC-SHA256 of `.`, and `X-Mirai-Signed-With`, which names the secret that signed it. A destination's requests are signed with its own Destination secret; the `webhook_url` you pass when creating a call is signed with your Call webhook secret, the one shown with your API keys. A URL that is both gets each event once, with one secret. Delivery is at least once, so keep each event `id` and skip ones you've already handled. Changes send the resource's current `revision` (`if_revision`); a stale one is a 409 and changes nothing. Until the webhook release reaches your workspace these routes answer 404. The same settings are in the console under Webhooks, and on each agent in Agent Studio. - name: Reference description: The voice catalogue, and the API contract as a machine-readable document. paths: /v2/webhooks/endpoints/{webhook_endpoint_id}: patch: tags: - Webhooks summary: Update a destination description: >- Rename it, move it to a new URL, replace its headers or pause it (`enabled: false`). Pausing holds queued requests; their 24-hour deadline keeps running. Send the current `if_revision`. operationId: update_webhook_endpoint parameters: - name: webhook_endpoint_id in: path required: true description: '' schema: type: string example: whe_01K9V2C4E6G8J0M2P4R6T8W0Y2 requestBody: required: true content: application/json: schema: additionalProperties: false properties: enabled: type: boolean headers: additionalProperties: type: string maxProperties: 16 type: object if_revision: minimum: 1 type: integer name: maxLength: 100 minLength: 1 type: string url: format: uri maxLength: 2048 minLength: 1 pattern: ^https:// type: string required: - if_revision type: object examples: Update a destination: summary: Update a destination value: if_revision: 1 url: https://crm.example.com/mirai/v2/webhooks responses: '200': description: Updated content: application/json: schema: properties: created_at: format: date-time type: string enabled: type: boolean header_names: items: type: string type: array health: additionalProperties: type: integer type: object id: type: string method: type: string name: type: string object: type: string revision: type: integer url: type: string required: - id - object - name - url - method - header_names - enabled - revision - created_at type: object examples: Updated: summary: 200 — updated value: id: whe_01K9V2C4E6G8J0M2P4R6T8W0Y2 object: webhook_endpoint name: Customer CRM url: https://crm.example.com/mirai/v2/webhooks method: POST header_names: - Authorization enabled: true revision: 2 created_at: '2026-10-10T06:30:12.481Z' '409': description: Stale revision content: application/json: examples: Stale revision: summary: 409 — stale revision value: error: code: conflict message: >- The resource changed since you read it. Read it again, then retry with its revision. components: securitySchemes: bearerAuth: type: http scheme: bearer description: >- Your workspace secret key, `sk_live_` followed by 32 hex characters. Create one in the console under **Developers**. ```` This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.