# Mihu API Documentation

## Docs

- [Introduction](https://developers.mihu.ai/introduction.md): Welcome to Mihu API Documentation - Build powerful AI-driven voice and text conversations
- [Authentication](https://developers.mihu.ai/authentication.md): Learn how to authenticate your API requests with Mihu
- [Quickstart](https://developers.mihu.ai/quickstart.md): Get started with the Mihu API in minutes - make your first call
- [Services Overview](https://developers.mihu.ai/guides/services/overview.md): Overview of Mihu platform services and capabilities
- [AI Voice Agents](https://developers.mihu.ai/guides/services/voice-agents.md): Create and manage intelligent AI voice agents for automated phone conversations
- [WhatsApp Messaging](https://developers.mihu.ai/guides/services/whatsapp.md): Send automated WhatsApp messages using pre-approved templates
- [Campaign Management](https://developers.mihu.ai/guides/services/campaigns.md): Create and manage multi-channel communication campaigns
- [Contact Management](https://developers.mihu.ai/guides/services/contacts.md): Organize and manage your contact database with custom fields and segmentation
- [Mihu MCP Server](https://developers.mihu.ai/guides/mcp.md): Connect LLM clients to Mihu via the Model Context Protocol
- [Builder MCP Server](https://developers.mihu.ai/guides/builder-mcp.md): Build and run your own apps and integrations on Mihu from any MCP client
- [Webhooks](https://developers.mihu.ai/webhooks.md): Receive real-time notifications about events in your Mihu workspace
- [Monitoring & Logs](https://developers.mihu.ai/monitoring.md): Track your API requests, responses, and webhook deliveries in real-time
- [Error Handling](https://developers.mihu.ai/errors.md): Understand error codes, responses, and troubleshooting strategies for the Mihu API
- [Introduction](https://developers.mihu.ai/api-reference/introduction.md): Complete API reference for the Mihu platform
- [List agents](https://developers.mihu.ai/api-reference/agents/list-agents.md): Returns paginated agents with their configured settings, knowledge, rules, channels, and related res…
- [Create an agent](https://developers.mihu.ai/api-reference/agents/create-an-agent.md): Creates a new AI agent. Provide as much of the structured shape as you can in one call — a fully-for…
- [Create an agent from website documentation](https://developers.mihu.ai/api-reference/agents/create-an-agent-from-website-documentation.md): Crawls and analyzes a public website or documentation URL, decides the best agent identity and behav…
- [Analyze website documentation for agent creation](https://developers.mihu.ai/api-reference/agents/analyze-website-documentation-for-agent-creation.md): Crawls and analyzes a public website or documentation URL and returns structured business context (c…
- [Get one agent](https://developers.mihu.ai/api-reference/agents/get-one-agent.md): Returns the full API representation of one agent, including profile fields, voice/text settings, gui…
- [Replace/sync an agent](https://developers.mihu.ai/api-reference/agents/replacesync-an-agent.md): Synchronizes the agent with the supplied payload. This has the same behavior as PATCH: scalar fields…
- [Soft-delete an agent](https://developers.mihu.ai/api-reference/agents/soft-delete-an-agent.md): Soft-deletes the agent. Child records (notes, guidelines, training, intents, etc.) remain in the dat…
- [Update an agent](https://developers.mihu.ai/api-reference/agents/update-an-agent.md): Updates core agent fields, voice/text settings, and any included collection sections. Use PATCH for…
- [Replace agent guidelines](https://developers.mihu.ai/api-reference/agents/replace-agent-guidelines.md): Replaces all guidelines for the agent. Guidelines are short behavioral rules that shape how the agen…
- [Add a single guideline](https://developers.mihu.ai/api-reference/agents/add-a-single-guideline.md): Adds one guideline to the agent without changing existing guidelines. Use guidelines for concise beh…
- [Replace agent notes](https://developers.mihu.ai/api-reference/agents/replace-agent-notes.md): Replaces all notes for the agent. Notes are reference facts the agent can use during conversations,…
- [Add a single note](https://developers.mihu.ai/api-reference/agents/add-a-single-note.md): Adds one note to the agent without changing existing notes. Use notes for factual reference material…
- [Get the agent's email signature](https://developers.mihu.ai/api-reference/agents/get-the-agents-email-signature.md): Returns the email signature for this agent (the same value shown in the agent's Text Settings). It i…
- [Update the agent's email signature](https://developers.mihu.ai/api-reference/agents/update-the-agents-email-signature.md): Sets the email signature appended to this agent's outgoing emails (same value as the agent's Text Se…
- [Create or set the agent's email signature](https://developers.mihu.ai/api-reference/agents/create-or-set-the-agents-email-signature.md): Alias of PUT — a signature is a single value, so this creates it if none exists and replaces it othe…
- [Clear the agent's email signature](https://developers.mihu.ai/api-reference/agents/clear-the-agents-email-signature.md): Removes the agent's email signature by setting it to empty. Nothing is deleted from the account — th…
- [Replace agent procedures](https://developers.mihu.ai/api-reference/agents/replace-agent-procedures.md): Replaces all procedures for the agent, including their ordered steps. Procedures are multi-step inst…
- [Add a single procedure (with optional steps)](https://developers.mihu.ai/api-reference/agents/add-a-single-procedure-with-optional-steps.md): Adds one procedure to the agent without replacing existing procedures. Use procedures for ordered wo…
- [Replace agent training data](https://developers.mihu.ai/api-reference/agents/replace-agent-training-data.md): Replaces all training rows for the agent. Training rows are examples or knowledge snippets that help…
- [Add a single training data row](https://developers.mihu.ai/api-reference/agents/add-a-single-training-data-row.md): Adds one training row to the agent without changing existing training. Use training rows to provide…
- [Replace agent appointment settings and schedule assignments](https://developers.mihu.ai/api-reference/agents/replace-agent-appointment-settings-and-schedule-assignments.md): Configures which schedules an agent uses for booking and how the runtime AI should pick between them…
- [Delete a single note](https://developers.mihu.ai/api-reference/agents/delete-a-single-note.md): Deletes one note from the agent. Use this when a reference fact is outdated or should no longer be a…
- [Update a single note](https://developers.mihu.ai/api-reference/agents/update-a-single-note.md): Updates one note on the agent. Use this for small edits to reference facts without replacing the ful…
- [Delete a single guideline](https://developers.mihu.ai/api-reference/agents/delete-a-single-guideline.md): Deletes one guideline from the agent. Use this when a behavior rule no longer applies. Other guideli…
- [Update a single guideline](https://developers.mihu.ai/api-reference/agents/update-a-single-guideline.md): Updates one guideline on the agent. Use this to adjust a behavior rule or its ordering without repla…
- [Delete a single training row](https://developers.mihu.ai/api-reference/agents/delete-a-single-training-row.md): Deletes one training row from the agent. Use this when an example or response is outdated, wrong, or…
- [Update a single training row](https://developers.mihu.ai/api-reference/agents/update-a-single-training-row.md): Updates one training row on the agent. Use this to refine an example, intent label, or response with…
- [Delete a single procedure (and its steps)](https://developers.mihu.ai/api-reference/agents/delete-a-single-procedure-and-its-steps.md): Deletes one procedure and its steps from the agent. Use this when the workflow is obsolete or should…
- [Update a single procedure (and replace its steps if provided)](https://developers.mihu.ai/api-reference/agents/update-a-single-procedure-and-replace-its-steps-if-provided.md): Updates one procedure on the agent. Use this to rename a workflow, revise its description, or replac…
- [Phone numbers owned by an agent](https://developers.mihu.ai/api-reference/agents/phone-numbers-owned-by-an-agent.md): Returns the full phone-number records bound to this agent on any channel (call, SMS, WhatsApp). Same…
- [Channels and phone numbers for an agent](https://developers.mihu.ai/api-reference/agents/channels-and-phone-numbers-for-an-agent.md): Lists every phone number this agent answers on, with the channels (call, SMS, WhatsApp) the agent se…
- [Provision call channel for an agent](https://developers.mihu.ai/api-reference/agents/provision-call-channel-for-an-agent.md): Connects a purchased phone number to the agent's call channel and performs the required telephony pr…
- [Get all voice settings](https://developers.mihu.ai/api-reference/agents/get-all-voice-settings.md): Returns the agent's full voice settings block: interaction messages, interruption tuning, voice prof…
- [Get interaction settings](https://developers.mihu.ai/api-reference/agents/get-interaction-settings.md): Returns the conversation opening/closing messages and silence prompts used by the voice agent.
- [Update interaction settings](https://developers.mihu.ai/api-reference/agents/update-interaction-settings.md): Partial update of the agent's first/greeting/voicemail/end-call/silence messages. Only supplied fiel…
- [Get interruption settings](https://developers.mihu.ai/api-reference/agents/get-interruption-settings.md): Returns the interruption mode and the advance-mode overrides (endpointing delays, interruption windo…
- [Update interruption settings](https://developers.mihu.ai/api-reference/agents/update-interruption-settings.md): Updates the interruption mode (sensitive|balanced|never_stop|advance) and/or the advance-mode overri…
- [Get voice profile](https://developers.mihu.ai/api-reference/agents/get-voice-profile.md): Returns the agent's spoken language and the selected voice (uuid + display name).
- [Update voice profile](https://developers.mihu.ai/api-reference/agents/update-voice-profile.md): Updates the spoken language and/or the selected voice. The voice is chosen by its uuid from the voic…
- [Get supported voice tuning fields](https://developers.mihu.ai/api-reference/agents/get-supported-voice-tuning-fields.md): Returns the voice tuning fields supported by the agent's currently selected voice, each with its typ…
- [Update voice tuning](https://developers.mihu.ai/api-reference/agents/update-voice-tuning.md): Updates the voice tuning fields. The accepted fields depend on the agent's selected voice — call GET…
- [Get call behavior](https://developers.mihu.ai/api-reference/agents/get-call-behavior.md): Returns recording, background sound (on/off + ambience + volume), noise cancellation, silence timeou…
- [Update call behavior](https://developers.mihu.ai/api-reference/agents/update-call-behavior.md): Partial update of recording, background sound (on/off, ambience, volume), noise cancellation, silenc…
- [Get compliance settings](https://developers.mihu.ai/api-reference/agents/get-compliance-settings.md): Returns the EU GDPR and HIPAA compliance flags for the voice agent.
- [Update compliance settings](https://developers.mihu.ai/api-reference/agents/update-compliance-settings.md): Partial update of the EU GDPR and HIPAA compliance flags.
- [Get phone normalizers](https://developers.mihu.ai/api-reference/agents/get-phone-normalizers.md): Returns the outbound and inbound phone-number normalizer rules (default prefix, condition length, co…
- [Update phone normalizers](https://developers.mihu.ai/api-reference/agents/update-phone-normalizers.md): Partial update of the outbound and inbound phone-number normalizer rules. Each side accepts default_…
- [List webhooks for an agent](https://developers.mihu.ai/api-reference/agents/list-webhooks-for-an-agent.md): Returns webhooks configured for one agent. Use this to see which event notifications are delivered f…
- [Add a webhook to this agent](https://developers.mihu.ai/api-reference/agents/add-a-webhook-to-this-agent.md): Creates a webhook subscription for an agent. Use this to receive event notifications such as convers…
- [Get one webhook](https://developers.mihu.ai/api-reference/agents/get-one-webhook.md): Returns one agent webhook by UUID, including URL, subscribed events, active state, and whether a sig…
- [Delete a webhook](https://developers.mihu.ai/api-reference/agents/delete-a-webhook.md): Deletes one webhook from the agent. Use this to stop sending event notifications to that destination…
- [Update a webhook](https://developers.mihu.ai/api-reference/agents/update-a-webhook.md): Updates one agent webhook. Use this to change the destination URL, event subscriptions, signing secr…
- [List intents for an agent](https://developers.mihu.ai/api-reference/agents/list-intents-for-an-agent.md): Returns all intents configured for an agent. Intents define actions or integrations the agent can tr…
- [Create an intent](https://developers.mihu.ai/api-reference/agents/create-an-intent.md): Creates a custom intent for an agent. Use intents when the agent should recognize a user goal and op…
- [Get one intent](https://developers.mihu.ai/api-reference/agents/get-one-intent.md): Returns one intent with its trigger description, confidence threshold, webhook configuration, and pa…
- [Delete an intent](https://developers.mihu.ai/api-reference/agents/delete-an-intent.md): Deletes a custom intent and its parameters. Use this when an action or integration should no longer…
- [Update an intent](https://developers.mihu.ai/api-reference/agents/update-an-intent.md): Updates a custom intent. Use this to change trigger wording, confidence threshold, webhook target, r…
- [Get the intent's action (event)](https://developers.mihu.ai/api-reference/agents/get-the-intents-action-event.md): Returns the single action the intent performs when it fires. `event_type` is null when no action is…
- [Set the intent's action (event)](https://developers.mihu.ai/api-reference/agents/set-the-intents-action-event.md): Sets (replaces) the single action the intent performs. Pick `event_type` and provide its fields: - `…
- [Clear the intent's action (event)](https://developers.mihu.ai/api-reference/agents/clear-the-intents-action-event.md): Removes the intent's configured action. The intent itself remains; it just no longer performs an act…
- [Publish the intent's action (make it live)](https://developers.mihu.ai/api-reference/agents/publish-the-intents-action-make-it-live.md): Sets the configured event's status to `deployed` so the agent will run it at runtime. The event must…
- [Unpublish the intent's action (back to draft)](https://developers.mihu.ai/api-reference/agents/unpublish-the-intents-action-back-to-draft.md): Sets the event's status back to `draft` so the agent no longer runs it, without deleting the configu…
- [Test the intent's app action](https://developers.mihu.ai/api-reference/agents/test-the-intents-app-action.md): Runs the configured app action and returns the result — the same engine and safe-list the Studio/Flo…
- [Replace ALL routing rules for an agent (destructive)](https://developers.mihu.ai/api-reference/voice-ivr-&-guards/replace-all-routing-rules-for-an-agent-destructive.md): Wipes every existing routing rule on this agent and inserts the provided list. Use for bulk imports…
- [Add ONE routing rule (preserves existing rules)](https://developers.mihu.ai/api-reference/voice-ivr-&-guards/add-one-routing-rule-preserves-existing-rules.md): Appends a new routing rule. Existing rules are untouched. If `priority` is omitted, it defaults to (…
- [Replace ALL guard rules for an agent (destructive)](https://developers.mihu.ai/api-reference/voice-ivr-&-guards/replace-all-guard-rules-for-an-agent-destructive.md): Wipes every existing guard rule on this agent and inserts the provided list. Guards always take prec…
- [Add ONE guard rule (preserves existing rules)](https://developers.mihu.ai/api-reference/voice-ivr-&-guards/add-one-guard-rule-preserves-existing-rules.md): Appends a guard rule. Existing guards are untouched. `when_condition` and `then_action` are required…
- [Delete ONE routing rule (other rules untouched)](https://developers.mihu.ai/api-reference/voice-ivr-&-guards/delete-one-routing-rule-other-rules-untouched.md): Permanent removal. To temporarily disable instead of delete, PATCH the rule with `is_active: false`…
- [Partially update ONE routing rule](https://developers.mihu.ai/api-reference/voice-ivr-&-guards/partially-update-one-routing-rule.md): Updates only the fields you send. Other fields and other rules are untouched. Common uses: toggle `i…
- [Delete ONE guard rule (other guards untouched)](https://developers.mihu.ai/api-reference/voice-ivr-&-guards/delete-one-guard-rule-other-guards-untouched.md): Permanent removal. Removing a compliance/safety guard means the agent will no longer auto-handle tha…
- [Partially update ONE guard rule](https://developers.mihu.ai/api-reference/voice-ivr-&-guards/partially-update-one-guard-rule.md): Updates only the fields you send. Common uses: toggle `is_active` to disable a guard temporarily; ad…
- [Assign an SMS phone number to an agent](https://developers.mihu.ai/api-reference/agent-channel-bindings/assign-an-sms-phone-number-to-an-agent.md): Assigns one owned phone number to the agent for SMS conversations. Use this after purchasing or impo…
- [Unbind the SMS channel from this agent](https://developers.mihu.ai/api-reference/agent-channel-bindings/unbind-the-sms-channel-from-this-agent.md): Removes the agent's SMS channel binding. Use this when the agent should stop handling SMS on its cur…
- [Assign a WhatsApp number to an agent](https://developers.mihu.ai/api-reference/agent-channel-bindings/assign-a-whatsapp-number-to-an-agent.md): Assigns a connected WhatsApp Business number to the agent for WhatsApp messaging. Use this before se…
- [Assign a WhatsApp Calling number to an agent](https://developers.mihu.ai/api-reference/agent-channel-bindings/assign-a-whatsapp-calling-number-to-an-agent.md): Assigns a WhatsApp Business number to the agent for WhatsApp Calling. Use this when the agent should…
- [Unbind the WhatsApp channel from this agent](https://developers.mihu.ai/api-reference/agent-channel-bindings/unbind-the-whatsapp-channel-from-this-agent.md): Removes the agent's WhatsApp messaging binding. Use this when the agent should no longer answer or s…
- [Unbind WhatsApp Calling from this agent](https://developers.mihu.ai/api-reference/agent-channel-bindings/unbind-whatsapp-calling-from-this-agent.md): Removes the agent's WhatsApp Calling binding while keeping WhatsApp messaging unchanged. Use this wh…
- [Assign an Instagram account to an agent](https://developers.mihu.ai/api-reference/agent-channel-bindings/assign-an-instagram-account-to-an-agent.md): Assigns a connected Instagram business account to the agent. Use this before routing Instagram direc…
- [Unbind the Instagram channel from this agent](https://developers.mihu.ai/api-reference/agent-channel-bindings/unbind-the-instagram-channel-from-this-agent.md): Removes the agent's Instagram binding. Use this when Instagram messages should stop routing to this…
- [Assign a Facebook page (Messenger) to an agent](https://developers.mihu.ai/api-reference/agent-channel-bindings/assign-a-facebook-page-messenger-to-an-agent.md): Assigns a connected Facebook page to the agent for Messenger conversations. Use this before routing…
- [Unbind the Messenger channel from this agent](https://developers.mihu.ai/api-reference/agent-channel-bindings/unbind-the-messenger-channel-from-this-agent.md): Removes the agent's Messenger binding. Use this when Facebook page messages should stop routing to t…
- [Agentic web search and analysis](https://developers.mihu.ai/api-reference/agentic-search/agentic-web-search-and-analysis.md): Runs an agentic, web-grounded search for any research question and returns a written answer with sou…
- [Appointment lifecycle metrics (event-in-period semantics)](https://developers.mihu.ai/api-reference/analytics/appointment-lifecycle-metrics-event-in-period-semantics.md): Counters reflect events whose state transitioned during [from, to). created uses appointments.create…
- [Aggregated call metrics for a time window (authoritative call count)](https://developers.mihu.ai/api-reference/analytics/aggregated-call-metrics-for-a-time-window-authoritative-call-count.md): Returns volume, direction split, AI vs human handling, durations (seconds), outcomes, and cost for c…
- [Per-channel conversation rollup](https://developers.mihu.ai/api-reference/analytics/per-channel-conversation-rollup.md): Returns one entry per active channel with totals, direction split, durations (call-bearing channels…
- [Distribution of AI evaluations across sentiment, emotion, satisfaction, outcome, escalation, and knowledge gap](https://developers.mihu.ai/api-reference/analytics/distribution-of-ai-evaluations-across-sentiment-emotion-satisfaction-outcome-escalation-and-knowledge-gap.md): Returns aggregate evaluation distributions for sessions in a time range. Use this endpoint to unders…
- [Intent breakdown with outcome and per-channel distribution](https://developers.mihu.ai/api-reference/analytics/intent-breakdown-with-outcome-and-per-channel-distribution.md): Returns one entry per detected intent, sorted by count desc. Each entry carries success/fail outcome…
- [Cursor-paginated raw message export](https://developers.mihu.ai/api-reference/analytics/cursor-paginated-raw-message-export.md): Returns one row per message in [from, to). Subject to workspace policy: when ANALYTICS_MESSAGES_EXPO…
- [Cross-channel conversation-session metrics](https://developers.mihu.ai/api-reference/analytics/cross-channel-conversation-session-metrics.md): Returns volume, voice/text split, completion/timeout/active breakdowns, evaluation coverage, average…
- [List analyzer configurations](https://developers.mihu.ai/api-reference/contact-analyzers/list-analyzer-configurations.md): Returns analyzer settings. An analyzer tells the AI what to look for in a conversation and what to d…
- [Get a single analyzer](https://developers.mihu.ai/api-reference/contact-analyzers/get-a-single-analyzer.md): Returns one analyzer configuration by internal_id. Use this to inspect what the AI extracts, where t…
- [Update an analyzer configuration](https://developers.mihu.ai/api-reference/contact-analyzers/update-an-analyzer-configuration.md): Updates how one analyzer behaves. `update_behavior` controls what happens when the AI finds a value:…
- [Bulk update analyzers](https://developers.mihu.ai/api-reference/contact-analyzers/bulk-update-analyzers.md): Updates multiple analyzers in one request. Each item uses `internal_id` to choose the analyzer and m…
- [Initiate a new call](https://developers.mihu.ai/api-reference/call/initiate-a-new-call.md): Initiates a call if the specified agent exists, has valid call settings, and the participant's phone…
- [Get paginated list of calls](https://developers.mihu.ai/api-reference/call/get-paginated-list-of-calls.md): Returns call records with pagination and optional filters. Use this endpoint to monitor inbound and…
- [Get call details by UUID](https://developers.mihu.ai/api-reference/call/get-call-details-by-uuid.md): Returns one call by UUID with its status, direction, participant details, agent/contact/campaign con…
- [Send WhatsApp template message](https://developers.mihu.ai/api-reference/whatsapp/send-whatsapp-template-message.md): Sends a WhatsApp template message to a specified phone number using an agent's configured WhatsApp B…
- [Send an SMS message](https://developers.mihu.ai/api-reference/sms/send-an-sms-message.md): Sends an SMS message to a phone number using the specified agent's SMS configuration. The agent must…
- [Get all appointments (calendar)](https://developers.mihu.ai/api-reference/appointments/get-all-appointments-calendar.md): Returns appointments ordered by start time. Use filters to build calendar views by schedule, contact…
- [Create a new appointment](https://developers.mihu.ai/api-reference/appointments/create-a-new-appointment.md): Creates an appointment on a schedule. Use this when booking a time slot directly through the API. Pr…
- [Get a specific appointment](https://developers.mihu.ai/api-reference/appointments/get-a-specific-appointment.md): Returns full details for one appointment, including schedule, contact, status, notes, custom answers…
- [Update an appointment](https://developers.mihu.ai/api-reference/appointments/update-an-appointment.md): Updates an existing appointment. Use this to reschedule, change title or notes, update custom answer…
- [Delete an appointment](https://developers.mihu.ai/api-reference/appointments/delete-an-appointment.md): Deletes an appointment by UUID. Use this when a booked time slot should be removed from the calendar…
- [Update appointment status](https://developers.mihu.ai/api-reference/appointments/update-appointment-status.md): Changes only the appointment status. Use this to approve, move back to pending, or reject an appoint…
- [Get list of appointment requests](https://developers.mihu.ai/api-reference/appointment-requests/get-list-of-appointment-requests.md): Returns appointment requests ordered for review and scheduling workflows. Use this endpoint to find…
- [Create a new appointment request](https://developers.mihu.ai/api-reference/appointment-requests/create-a-new-appointment-request.md): Creates a proposed booking for a schedule. Use this when the requested time should be reviewed befor…
- [Get a specific appointment request](https://developers.mihu.ai/api-reference/appointment-requests/get-a-specific-appointment-request.md): Returns one appointment request by UUID, including requested time, contact details, schedule referen…
- [Cancel an appointment request](https://developers.mihu.ai/api-reference/appointment-requests/cancel-an-appointment-request.md): Cancels a pending appointment request without creating an appointment. Use this when the requester w…
- [Get available time slots for a schedule](https://developers.mihu.ai/api-reference/appointment-requests/get-available-time-slots-for-a-schedule.md): Returns available time slots for one schedule on a specific date. Use this before creating an appoin…
- [Get a user's assistant email channel config](https://developers.mihu.ai/api-reference/assistant-channels/get-a-users-assistant-email-channel-config.md)
- [Assign an email address to a user's assistant](https://developers.mihu.ai/api-reference/assistant-channels/assign-an-email-address-to-a-users-assistant.md): Detaches the address from whatever Agent currently owns it — an address serves one consumer at a tim…
- [Release a user's assigned email inbox](https://developers.mihu.ai/api-reference/assistant-channels/release-a-users-assigned-email-inbox.md)
- [List email addresses assignable to an assistant](https://developers.mihu.ai/api-reference/assistant-channels/list-email-addresses-assignable-to-an-assistant.md): Same address inventory the Mails Studio app manages. Excludes addresses already claimed by a differe…
- [Set 'Your email' and send the confirmation link](https://developers.mihu.ai/api-reference/assistant-channels/set-your-email-and-send-the-confirmation-link.md): A one-time confirmation link is emailed to this address. It only starts reaching the assistant after…
- [Get a user's assistant WhatsApp channel config](https://developers.mihu.ai/api-reference/assistant-channels/get-a-users-assistant-whatsapp-channel-config.md)
- [Assign a WhatsApp number to a user's assistant](https://developers.mihu.ai/api-reference/assistant-channels/assign-a-whatsapp-number-to-a-users-assistant.md): Detaches the number from whatever Agent currently owns it — a number serves one consumer at a time.
- [Release a user's assigned WhatsApp number](https://developers.mihu.ai/api-reference/assistant-channels/release-a-users-assigned-whatsapp-number.md)
- [List WhatsApp numbers assignable to an assistant](https://developers.mihu.ai/api-reference/assistant-channels/list-whatsapp-numbers-assignable-to-an-assistant.md): Same inventory the WhatsApp Studio/Channels app manages. Excludes numbers already claimed by a diffe…
- [Set 'Your number' — verified immediately, no link to click](https://developers.mihu.ai/api-reference/assistant-channels/set-your-number-—-verified-immediately-no-link-to-click.md): WhatsApp already authenticates the sending number at the transport level before its webhook ever rea…
- [Get a user's assistant SMS channel config](https://developers.mihu.ai/api-reference/assistant-channels/get-a-users-assistant-sms-channel-config.md)
- [Assign an SMS-enabled number to a user's assistant](https://developers.mihu.ai/api-reference/assistant-channels/assign-an-sms-enabled-number-to-a-users-assistant.md): Unlike email/WhatsApp, SMS routing isn't resolved from a database lookup per message — this makes a…
- [Release a user's assigned SMS number](https://developers.mihu.ai/api-reference/assistant-channels/release-a-users-assigned-sms-number.md): Does not revert the Telnyx webhook to any agent — there's no way to know which one should reclaim it…
- [List numbers already set up for SMS via an agent that can also feed an assistant](https://developers.mihu.ai/api-reference/assistant-channels/list-numbers-already-set-up-for-sms-via-an-agent-that-can-also-feed-an-assistant.md): Only numbers with an existing agent SMS binding are returned, not every SMS-capable number on the ac…
- [Set 'Your number' — verified immediately, no link to click](https://developers.mihu.ai/api-reference/assistant-channels/set-your-number-—-verified-immediately-no-link-to-click-1.md): Telnyx already authenticates the sending number at the transport level before its webhook ever reach…
- [Configure 2FA for a channel](https://developers.mihu.ai/api-reference/assistant-channels/configure-2fa-for-a-channel.md): Static PIN is the only verification method today. Enabling 2FA without ever having set a PIN fails —…
- [Get all availability types](https://developers.mihu.ai/api-reference/availability-types/get-all-availability-types.md): Returns every availability type in the workspace, ordered by name. Use this endpoint before creating…
- [Create a new availability type](https://developers.mihu.ai/api-reference/availability-types/create-a-new-availability-type.md): Creates a reusable availability policy for schedules. Use it when multiple schedules should share th…
- [Get a specific availability type](https://developers.mihu.ai/api-reference/availability-types/get-a-specific-availability-type.md): Returns one availability type by UUID, including booking duration, buffers, working-hours configurat…
- [Update an availability type](https://developers.mihu.ai/api-reference/availability-types/update-an-availability-type.md): Updates an existing availability type. Use this to change shared booking rules for schedules that de…
- [Delete an availability type](https://developers.mihu.ai/api-reference/availability-types/delete-an-availability-type.md): Deletes an availability type by UUID. Use this only after confirming it is no longer needed by sched…
- [List builders](https://developers.mihu.ai/api-reference/builders/list-builders.md): Returns all builders for the tenant (deployed code and AI-generated apps), newest first.
- [Create a builder from your own code](https://developers.mihu.ai/api-reference/builders/create-a-builder-from-your-own-code.md): Deploys the supplied files to a cloud sandbox and starts your app. Returns the running builder with…
- [Get a builder](https://developers.mihu.ai/api-reference/builders/get-a-builder.md)
- [Delete a builder](https://developers.mihu.ai/api-reference/builders/delete-a-builder.md): Deletes the sandbox VM. For code builders the source history is retained on the platform.
- [Start (wake) a builder](https://developers.mihu.ai/api-reference/builders/start-wake-a-builder.md)
- [Stop a builder](https://developers.mihu.ai/api-reference/builders/stop-a-builder.md): Halts the app; disk is kept. Start it again to resume.
- [Set idle auto-stop](https://developers.mihu.ai/api-reference/builders/set-idle-auto-stop.md): Sets the idle minutes before the builder auto-stops. Use 0 to keep it always-on.
- [Get builder logs](https://developers.mihu.ai/api-reference/builders/get-builder-logs.md): Returns the app's recent combined stdout/stderr.
- [Run a command in the builder](https://developers.mihu.ai/api-reference/builders/run-a-command-in-the-builder.md): Executes a shell command inside the builder's sandbox, from the app root, and returns its exit code…
- [Create SSH access](https://developers.mihu.ai/api-reference/builders/create-ssh-access.md): Creates time-limited SSH access to the builder's sandbox and returns a ready-to-run `ssh_command`, a…
- [Revoke SSH access](https://developers.mihu.ai/api-reference/builders/revoke-ssh-access.md): Revokes all SSH access to the builder's sandbox.
- [Recreate SSH access](https://developers.mihu.ai/api-reference/builders/recreate-ssh-access.md): Revokes the current SSH access and issues a fresh token + command. The builder must be running.
- [List files in the builder](https://developers.mihu.ai/api-reference/builders/list-files-in-the-builder.md): Lists files and folders in the builder's live filesystem.
- [Write a file to the builder](https://developers.mihu.ai/api-reference/builders/write-a-file-to-the-builder.md): Creates or overwrites a file in the builder's live filesystem. Optionally restart the app to apply c…
- [Read a file from the builder](https://developers.mihu.ai/api-reference/builders/read-a-file-from-the-builder.md)
- [List build conversations](https://developers.mihu.ai/api-reference/builders/list-build-conversations.md): Returns all AI build conversations for the tenant, newest first.
- [Start a build conversation](https://developers.mihu.ai/api-reference/builders/start-a-build-conversation.md): Describe what you want in one sentence and the AI builder takes it from there. This is the entry poi…
- [Get a build conversation](https://developers.mihu.ai/api-reference/builders/get-a-build-conversation.md): The polling endpoint that drives the whole conversation. Call it repeatedly (~every 2-3 seconds) aft…
- [Delete a build conversation](https://developers.mihu.ai/api-reference/builders/delete-a-build-conversation.md): Removes a build conversation from history. Any builder it already deployed is kept — delete that sep…
- [Answer the build conversation](https://developers.mihu.ai/api-reference/builders/answer-the-build-conversation.md): Reply to the questions the builder asked while in `gathering`. Send everything as one free-text `mes…
- [Change a deployed build (rebuild)](https://developers.mihu.ai/api-reference/builders/change-a-deployed-build-rebuild.md): A build conversation does not lock once `deployed` — you can keep refining it. Because /answers is o…
- [Approve a build conversation](https://developers.mihu.ai/api-reference/builders/approve-a-build-conversation.md): The builder pauses once at `status: awaiting_approval` and asks you to confirm building, deploying a…
- [Run an AI code review](https://developers.mihu.ai/api-reference/builders/run-an-ai-code-review.md): Runs an AI review of the builder's code and returns the report (issues + verdict). Report only — it…
- [Generate and run tests](https://developers.mihu.ai/api-reference/builders/generate-and-run-tests.md): Generates and runs tests (unit + HTTP/acceptance) against the live builder and returns the results.…
- [Get the latest QA report](https://developers.mihu.ai/api-reference/builders/get-the-latest-qa-report.md): Returns the most recent stored QA report for the builder (code review + tests).
- [Get total spending](https://developers.mihu.ai/api-reference/builders/get-total-spending.md): Total spend across all the tenant's builders plus a per-builder breakdown. Cost accrues while a buil…
- [Make the agent say a message in the live call](https://developers.mihu.ai/api-reference/call-actions/make-the-agent-say-a-message-in-the-live-call.md): Makes the active call agent speak a text-to-speech message immediately. Use this for live operator i…
- [Forward (warm-transfer) the live call to another phone number](https://developers.mihu.ai/api-reference/call-actions/forward-warm-transfer-the-live-call-to-another-phone-number.md): Transfers the active call to another E.164 phone number. Use this when the caller needs a human repr…
- [Hang up the live call (the agent speaks a goodbye message, then ends)](https://developers.mihu.ai/api-reference/call-actions/hang-up-the-live-call-the-agent-speaks-a-goodbye-message-then-ends.md): Ends the active call after the agent speaks a closing message. Use this for manual live-call termina…
- [Mute the agent in the live call](https://developers.mihu.ai/api-reference/call-actions/mute-the-agent-in-the-live-call.md): Temporarily stops the agent from speaking on the active call. Use this when a human operator needs t…
- [Unmute the agent in the live call](https://developers.mihu.ai/api-reference/call-actions/unmute-the-agent-in-the-live-call.md): Allows the muted agent to speak again on the active call. Use this after a temporary human intervent…
- [Get paginated list of campaigns](https://developers.mihu.ai/api-reference/campaigns/get-paginated-list-of-campaigns.md): Returns campaigns ordered by creation date with optional filters for status and search text. Use thi…
- [Create a new campaign](https://developers.mihu.ai/api-reference/campaigns/create-a-new-campaign.md): Creates the campaign shell: name, channel type, agent, status, date window, and optional message set…
- [Get campaign details](https://developers.mihu.ai/api-reference/campaigns/get-campaign-details.md): Returns one campaign by UUID, including campaign configuration, agent reference, status, date window…
- [Update a campaign](https://developers.mihu.ai/api-reference/campaigns/update-a-campaign.md): Updates campaign metadata and configuration before or during its lifecycle. Use this to rename a cam…
- [Delete a campaign](https://developers.mihu.ai/api-reference/campaigns/delete-a-campaign.md): Soft-deletes a campaign by UUID. Use this when the campaign should no longer appear in normal campai…
- [Publish (activate) a campaign — schedule tasks and start processing](https://developers.mihu.ai/api-reference/campaigns/publish-activate-a-campaign-—-schedule-tasks-and-start-processing.md): Transitions the campaign from Active/Draft/Paused/Failed to 'In Process' AND creates tasks for every…
- [Assign or replace the rule attached to a campaign](https://developers.mihu.ai/api-reference/campaigns/assign-or-replace-the-rule-attached-to-a-campaign.md): Attaches a rule (cadence, retry interval, working hours, escalation) to the campaign. The underlying…
- [Detach the rule from a campaign](https://developers.mihu.ai/api-reference/campaigns/detach-the-rule-from-a-campaign.md): Removes the rule association from the campaign. The rule itself is NOT deleted — it remains availabl…
- [Attach one or more pools to a campaign](https://developers.mihu.ai/api-reference/campaigns/attach-one-or-more-pools-to-a-campaign.md): Pools are additive (not replace). UUIDs already attached are silently skipped, UUIDs that don't reso…
- [Detach a pool from a campaign](https://developers.mihu.ai/api-reference/campaigns/detach-a-pool-from-a-campaign.md): Removes the pool↔campaign association. Side effect: cancels any scheduled/queued/pending tasks creat…
- [List coaching agents](https://developers.mihu.ai/api-reference/coaching-agents/list-coaching-agents.md): Returns your coaching agents, default agent first. Example: `GET /api/v1/coaching-agents?search=supp…
- [Create a coaching agent](https://developers.mihu.ai/api-reference/coaching-agents/create-a-coaching-agent.md): Creates a coaching agent. Leave out `coaching_templates` and `training_examples` to start with ready…
- [Get one coaching agent](https://developers.mihu.ai/api-reference/coaching-agents/get-one-coaching-agent.md): Returns one coaching agent with its full configuration — tone, thresholds, guidelines, templates, tr…
- [Update a coaching agent (same as PATCH)](https://developers.mihu.ai/api-reference/coaching-agents/update-a-coaching-agent-same-as-patch.md): Works exactly like PATCH /api/v1/coaching-agents/{uuid}.
- [Delete a coaching agent](https://developers.mihu.ai/api-reference/coaching-agents/delete-a-coaching-agent.md): Deletes a coaching agent. Past coaching feedback is kept. The default coaching agent cannot be delet…
- [Update a coaching agent](https://developers.mihu.ai/api-reference/coaching-agents/update-a-coaching-agent.md): Updates a coaching agent — only the fields you send are changed. The `coaching_templates`, `training…
- [Set a coaching agent as default](https://developers.mihu.ai/api-reference/coaching-agents/set-a-coaching-agent-as-default.md): Makes this coaching agent the default coach. The previous default is switched off automatically — th…
- [Get paginated list of contacts](https://developers.mihu.ai/api-reference/contacts/get-paginated-list-of-contacts.md): Returns a paginated contact list with filters for search, status, contact channel, pipeline stage, c…
- [Create a new contact](https://developers.mihu.ai/api-reference/contacts/create-a-new-contact.md): Creates a contact record that agents and campaigns can use for conversations, calls, SMS, WhatsApp,…
- [Get contact details](https://developers.mihu.ai/api-reference/contacts/get-contact-details.md): Returns one contact with base fields, custom fields, tags, and timestamps. Use this before updating…
- [Update a contact](https://developers.mihu.ai/api-reference/contacts/update-a-contact.md): Updates base contact fields and custom field values. Use this to correct contact identity, phone/ema…
- [Delete a contact](https://developers.mihu.ai/api-reference/contacts/delete-a-contact.md): Soft-deletes a contact by UUID. Use this when the contact should no longer appear in normal contact…
- [Assign (or re-assign) a tag to a contact](https://developers.mihu.ai/api-reference/contacts/assign-or-re-assign-a-tag-to-a-contact.md): Assigns a tag to a contact. The operation is idempotent: if the tag is already assigned, the contact…
- [Remove a tag from a contact](https://developers.mihu.ai/api-reference/contacts/remove-a-tag-from-a-contact.md): Removes a tag assignment from a contact without deleting the tag itself. Use this when a contact no…
- [Assign or change the contact's current pipeline stage](https://developers.mihu.ai/api-reference/contacts/assign-or-change-the-contacts-current-pipeline-stage.md): Sets the contact's current pipeline stage. Use this for the first assignment as well as to move the…
- [Remove the contact from the pipeline](https://developers.mihu.ai/api-reference/contacts/remove-the-contact-from-the-pipeline.md): Clears the contact's current pipeline stage. Use this when the contact should no longer appear in an…
- [Get paginated list of blacklisted contacts](https://developers.mihu.ai/api-reference/contacts/get-paginated-list-of-blacklisted-contacts.md): Returns contacts currently on the blacklist (status=Blacklisted with an active blacklist record). Su…
- [Add a contact to the blacklist](https://developers.mihu.ai/api-reference/contacts/add-a-contact-to-the-blacklist.md): Marks the contact as Blacklisted and records the blacklist entry. If the contact is already blacklis…
- [Remove a contact from the blacklist](https://developers.mihu.ai/api-reference/contacts/remove-a-contact-from-the-blacklist.md): Removes the blacklist entry and restores the contact's status to Active. Idempotent — succeeds even…
- [List pending contact field approvals](https://developers.mihu.ai/api-reference/contact-approvals/list-pending-contact-field-approvals.md): Returns paginated AI-suggested contact updates. Use this queue to review values the agent extracted…
- [Get a single approval by uuid](https://developers.mihu.ai/api-reference/contact-approvals/get-a-single-approval-by-uuid.md): Returns one contact field approval with current value, suggested value, confidence, AI notes, status…
- [Update the suggested value of a pending approval](https://developers.mihu.ai/api-reference/contact-approvals/update-the-suggested-value-of-a-pending-approval.md): Edits the suggested value on an approval before it is applied. Use this when the AI found the right…
- [Soft-delete an approval](https://developers.mihu.ai/api-reference/contact-approvals/soft-delete-an-approval.md): Soft-deletes an approval suggestion without applying it to the contact. Use this to remove stale or…
- [Approve a pending field update](https://developers.mihu.ai/api-reference/contact-approvals/approve-a-pending-field-update.md): Approves a pending AI-suggested contact update and applies it to the target contact, custom field, o…
- [Reject a pending field update](https://developers.mihu.ai/api-reference/contact-approvals/reject-a-pending-field-update.md): Rejects a pending AI-suggested contact update and records reviewer notes. Use this when the extracte…
- [Get the history of an approval](https://developers.mihu.ai/api-reference/contact-approvals/get-the-history-of-an-approval.md): Returns paginated history for one contact field approval, newest first. Use this to audit approval,…
- [List custom contact fields](https://developers.mihu.ai/api-reference/contact-fields/list-custom-contact-fields.md): Returns custom contact fields for the workspace. By default only active fields are returned. Use inc…
- [Create a new custom contact field](https://developers.mihu.ai/api-reference/contact-fields/create-a-new-custom-contact-field.md): Generates a unique snake_case `key` from the supplied `name`, appending a numeric suffix if needed.…
- [Get a custom contact field by key](https://developers.mihu.ai/api-reference/contact-fields/get-a-custom-contact-field-by-key.md): Returns one custom contact field definition by key. Use this before updating the field, validating i…
- [Update a custom contact field (name, is_active, etc.)](https://developers.mihu.ai/api-reference/contact-fields/update-a-custom-contact-field-name-is_active-etc.md): Updates only the fields you supply. The `key` is immutable — to use a different identifier, delete t…
- [Delete a custom contact field](https://developers.mihu.ai/api-reference/contact-fields/delete-a-custom-contact-field.md): Deletes a custom contact field definition by key. Use this when the field should no longer be availa…
- [List contact settings](https://developers.mihu.ai/api-reference/contact-settings/list-contact-settings.md): Returns workspace-level contact settings. Use this to inspect which contact data behaviors are enabl…
- [Get a contact setting by key](https://developers.mihu.ai/api-reference/contact-settings/get-a-contact-setting-by-key.md): Returns one contact setting by key, including whether it is currently enabled. Use this before toggl…
- [Enable or disable a contact setting](https://developers.mihu.ai/api-reference/contact-settings/enable-or-disable-a-contact-setting.md): Updates one contact setting by key. Use this to enable or disable contact data behavior for the work…
- [Get paginated list of conversations](https://developers.mihu.ai/api-reference/conversations/get-paginated-list-of-conversations.md): Returns paginated conversations across voice and text channels. Use filters to find conversations by…
- [Get conversation details](https://developers.mihu.ai/api-reference/conversations/get-conversation-details.md): Returns one conversation with contact, channel, agent, sessions, message context, and voice-call met…
- [Get paginated messages of a conversation](https://developers.mihu.ai/api-reference/conversations/get-paginated-messages-of-a-conversation.md): Returns paginated messages for one conversation, including AI, human, and contact-authored messages.…
- [Get paginated list of conversation sessions](https://developers.mihu.ai/api-reference/sessions/get-paginated-list-of-conversation-sessions.md): Returns paginated conversation sessions. Sessions group messages or voice activity into reviewable i…
- [Get session details](https://developers.mihu.ai/api-reference/sessions/get-session-details.md): Returns one conversation session with contact, conversation, agent, campaign/listing/task references…
- [Get the evaluation of a session](https://developers.mihu.ai/api-reference/sessions/get-the-evaluation-of-a-session.md): Returns the evaluation record for one conversation session when analysis exists. Each dimension incl…
- [Get paginated messages of a session](https://developers.mihu.ai/api-reference/sessions/get-paginated-messages-of-a-session.md): Returns paginated messages that belong to one conversation session. Use this to inspect exactly whic…
- [Get paginated sessions of a conversation](https://developers.mihu.ai/api-reference/sessions/get-paginated-sessions-of-a-conversation.md): Returns sessions that belong to one conversation. Use this to navigate from a conversation to its gr…
- [Import data via copy-paste text](https://developers.mihu.ai/api-reference/tables/import-data-via-copy-paste-text.md): Creates a table-like knowledge source from raw text. Use this for FAQs, policies, product notes, or…
- [Import data via file upload](https://developers.mihu.ai/api-reference/tables/import-data-via-file-upload.md): Uploads a file and starts asynchronous processing so the content can become agent knowledge or struc…
- [Import data from a website URL](https://developers.mihu.ai/api-reference/tables/import-data-from-a-website-url.md): Crawls a website URL and imports discovered page content into a knowledge source. Use this when an a…
- [Create an empty table with a column schema](https://developers.mihu.ai/api-reference/tables/create-an-empty-table-with-a-column-schema.md): Creates a new table that agents can use as a knowledge base or for real-time data lookups. The table…
- [Get all imported data](https://developers.mihu.ai/api-reference/tables/get-all-imported-data.md): Returns imported data sources and manually created tables for the workspace. Use this endpoint to fi…
- [Get data details by UUID](https://developers.mihu.ai/api-reference/tables/get-data-details-by-uuid.md): Returns one data source or table by UUID, including metadata, type, processing state, and stored pat…
- [Update table metadata (name and description)](https://developers.mihu.ai/api-reference/tables/update-table-metadata-name-and-description.md): Updates table metadata without changing its columns or records. Use this to rename a knowledge sourc…
- [Delete imported data](https://developers.mihu.ai/api-reference/tables/delete-imported-data.md): Soft-deletes a data source or table by UUID. Use this when the knowledge source should no longer be…
- [Get fields (columns) for imported data](https://developers.mihu.ai/api-reference/tables/get-fields-columns-for-imported-data.md): Returns the columns defined for a table or imported structured data source. Use this before adding r…
- [Add a column to a table](https://developers.mihu.ai/api-reference/tables/add-a-column-to-a-table.md): Adds a new column to a table schema. Use this when agents need another structured field available fo…
- [Update a column (rename and/or change data_type)](https://developers.mihu.ai/api-reference/tables/update-a-column-rename-andor-change-data_type.md): Renames the column and/or changes its data_type. If data_type changes, all existing values for this…
- [Delete a column](https://developers.mihu.ai/api-reference/tables/delete-a-column.md): Soft-deletes the column. Existing record values for this column are kept on disk but no longer surfa…
- [Get records for imported data](https://developers.mihu.ai/api-reference/tables/get-records-for-imported-data.md): Returns paginated table records with their field values. Use this to inspect imported rows, power ex…
- [Create a record for imported data](https://developers.mihu.ai/api-reference/tables/create-a-record-for-imported-data.md): Creates a new record with values for the specified knowledge base. Provide either a values array (wi…
- [Update record values](https://developers.mihu.ai/api-reference/tables/update-record-values.md): Updates one or more values for a specific record. Provide either a values array (with column_id or c…
- [Delete a record](https://developers.mihu.ai/api-reference/tables/delete-a-record.md): Deletes one table record and its stored field values. Use this when a row is obsolete, duplicated, o…
- [Assign imported data to an agent](https://developers.mihu.ai/api-reference/tables/assign-imported-data-to-an-agent.md): Assigns a data source or table to an agent and starts asynchronous synchronization. Use this after i…
- [Trigger a sync for data across all associated agents](https://developers.mihu.ai/api-reference/tables/trigger-a-sync-for-data-across-all-associated-agents.md): Starts a fresh synchronization for all agents assigned to the data source. Use this after changing t…
- [List action executions across tasks, workflows, and intents](https://developers.mihu.ai/api-reference/logs/list-action-executions-across-tasks-workflows-and-intents.md): Returns a chronologically merged stream of three kinds of agent activity: (1) `task` — a queued acti…
- [Get full detail for a single action execution](https://developers.mihu.ai/api-reference/logs/get-full-detail-for-a-single-action-execution.md): Returns the full request/response payload, related agent and contact, and per-type extras (intent: t…
- [List inbound API request logs](https://developers.mihu.ai/api-reference/logs/list-inbound-api-request-logs.md): Returns a paginated feed of requests made against this tenant's API, newest first. Each row records…
- [Get full detail for a single API request log](https://developers.mihu.ai/api-reference/logs/get-full-detail-for-a-single-api-request-log.md): Returns the full request and response bodies for one logged API request. Tokens, passwords and other…
- [List outbound webhook delivery logs](https://developers.mihu.ai/api-reference/logs/list-outbound-webhook-delivery-logs.md): Returns a paginated feed of webhook deliveries this tenant sent to registered endpoints, newest firs…
- [Get full detail for a single webhook delivery](https://developers.mihu.ai/api-reference/logs/get-full-detail-for-a-single-webhook-delivery.md): Returns the full payload, request/response headers and response body for one webhook delivery. Signa…
- [List email addresses](https://developers.mihu.ai/api-reference/email-addresses/list-email-addresses.md): Returns every email address on the tenant — shared (@partners.mail.mihu.ai) and connected-domain — w…
- [Create an email address](https://developers.mihu.ai/api-reference/email-addresses/create-an-email-address.md): type=subdomain creates an instant address on the shared sending domain (requires slug). type=custom_…
- [Get a single email address](https://developers.mihu.ai/api-reference/email-addresses/get-a-single-email-address.md): Returns one email address by uuid, including its mode, status, verification state, from name, signat…
- [Delete an email address](https://developers.mihu.ai/api-reference/email-addresses/delete-an-email-address.md): Removes the address so it no longer receives or sends mail. Existing conversations are kept; the add…
- [Update an email address](https://developers.mihu.ai/api-reference/email-addresses/update-an-email-address.md): Update the from name, signature, or auto-reply for an address.
- [Assign an agent to an email address](https://developers.mihu.ai/api-reference/email-addresses/assign-an-agent-to-an-email-address.md): Routes inbound mail for this address to the given agent and lets the agent reply. Also makes the add…
- [Unassign the agent from an email address](https://developers.mihu.ai/api-reference/email-addresses/unassign-the-agent-from-an-email-address.md): Clears the handling agent. The address stays active and keeps receiving mail, but no agent replies u…
- [Enable an email address](https://developers.mihu.ai/api-reference/email-addresses/enable-an-email-address.md): Re-activates a disabled address so it can send and receive mail again.
- [Disable an email address](https://developers.mihu.ai/api-reference/email-addresses/disable-an-email-address.md): Turns the address off — it stops receiving and sending mail until re-enabled. The address and its se…
- [Get DNS records for a connected domain](https://developers.mihu.ai/api-reference/email-addresses/get-dns-records-for-a-connected-domain.md): Returns the records to add at your DNS provider, each with the exact host and value to enter. Only a…
- [Verify an email address](https://developers.mihu.ai/api-reference/email-addresses/verify-an-email-address.md): Checks whether the connected domain (or single address) is verified yet and returns the result. Once…
- [Send a new email](https://developers.mihu.ai/api-reference/email-messages/send-a-new-email.md): Sends from one of your email addresses (identified by its uuid). The agent assigned to that address…
- [Reply within an email conversation](https://developers.mihu.ai/api-reference/email-messages/reply-within-an-email-conversation.md): Sends a reply in an existing email thread (channel 3), threaded correctly so it groups in the recipi…
- [Forward an email conversation to a third party](https://developers.mihu.ai/api-reference/email-messages/forward-an-email-conversation-to-a-third-party.md): Forwards the conversation to another recipient with an optional note. Uses the conversation's agent…
- [List the 10 analyzer feature ids](https://developers.mihu.ai/api-reference/evaluate/list-the-10-analyzer-feature-ids.md): Static catalog of feature ids you can toggle or edit under `text.*` and `voice.*` in any update call…
- [Read the global default evaluate settings](https://developers.mihu.ai/api-reference/evaluate/read-the-global-default-evaluate-settings.md): Returns the workspace-wide default. Every agent without an override inherits from this. Response alw…
- [Update the global default evaluate settings](https://developers.mihu.ai/api-reference/evaluate/update-the-global-default-evaluate-settings.md): Partial update; any unsent key is left alone. Changes here cascade to every agent without its own ov…
- [Reset the global default to factory values](https://developers.mihu.ai/api-reference/evaluate/reset-the-global-default-to-factory-values.md): Replaces every field on the global default with the built-in factory presets (workspace-language-awa…
- [Read effective evaluate settings for one agent](https://developers.mihu.ai/api-reference/evaluate/read-effective-evaluate-settings-for-one-agent.md): If the agent has an override, returns it (source=agent). Otherwise returns the global default (sourc…
- [Update an agent's evaluate settings](https://developers.mihu.ai/api-reference/evaluate/update-an-agents-evaluate-settings.md): Partial update. If the agent has no override yet, one is auto-created from the current global defaul…
- [Remove the agent's override (revert to global default)](https://developers.mihu.ai/api-reference/evaluate/remove-the-agents-override-revert-to-global-default.md): Deletes the agent-specific evaluate settings so subsequent reads return the global default. Idempote…
- [Create an override for an agent (clones current default)](https://developers.mihu.ai/api-reference/evaluate/create-an-override-for-an-agent-clones-current-default.md): Creates agent-specific evaluate settings by copying the current global default. After this, the agen…
- [Force-overwrite the agent's override with a fresh copy of the current default](https://developers.mihu.ai/api-reference/evaluate/force-overwrite-the-agents-override-with-a-fresh-copy-of-the-current-default.md): Use when the global default has changed and you want this agent to pick up the new defaults while ke…
- [Reset the agent's override to factory defaults](https://developers.mihu.ai/api-reference/evaluate/reset-the-agents-override-to-factory-defaults.md): Like /default/reset but scoped to one agent. Keeps the override row in place; just rewrites every fi…
- [List tenant's agents available for Agents-app actions](https://developers.mihu.ai/api-reference/flow-catalog/list-tenants-agents-available-for-agents-app-actions.md): Returns the agents the user can pick when configuring an Agents-app action (Make Call, Send WhatsApp…
- [List all Studio integrations (apps)](https://developers.mihu.ai/api-reference/flow-catalog/list-all-studio-integrations-apps.md): The full set of integrations the Studio supports — both mihu builtins (Calls, Texts, Contacts, Logic…
- [List apps eligible as a flow's trigger (step 1)](https://developers.mihu.ai/api-reference/flow-catalog/list-apps-eligible-as-a-flows-trigger-step-1.md): Same shape as /flow/apps but pre-filtered to apps with at least one trigger. Use this when offering…
- [List apps eligible as a flow's action (step 2+)](https://developers.mihu.ai/api-reference/flow-catalog/list-apps-eligible-as-a-flows-action-step-2+.md): Same shape as /flow/apps but pre-filtered to apps with at least one action. Use this when offering t…
- [Read a single app by its uid](https://developers.mihu.ai/api-reference/flow-catalog/read-a-single-app-by-its-uid.md)
- [List the trigger events an app exposes](https://developers.mihu.ai/api-reference/flow-catalog/list-the-trigger-events-an-app-exposes.md): Each trigger has a `key` (used in step config: `trigger_key`) plus name, description, and config sch…
- [List the actions an app exposes](https://developers.mihu.ai/api-reference/flow-catalog/list-the-actions-an-app-exposes.md): Each action has a `key` (used in step config: `action_key`) plus name, description, and config schem…
- [Flat list of every OAuth connection the tenant has, across all apps](https://developers.mihu.ai/api-reference/flow-catalog/flat-list-of-every-oauth-connection-the-tenant-has-across-all-apps.md): Each row carries the connection uuid + label and the inlined app it belongs to. Useful for an MCP se…
- [List the tenant's connections (OAuth accounts) for one app](https://developers.mihu.ai/api-reference/flow-catalog/list-the-tenants-connections-oauth-accounts-for-one-app.md): Returns each `app_connection` the tenant has set up for this app — typically zero or one for a fresh…
- [Fetch dynamic dropdown options for a step's field](https://developers.mihu.ai/api-reference/flow-catalog/fetch-dynamic-dropdown-options-for-a-steps-field.md): Mirrors every 'Refresh' dropdown in the Studio Setup tab. Used to resolve human references like '#ge…
- [Get an action's config field schema (what to ask)](https://developers.mihu.ai/api-reference/flow/get-an-actions-config-field-schema-what-to-ask.md): Returns the fields an action's config needs — which are required, their type, and where to resolve o…
- [Get a trigger's config field schema (what to ask)](https://developers.mihu.ai/api-reference/flow/get-a-triggers-config-field-schema-what-to-ask.md): Like the action config-schema, but for a trigger. Returns the fields a trigger needs (e.g. Tables re…
- [List flows (paginated, filterable)](https://developers.mihu.ai/api-reference/flows/list-flows-paginated-filterable.md): Returns the tenant's flows with each one's compact app/agent/step counts and last-updated timestamps…
- [Create an empty flow (draft)](https://developers.mihu.ai/api-reference/flows/create-an-empty-flow-draft.md): Creates a flow with no steps. Both `name` and `description` are optional — when name is omitted the…
- [Read a flow with its full ordered step list](https://developers.mihu.ai/api-reference/flows/read-a-flow-with-its-full-ordered-step-list.md): Steps are returned flat — branch children of an `if_condition` appear in the array with `parent_step…
- [Delete a flow](https://developers.mihu.ai/api-reference/flows/delete-a-flow.md): Soft-delete (per project convention). Pending executions are not auto-cancelled — undeploy first if…
- [Update flow name or description](https://developers.mihu.ai/api-reference/flows/update-flow-name-or-description.md): Only `name` and `description` are mutable here. To change the structure (steps), use the step endpoi…
- [Deploy a flow — flips it from draft to live](https://developers.mihu.ai/api-reference/flows/deploy-a-flow-—-flips-it-from-draft-to-live.md): Validates the flow has a trigger, every step is configured (app + trigger/action set), every connect…
- [Undeploy — flip a deployed flow back to draft](https://developers.mihu.ai/api-reference/flows/undeploy-—-flip-a-deployed-flow-back-to-draft.md): Stops the flow from firing on real events and unlocks it for editing (PATCH/POST/DELETE on its steps…
- [List run history of a flow](https://developers.mihu.ai/api-reference/flow-executions/list-run-history-of-a-flow.md): Paginated list of every time this flow fired on a real event. Each execution captures status, durati…
- [Read one execution with per-step request/response/error](https://developers.mihu.ai/api-reference/flow-executions/read-one-execution-with-per-step-requestresponseerror.md): Returns the full trigger payload that fired this run plus a `steps[]` array — for each step: status,…
- [Read one step](https://developers.mihu.ai/api-reference/flow-steps/read-one-step.md)
- [Delete a step (and its branch children if any)](https://developers.mihu.ai/api-reference/flow-steps/delete-a-step-and-its-branch-children-if-any.md): Removes the step. Subsequent steps are renumbered down by 1. `{{stepN.field}}` references in remaini…
- [Update any subset of a step's fields](https://developers.mihu.ai/api-reference/flow-steps/update-any-subset-of-a-steps-fields.md): **Order of operations matters.** Switching `app_uid` clears trigger/action/config/connection (forces…
- [Add a step to a flow (trigger as step 1, actions as step 2+)](https://developers.mihu.ai/api-reference/flow-steps/add-a-step-to-a-flow-trigger-as-step-1-actions-as-step-2+.md): Creates either a trigger (only one allowed, must be step 1) or an action. The server picks the posit…
- [Test a step — kind-aware behavior (trigger samples vs action exec)](https://developers.mihu.ai/api-reference/flow-steps/test-a-step-—-kind-aware-behavior-trigger-samples-vs-action-exec.md): **For trigger steps:** auto-fetches recent records from the trigger's source (e.g. recent calls for…
- [List supported languages](https://developers.mihu.ai/api-reference/language/list-supported-languages.md): Returns the supported language catalog for agent configuration. Use the returned codes for agent.lan…
- [Get all listings (campaigns with pools)](https://developers.mihu.ai/api-reference/listings/get-all-listings-campaigns-with-pools.md): Returns campaigns that have contact pools and are managed as listings. Use this endpoint to monitor…
- [Create a new listing with rule and bulk contacts](https://developers.mihu.ai/api-reference/listings/create-a-new-listing-with-rule-and-bulk-contacts.md): Creates a listing workflow in one request: campaign, contact pool, optional rule, and initial contac…
- [Get listing details with contacts](https://developers.mihu.ai/api-reference/listings/get-listing-details-with-contacts.md): Returns one listing with its campaign settings, agent/channel binding, rule, attached pool, and cont…
- [Delete a listing](https://developers.mihu.ai/api-reference/listings/delete-a-listing.md): Deletes the listing campaign, detaches its pool and rule, and cancels pending campaign tasks. Use th…
- [Start/resume a listing campaign](https://developers.mihu.ai/api-reference/listings/startresume-a-listing-campaign.md): Starts or resumes a listing by moving it to In Process and creating tasks for eligible contacts. Use…
- [Stop/pause a running listing campaign](https://developers.mihu.ai/api-reference/listings/stoppause-a-running-listing-campaign.md): Pauses a running listing and cancels pending tasks for that campaign. Use this when you need to stop…
- [Add contacts to an existing listing](https://developers.mihu.ai/api-reference/listings/add-contacts-to-an-existing-listing.md): Adds one or more contacts to the listing's pool. Existing contacts are matched by phone number first…
- [Remove a contact from a listing and cancel their tasks](https://developers.mihu.ai/api-reference/listings/remove-a-contact-from-a-listing-and-cancel-their-tasks.md): Removes one contact from the listing's pool and cancels that contact's pending tasks for the listing…
- [List contact fields available for memorize settings](https://developers.mihu.ai/api-reference/memorize/list-contact-fields-available-for-memorize-settings.md): Returns every contact field that can be toggled in memorize settings: built-in base fields plus all…
- [Catalog merged with the global default's toggle state](https://developers.mihu.ai/api-reference/memorize/catalog-merged-with-the-global-defaults-toggle-state.md): Returns all available contact fields with the global default memorize toggles applied. Use this to s…
- [Catalog merged with the agent's toggles (or default if no override)](https://developers.mihu.ai/api-reference/memorize/catalog-merged-with-the-agents-toggles-or-default-if-no-override.md): Returns all available contact fields with the agent's effective memorize toggles. If the agent has n…
- [Get the global default memorize settings](https://developers.mihu.ai/api-reference/memorize/get-the-global-default-memorize-settings.md): Returns the workspace-wide default memorize settings. Agents without their own override inherit thes…
- [Update the global default memorize settings](https://developers.mihu.ai/api-reference/memorize/update-the-global-default-memorize-settings.md): Updates the workspace-wide default memorize settings. Use this to control what future and non-overri…
- [Bulk-toggle contact field flags on the default settings](https://developers.mihu.ai/api-reference/memorize/bulk-toggle-contact-field-flags-on-the-default-settings.md): Send a list of contact-field toggles. Each item must include `field_id` plus any subset of the 5 all…
- [Bulk-toggle contact field flags for an agent](https://developers.mihu.ai/api-reference/memorize/bulk-toggle-contact-field-flags-for-an-agent.md): Same body shape as the default bulk endpoint. If the agent does not yet have its own memorize settin…
- [Reset the global default memorize settings to factory defaults](https://developers.mihu.ai/api-reference/memorize/reset-the-global-default-memorize-settings-to-factory-defaults.md): Resets the global default memorize settings to factory defaults. Use this when default memory behavi…
- [Get an agent's memorize settings (falls back to default)](https://developers.mihu.ai/api-reference/memorize/get-an-agents-memorize-settings-falls-back-to-default.md): Returns the agent's effective memorize settings. If the agent has a custom override, source is agent…
- [Update an agent's memorize settings (creates them from the global default if the agent has none yet)](https://developers.mihu.ai/api-reference/memorize/update-an-agents-memorize-settings-creates-them-from-the-global-default-if-the-agent-has-none-yet.md): Updates one agent's memorize settings. If the agent does not already have custom settings, they are…
- [Remove an agent's specific memorize settings (reverts to default)](https://developers.mihu.ai/api-reference/memorize/remove-an-agents-specific-memorize-settings-reverts-to-default.md): Deletes the agent-specific memorize override. After deletion, the agent inherits the global default…
- [Create custom memorize settings for an agent, copied from the global default](https://developers.mihu.ai/api-reference/memorize/create-custom-memorize-settings-for-an-agent-copied-from-the-global-default.md): Creates an agent-specific memorize override by copying the current global default. Use this before c…
- [Replace the agent's memorize settings with a fresh copy of the global default](https://developers.mihu.ai/api-reference/memorize/replace-the-agents-memorize-settings-with-a-fresh-copy-of-the-global-default.md): Overwrites the agent's memorize settings with a new copy of the current global default. Use this whe…
- [Reset an agent's memorize settings to factory defaults](https://developers.mihu.ai/api-reference/memorize/reset-an-agents-memorize-settings-to-factory-defaults.md): Resets the agent's memorize settings to factory defaults. If the agent has no override, one is creat…
- [Get the SIP connector server assigned to your account](https://developers.mihu.ai/api-reference/pbx-extension-connectors/get-the-sip-connector-server-assigned-to-your-account.md): Returns the SIP connector server currently allocated to your account. You need one allocated before…
- [Allocate a SIP connector server](https://developers.mihu.ai/api-reference/pbx-extension-connectors/allocate-a-sip-connector-server.md): Picks a random active server from the configured pool and allocates its IP to your account. Idempote…
- [Release the allocated SIP connector server](https://developers.mihu.ai/api-reference/pbx-extension-connectors/release-the-allocated-sip-connector-server.md): Unassigns the workspace SIP connector server after all PBX extension connectors have been deleted. U…
- [List PBX extension connectors](https://developers.mihu.ai/api-reference/pbx-extension-connectors/list-pbx-extension-connectors.md): Returns paginated PBX extension connectors. Use this to audit extension routing from agents and phon…
- [Create a PBX extension connector](https://developers.mihu.ai/api-reference/pbx-extension-connectors/create-a-pbx-extension-connector.md): Registers a PBX extension to an AI voice agent. This endpoint configures the PBX end only — it does…
- [Get a single PBX extension connector](https://developers.mihu.ai/api-reference/pbx-extension-connectors/get-a-single-pbx-extension-connector.md): Returns one PBX extension connector by UUID, including the linked agent, phone number, extension pay…
- [Delete a PBX extension connector](https://developers.mihu.ai/api-reference/pbx-extension-connectors/delete-a-pbx-extension-connector.md): Deletes a PBX extension connector and deregisters its SIP customer entry. Use this when an extension…
- [List your phone numbers](https://developers.mihu.ai/api-reference/phone-numbers/list-your-phone-numbers.md): Returns every phone number connected to your workspace — both numbers you've purchased and external…
- [Buy a phone number](https://developers.mihu.ai/api-reference/phone-numbers/buy-a-phone-number.md): Purchases a number returned by the search endpoint. If the country/type requires compliance, include…
- [Phone number summary](https://developers.mihu.ai/api-reference/phone-numbers/phone-number-summary.md): A quick snapshot for dashboards: how many numbers you have, how many need attention (e.g. compliance…
- [Get one phone number](https://developers.mihu.ai/api-reference/phone-numbers/get-one-phone-number.md): Returns full details for a single number — capabilities, channel settings, billing, compliance statu…
- [Release a phone number](https://developers.mihu.ai/api-reference/phone-numbers/release-a-phone-number.md): Removes a number from your active inventory. If any agent is still using the number on call, SMS, or…
- [Update channel settings](https://developers.mihu.ai/api-reference/phone-numbers/update-channel-settings.md): Turn voice, SMS, or inbound on or off, set per-channel concurrency limits, and choose which destinat…
- [Channels for one phone number](https://developers.mihu.ai/api-reference/phone-numbers/channels-for-one-phone-number.md): A trimmed-down view focused on what each channel (call, SMS, WhatsApp, inbound) can do for this numb…
- [Channels for a phone number (look up by number)](https://developers.mihu.ai/api-reference/phone-numbers/channels-for-a-phone-number-look-up-by-number.md): Same as the by-UUID version, but you only need the phone number itself. Works for both owned numbers…
- [Release a phone number](https://developers.mihu.ai/api-reference/phone-numbers/release-a-phone-number-1.md): Action-style alias for DELETE /api/v1/phone-numbers/{uuid}. Soft-deletes a number after checking tha…
- [Assign a number to an agent](https://developers.mihu.ai/api-reference/phone-numbers/assign-a-number-to-an-agent.md): Connects this number to one of your agents on a specific channel (call, SMS, or WhatsApp). The agent…
- [Remove a number from an agent](https://developers.mihu.ai/api-reference/phone-numbers/remove-a-number-from-an-agent.md): Disconnects this number from whichever agent currently uses it on the given channel. The number stay…
- [Upload a compliance document](https://developers.mihu.ai/api-reference/phone-numbers/upload-a-compliance-document.md): Uploads a document (e.g. proof of ID, business license, address proof) needed for compliance on a ph…
- [Search numbers available to buy](https://developers.mihu.ai/api-reference/phone-numbers/search-numbers-available-to-buy.md): Browse phone numbers available for purchase in a given country. You can filter by type (local, toll-…
- [Compliance requirements for a country](https://developers.mihu.ai/api-reference/phone-numbers/compliance-requirements-for-a-country.md): Some countries require documents (proof of ID, business license, local address) before a number can…
- [Outbound call rates](https://developers.mihu.ai/api-reference/phone-numbers/outbound-call-rates.md): Per-minute pricing for outbound calls, broken down by destination country and prefix. Useful for est…
- [Which agents use which numbers](https://developers.mihu.ai/api-reference/phone-numbers/which-agents-use-which-numbers.md): A summary of every active phone number and the agents using it, grouped by channel. Includes both nu…
- [Phone numbers grouped by agent](https://developers.mihu.ai/api-reference/phone-numbers/phone-numbers-grouped-by-agent.md): Same data as /used-channels-and-accounts, but pivoted: one row per agent, listing the phone numbers…
- [Phone numbers for one agent](https://developers.mihu.ai/api-reference/phone-numbers/phone-numbers-for-one-agent.md): Returns the phone numbers an agent serves on, with the channels in use on each number. Same shape as…
- [List external trunks (BYO numbers)](https://developers.mihu.ai/api-reference/phone-numbers/list-external-trunks-byo-numbers.md): Lists every external trunk you've registered — phone numbers you own elsewhere that are bound to you…
- [Register an external SIP trunk / BYO number](https://developers.mihu.ai/api-reference/phone-numbers/register-an-external-sip-trunk-byo-number.md): Connects a phone number you already own elsewhere (your own SIP trunk, an existing WhatsApp Business…
- [Delete an external trunk](https://developers.mihu.ai/api-reference/phone-numbers/delete-an-external-trunk.md): Removes an external trunk binding identified by `phone_number` + `channel`. The phone number itself…
- [Update an external trunk](https://developers.mihu.ai/api-reference/phone-numbers/update-an-external-trunk.md): Updates an existing external trunk (registered via POST /trunks). Identify the trunk by `phone_numbe…
- [Assign or reassign an external trunk to an agent](https://developers.mihu.ai/api-reference/phone-numbers/assign-or-reassign-an-external-trunk-to-an-agent.md): Reassigns an existing external trunk (created via POST /trunks) to a different agent on the same cha…
- [List pipeline stages](https://developers.mihu.ai/api-reference/contact-pipeline/list-pipeline-stages.md): Returns pipeline stages ordered by their display order. By default only active stages are returned.…
- [Create a new pipeline stage](https://developers.mihu.ai/api-reference/contact-pipeline/create-a-new-pipeline-stage.md): Creates a pipeline stage that can be assigned to contacts. Use this to add a new lifecycle step such…
- [Get a pipeline stage by uuid](https://developers.mihu.ai/api-reference/contact-pipeline/get-a-pipeline-stage-by-uuid.md): Returns one pipeline stage by UUID with its name, order, and active state. Use this before updating…
- [Update a pipeline stage](https://developers.mihu.ai/api-reference/contact-pipeline/update-a-pipeline-stage.md): Updates one pipeline stage. Use this to rename a stage, change its order, or mark it inactive. Only…
- [Delete a pipeline stage](https://developers.mihu.ai/api-reference/contact-pipeline/delete-a-pipeline-stage.md): Deletes a pipeline stage and detaches it from contacts that were assigned to it. Use this only when…
- [List contact pools](https://developers.mihu.ai/api-reference/pools/list-contact-pools.md): Returns a paginated list of pools. Each pool is a named bucket of contacts that one or more campaign…
- [Create a contact pool](https://developers.mihu.ai/api-reference/pools/create-a-contact-pool.md): Creates an empty pool. After creation, populate it with POST /api/v1/pools/{uuid}/contacts and attac…
- [Get pool details, including attached campaigns and pool item status counts](https://developers.mihu.ai/api-reference/pools/get-pool-details-including-attached-campaigns-and-pool-item-status-counts.md): Returns the full pool resource plus a status_counts breakdown (Pending/Processing/Completed/Failed/e…
- [Update a pool](https://developers.mihu.ai/api-reference/pools/update-a-pool.md): Partial update. Send only the fields you want to change. Use the is_active flag to activate/deactiva…
- [Delete a pool](https://developers.mihu.ai/api-reference/pools/delete-a-pool.md): Deletes the pool. Refuses with 409 if the pool is attached to any campaign in 'In Process' or 'Impor…
- [Duplicate a pool, optionally copying its contacts](https://developers.mihu.ai/api-reference/pools/duplicate-a-pool-optionally-copying-its-contacts.md): Creates a new pool with the same configuration as the source (type, max_parallel_items, max_retries,…
- [List contacts in a pool](https://developers.mihu.ai/api-reference/pools/list-contacts-in-a-pool.md): Returns paginated ContactPoolItem rows in the pool, each enriched with the underlying Contact's name…
- [Add existing contacts to a pool](https://developers.mihu.ai/api-reference/pools/add-existing-contacts-to-a-pool.md): Adds one or more existing contacts (by UUID) to the pool, creating ContactPoolItem rows with status=…
- [Remove a contact from a pool](https://developers.mihu.ai/api-reference/pools/remove-a-contact-from-a-pool.md): Removes the specified contact from this pool. Side effect: cancels (status='cancelled') any schedule…
- [List QA agents](https://developers.mihu.ai/api-reference/qa-agents/list-qa-agents.md): Returns your QA agents, default agent first. Example: `GET /api/v1/qa-agents?search=support&evaluate…
- [Create a QA agent](https://developers.mihu.ai/api-reference/qa-agents/create-a-qa-agent.md): Creates a QA agent with its scorecard. Send `skills` to define your own scorecard (weights must tota…
- [Get one QA agent](https://developers.mihu.ai/api-reference/qa-agents/get-one-qa-agent.md): Returns one QA agent with its full scorecard — skills, weights, AI prompts, and scoring items. The s…
- [Update a QA agent (same as PATCH)](https://developers.mihu.ai/api-reference/qa-agents/update-a-qa-agent-same-as-patch.md): Works exactly like PATCH /api/v1/qa-agents/{uuid}.
- [Delete a QA agent](https://developers.mihu.ai/api-reference/qa-agents/delete-a-qa-agent.md): Deletes a QA agent and its scorecard. Past evaluation results are kept. The default QA agent cannot…
- [Update a QA agent](https://developers.mihu.ai/api-reference/qa-agents/update-a-qa-agent.md): Updates a QA agent — only the fields you send are changed. When you include `skills`, the list repla…
- [Replace the scorecard skills](https://developers.mihu.ai/api-reference/qa-agents/replace-the-scorecard-skills.md): Replaces the scorecard without touching other settings. Include a skill's `uuid` to keep and update…
- [Set a QA agent as default](https://developers.mihu.ai/api-reference/qa-agents/set-a-qa-agent-as-default.md): Makes this QA agent the default evaluator. The previous default is switched off automatically — ther…
- [List campaign contact rules](https://developers.mihu.ai/api-reference/rules/list-campaign-contact-rules.md): Returns a paginated list of contact rules used by campaigns to control call/message cadence (max att…
- [Create a new campaign contact rule](https://developers.mihu.ai/api-reference/rules/create-a-new-campaign-contact-rule.md): Creates a standalone rule that can later be attached to one or more campaigns via PUT /api/v1/campai…
- [Get a single rule by UUID](https://developers.mihu.ai/api-reference/rules/get-a-single-rule-by-uuid.md): Returns one campaign contact rule by UUID, including type, retry limits, retry interval, allowed wor…
- [Update an existing rule](https://developers.mihu.ai/api-reference/rules/update-an-existing-rule.md): Partial update — only fields you send are changed. Important: changing `type` from 'call' to 'text'…
- [Delete a rule](https://developers.mihu.ai/api-reference/rules/delete-a-rule.md): Deletes the rule and detaches it from any campaigns it was attached to. Refuses with 409 if the rule…
- [Get all schedules](https://developers.mihu.ai/api-reference/schedules/get-all-schedules.md): Returns schedules with their attached availability type. Use this endpoint to choose which calendar…
- [Create a new schedule](https://developers.mihu.ai/api-reference/schedules/create-a-new-schedule.md): Creates a bookable schedule and links it to an availability type. Use this after creating or selecti…
- [Get a specific schedule](https://developers.mihu.ai/api-reference/schedules/get-a-specific-schedule.md): Returns one schedule by UUID with its availability type, assigned agent metadata, custom questions,…
- [Update a schedule](https://developers.mihu.ai/api-reference/schedules/update-a-schedule.md): Updates schedule metadata such as name, type, color, availability type, assigned agents, or custom q…
- [Delete a schedule](https://developers.mihu.ai/api-reference/schedules/delete-a-schedule.md): Deletes a schedule by UUID. Use this when a calendar should no longer be offered for appointment boo…
- [Get paginated list of session evaluations](https://developers.mihu.ai/api-reference/evaluations/get-paginated-list-of-session-evaluations.md): Retrieves a paginated list of session evaluations with optional filtering by session/conversation/co…
- [Get a single evaluation](https://developers.mihu.ai/api-reference/evaluations/get-a-single-evaluation.md): Returns one session evaluation by UUID, including scores, labels, reasons, and related session/conve…
- [List simulations](https://developers.mihu.ai/api-reference/simulations/list-simulations.md)
- [Create a simulation](https://developers.mihu.ai/api-reference/simulations/create-a-simulation.md): Creates a draft. Personas may be omitted — they are generated from the test cases when the simulatio…
- [Creation catalog: channels, agents per channel, caller lines and the per-message rate](https://developers.mihu.ai/api-reference/simulations/creation-catalog:-channels-agents-per-channel-caller-lines-and-the-per-message-rate.md)
- [Get one simulation with its full configuration and run summaries](https://developers.mihu.ai/api-reference/simulations/get-one-simulation-with-its-full-configuration-and-run-summaries.md)
- [Update a simulation (full replace of its configuration)](https://developers.mihu.ai/api-reference/simulations/update-a-simulation-full-replace-of-its-configuration.md): Same body as create. Rejected while the simulation is running — in-flight runs are judged against th…
- [Delete a simulation](https://developers.mihu.ai/api-reference/simulations/delete-a-simulation.md)
- [Run a simulation](https://developers.mihu.ai/api-reference/simulations/run-a-simulation.md): Queues the batch: runs_per_case conversations per test case. Simulated assistant messages are billed…
- [Stop a running simulation](https://developers.mihu.ai/api-reference/simulations/stop-a-running-simulation.md): Ends any live call, closes unfinished conversations. Conversations that already finished keep their…
- [Get the aggregated report](https://developers.mihu.ai/api-reference/simulations/get-the-aggregated-report.md): Available once the batch has finished at least once: overall score, per-criterion verdicts (met when…
- [List the simulation's conversations (current batch)](https://developers.mihu.ai/api-reference/simulations/list-the-simulations-conversations-current-batch.md)
- [Get one conversation with its full transcript](https://developers.mihu.ai/api-reference/simulations/get-one-conversation-with-its-full-transcript.md): Transcript entries: who=customer (the persona), who=assistant, who=tool (a real intent/tool executio…
- [Propose field changes to improve the assistant (review before test/apply)](https://developers.mihu.ai/api-reference/simulations/propose-field-changes-to-improve-the-assistant-review-before-testapply.md): From the finished report, proposes changes to the agent's fields (data.optimizations[].changes: {fie…
- [Test a proposed improvement before applying it](https://developers.mihu.ai/api-reference/simulations/test-a-proposed-improvement-before-applying-it.md): Re-runs the simulation with the proposed candidate prompt (simulated, billed like a run) so you can…
- [Accept a proposed improvement (updates the agent's fields)](https://developers.mihu.ai/api-reference/simulations/accept-a-proposed-improvement-updates-the-agents-fields.md): Applies the change set to the AGENT — exactly like editing it in the Skills/Advanced editor — and th…
- [Reject a proposed improvement (assistant keeps its current prompt)](https://developers.mihu.ai/api-reference/simulations/reject-a-proposed-improvement-assistant-keeps-its-current-prompt.md)
- [Undo an accepted improvement (restore the previous prompt)](https://developers.mihu.ai/api-reference/simulations/undo-an-accepted-improvement-restore-the-previous-prompt.md): Restores the prompt an accepted attempt replaced. Refused (409 'prompt_changed') if the assistant's…
- [Generate customer personas for an assistant](https://developers.mihu.ai/api-reference/simulations/generate-customer-personas-for-an-assistant.md): Builds realistic customers of the assistant's actual business (profile, guidelines, training rules,…
- [Generate test cases for an assistant](https://developers.mihu.ai/api-reference/simulations/generate-test-cases-for-an-assistant.md): Builds test cases with success criteria from the assistant's prompt and its configured activities (i…
- [List all SIP trunk connections](https://developers.mihu.ai/api-reference/sip-trunk/list-all-sip-trunk-connections.md): Returns SIP trunk connections configured for the workspace. Use this before assigning a SIP trunk to…
- [Add a new SIP trunk connection](https://developers.mihu.ai/api-reference/sip-trunk/add-a-new-sip-trunk-connection.md): Creates a SIP trunk connection. Once created, assign it to an agent via POST /api/v1/agents/{uuid}/c…
- [Delete a SIP trunk connection](https://developers.mihu.ai/api-reference/sip-trunk/delete-a-sip-trunk-connection.md): Deletes a SIP trunk connection and removes agent assignments that depend on it. Use this when the pr…
- [Assign a SIP trunk connection to an agent for calls](https://developers.mihu.ai/api-reference/sip-trunk/assign-a-sip-trunk-connection-to-an-agent-for-calls.md): Assigns a SIP trunk connection to this agent for calls. If the agent was previously bound to a diffe…
- [List contact tags](https://developers.mihu.ai/api-reference/contact-tags/list-contact-tags.md): Returns reusable contact tags for segmentation and filtering. By default only active tags are return…
- [Create a new contact tag](https://developers.mihu.ai/api-reference/contact-tags/create-a-new-contact-tag.md): Creates a reusable tag for contacts. Use tags to segment contacts for filtering, targeting, and orga…
- [Get a tag by uuid](https://developers.mihu.ai/api-reference/contact-tags/get-a-tag-by-uuid.md): Returns one contact tag by UUID. Use this to inspect tag name, color, description, and active state…
- [Update a tag](https://developers.mihu.ai/api-reference/contact-tags/update-a-tag.md): Updates one contact tag. Use this to rename a tag, change its color or description, or mark it inact…
- [Delete a tag](https://developers.mihu.ai/api-reference/contact-tags/delete-a-tag.md): Deletes one contact tag and detaches it from contacts that had it assigned. Use this when the segmen…
- [Get paginated list of tasks](https://developers.mihu.ai/api-reference/tasks/get-paginated-list-of-tasks.md): Returns scheduled and historical agent tasks with filters for type, status, contact, campaign, agent…
- [Create a new task (Call, SMS, WhatsApp, or Email)](https://developers.mihu.ai/api-reference/tasks/create-a-new-task-call-sms-whatsapp-or-email.md): Creates a one-off task for an agent. Use make_call for outbound calls and send_message with task_dat…
- [Get a specific task](https://developers.mihu.ai/api-reference/tasks/get-a-specific-task.md): Returns one task by UUID with its contact, campaign, agent, channel, schedule, status, retry informa…
- [Update a task](https://developers.mihu.ai/api-reference/tasks/update-a-task.md): Updates an existing task. Use this to change schedule time, priority, assignee, description, status,…
- [Delete a task](https://developers.mihu.ai/api-reference/tasks/delete-a-task.md): Soft-deletes a task and removes it from normal task lists. Use this when the work should no longer r…
- [Queue a task for execution](https://developers.mihu.ai/api-reference/tasks/queue-a-task-for-execution.md): Queues a task for execution now or at the provided delay. Use this to manually start a pending or sc…
- [Cancel a task](https://developers.mihu.ai/api-reference/tasks/cancel-a-task.md): Cancels a task that has not finished. Use this when planned outreach should be stopped before it exe…
- [Retry a failed task](https://developers.mihu.ai/api-reference/tasks/retry-a-failed-task.md): Retries a failed task when the task has remaining attempts. Use this after correcting the reason for…
- [List all available merge tags for template placeholders](https://developers.mihu.ai/api-reference/whatsapp-template-settings/list-all-available-merge-tags-for-template-placeholders.md): Returns every merge tag you can use as a params.body value when creating or updating a template sett…
- [List template settings](https://developers.mihu.ai/api-reference/whatsapp-template-settings/list-template-settings.md): Returns template settings, newest first. Use template_uuid to see the settings of one template, waba…
- [Create a template setting (make a template campaign-ready)](https://developers.mihu.ai/api-reference/whatsapp-template-settings/create-a-template-setting-make-a-template-campaign-ready.md): Configures an APPROVED template for campaign use by defining what fills each {{n}} placeholder. The…
- [Get one template setting](https://developers.mihu.ai/api-reference/whatsapp-template-settings/get-one-template-setting.md)
- [Update a template setting](https://developers.mihu.ai/api-reference/whatsapp-template-settings/update-a-template-setting.md): Updates the placeholder values and/or status. The underlying template cannot be changed — create a n…
- [Delete a template setting](https://developers.mihu.ai/api-reference/whatsapp-template-settings/delete-a-template-setting.md): Deletes the setting. Refused with 409 while any campaign that references it is In Process, Importing…
- [List supported timezones](https://developers.mihu.ai/api-reference/timezone/list-supported-timezones.md): Catalog of IANA timezones accepted as `agent.timezone`. The `value` is what you pass on the agent re…
- [Create a new transcription request](https://developers.mihu.ai/api-reference/transcriptions/create-a-new-transcription-request.md): Submits audio for asynchronous transcription and optional evaluation. Provide either voice_file or v…
- [Get transcription by UUID](https://developers.mihu.ai/api-reference/transcriptions/get-transcription-by-uuid.md): Returns one transcription by UUID, including status, reference_id, stored audio URL, transcript resu…
- [Get full transcript with conversation messages and evaluations](https://developers.mihu.ai/api-reference/transcriptions/get-full-transcript-with-conversation-messages-and-evaluations.md): Returns the full completed transcript payload, including role/content conversation messages, full te…
- [List voices in the library](https://developers.mihu.ai/api-reference/voice-library/list-voices-in-the-library.md): Returns the public voice catalog for the workspace. Filter by `language`/`gender`/`accent` or fuzzy-…
- [List supported speeds for a voice](https://developers.mihu.ai/api-reference/voice-library/list-supported-speeds-for-a-voice.md): Send a voice UUID, receive the speed options that voice supports. `normal` is always returned; `fast…
- [Make a WhatsApp call](https://developers.mihu.ai/api-reference/whatsapp-calling/make-a-whatsapp-call.md): Starts a WhatsApp voice call from the selected agent to a contact phone number. Use this only after…
- [Send call permission request](https://developers.mihu.ai/api-reference/whatsapp-calling/send-call-permission-request.md): Sends a WhatsApp call permission request to a contact before placing a WhatsApp voice call. The cont…
- [List WhatsApp Business Accounts linked to this tenant](https://developers.mihu.ai/api-reference/whatsapp-templates/list-whatsapp-business-accounts-linked-to-this-tenant.md): Returns the WABAs this tenant has configured (via WhatsappSetting). Use these waba_ids when listing/…
- [List WhatsApp message templates](https://developers.mihu.ai/api-reference/whatsapp-templates/list-whatsapp-message-templates.md): Paginated list of templates stored locally. Filter by waba_id (recommended — templates are scoped pe…
- [Create a new WhatsApp template](https://developers.mihu.ai/api-reference/whatsapp-templates/create-a-new-whatsapp-template.md): Submits the template to Meta's WhatsApp Business API and stores it locally. The returned status is w…
- [Get a single template by UUID](https://developers.mihu.ai/api-reference/whatsapp-templates/get-a-single-template-by-uuid.md): Returns the full template resource including the components array (HEADER/BODY/FOOTER/BUTTONS) exact…
- [Delete a template (Meta + local)](https://developers.mihu.ai/api-reference/whatsapp-templates/delete-a-template-meta-+-local.md): Calls Meta's delete API and soft-deletes the local record. After deletion, no campaigns can use this…
- [Upload a media file](https://developers.mihu.ai/api-reference/whatsapp-templates/upload-a-media-file.md): Upload an image, video, or document to Meta and receive a temporary media `handle` for a WhatsApp te…
- [Bulk-sync templates for a WABA from Meta into local DB](https://developers.mihu.ai/api-reference/whatsapp-templates/bulk-sync-templates-for-a-waba-from-meta-into-local-db.md): Pulls all templates Meta has on file for the given waba_id and upserts them locally (matched by Meta…
- [Refresh a single template's status from Meta](https://developers.mihu.ai/api-reference/whatsapp-templates/refresh-a-single-templates-status-from-meta.md): Re-fetches this one template from Meta and updates local status/components/category. The typical pol…

## OpenAPI Specs

- [api-docs](https://app.mihu.ai/docs/api-docs.json)

## Optional

- [Mihu ](https://mihu.ai)
- [Login](https://app.mihu.ai)