# Miyon AI Help Center

## Dokumentation

### Startseite

- [Hilfe](https://app.miyon.ai/docs/de/index.md): Willkommen in der Online-Hilfe. Detaillierte Informationen zu allen Funktionen und Konzepten der Plattform.

### AI-Assistenten

- [AI-Assistenten erstellen und einrichten](https://app.miyon.ai/docs/de/agent-setup.md): Wählen Sie Voice oder Chat, richten Sie den Assistenten ein und testen Sie ihn vor dem Einsatz.
- [Telefonie für Voice-Assistenten](https://app.miyon.ai/docs/de/ai-numbers.md): KI-Rufnummern und SIP-Endpunkte machen Voice-Assistenten telefonisch erreichbar.
- [Konversation und Audio](https://app.miyon.ai/docs/de/conversation-audio.md): Konversationstypen, Spracherkennungsoptimierung und Audio-Einstellungen für Voice Agents.
- [Anruf Einstellungen](https://app.miyon.ai/docs/de/call-settings.md): Konfiguration von automatischen Timeouts und Anrufbeendigungen für Voice-Agenten.
- [Entwürfe für AI-Assistenten](https://app.miyon.ai/docs/de/entwuerfe.md): Änderungen an Voice- und Chat-Assistenten sammeln, prüfen und gemeinsam übernehmen.

#### SIP-Verbindungen

- [Eigene SIP-Verbindung](https://app.miyon.ai/docs/de/sip-trunk.md): Eigene SIP-Trunks und Rufnummern einrichten.
- [Twilio Elastic SIP Trunk](https://app.miyon.ai/docs/de/twilio.md): Twilio mit Ihrer SIP-Verbindung verbinden: Rufnummern, eingehende und ausgehende Anrufe sowie Weiterleitungen einrichten.
- [NFON SIP-Trunk](https://app.miyon.ai/docs/de/nfon.md): NFON über IP-Authentifizierung verbinden: eingehende Anrufe, ausgehende Anrufe und Warm Transfers einrichten.
- [3CX](https://app.miyon.ai/docs/de/3cx.md): Anrufe aus Ihrer 3CX-Telefonanlage über die eigene SIP-Verbindung an einen Voice Agent weiterleiten.

### KI Inhalte & Kontext

- [Prompting Guide](https://app.miyon.ai/docs/de/ai-prompts.md): Leitfaden für wirkungsvolle KI-Anweisungen: empfohlene Struktur, Tipps & Tricks, Beispiele, Tools und Variablen.
- [Wissensdatenbank](https://app.miyon.ai/docs/de/knowledge-base.md): Text, Websites, Dateien und FAQ-Sammlungen zentral pflegen und mit mehreren Assistenten verbinden.
- [Kontextbudget](https://app.miyon.ai/docs/de/kontextbudget.md): Wie viel Text Ihr Assistent pro Gespräch verarbeitet, was das gelbe und das rote Symbol im Wizard bedeuten und wie Sie im Budget bleiben.

### Erweiterte Funktionen

- [Tools Guide](https://app.miyon.ai/docs/de/tools.md): Tools im Voice Wizard und Sidebar -- gemeinsame Funktionen für alle Voice Agents.
- [Inbound Webhook](https://app.miyon.ai/docs/de/inbound-webhook.md): Vor einem eingehenden Anruf API-Daten laden und in Begrüßung, KI-Anweisung, Weiterleitung und Nachbearbeitung verwenden.
- [Warme Anrufweiterleitung](https://app.miyon.ai/docs/de/warm-transfer.md): Anrufer mit einem Mitarbeiter verbinden -- nachdem ein KI-Briefing-Assistent das Anliegen vorab erläutert hat.
- [Assistent nach Zeitplan](https://app.miyon.ai/docs/de/assistent-nach-zeitplan.md): Anrufe auf einer Rufnummer je nach Wochentag und Uhrzeit von einem anderen Voice Assistenten beantworten lassen -- abends, am Wochenende oder an Feiertagen.
- [Live-Monitoring](https://app.miyon.ai/docs/de/live-monitoring.md): Anrufe Ihrer Voice Agents in Echtzeit mitverfolgen, übernehmen und im Browser annehmen.
- [DTMF-Eingabe](https://app.miyon.ai/docs/de/dtmf-eingabe.md): Tastatureingaben am Telefon erkennen und verarbeiten -- PIN, Menüauswahl, Codes.
- [API-Anfragen](https://app.miyon.ai/docs/de/external-api-integration.md): Konfiguration externer API-Integrationen für Voice Agents.
- [OAuth-Anbieter (JWT)](https://app.miyon.ai/docs/de/oauth-anbieter.md): JWT OAuth-Authentifizierung für externe APIs -- Google, Microsoft und TKP.
- [Werkstatt-Termine (TKP)](https://app.miyon.ai/docs/de/werkstatt-termine.md): Automatisierte Werkstatt-Terminbuchung über die TKP/soft-nrg Integration.
- [Microsoft Outlook Kalender](https://app.miyon.ai/docs/de/outlook-kalender.md): Outlook-Kalender verbinden -- freie Termine finden und Termine direkt buchen.
- [Calendly](https://app.miyon.ai/docs/de/calendly.md): Calendly verbinden - freie Termine prüfen und Termine direkt buchen.
- [Eigener MCP-Server](https://app.miyon.ai/docs/de/mcp-server.md): Eigenen MCP-Server verbinden -- die dort bereitgestellten Tools erkennen und Ihrem Voice Agent als Tools hinzufügen.
- [Google Sheets](https://app.miyon.ai/docs/de/google-sheets.md): Google-Tabelle verbinden -- Ihr Voice Agent liest Daten daraus vor oder trägt neue Zeilen ein.
- [Nachbearbeitung](https://app.miyon.ai/docs/de/post-processing.md): Automatische E-Mail-, SMS-, API- und Ticket-Aktionen nach jedem Anruf konfigurieren.
- [Transkriptaufbewahrung](https://app.miyon.ai/docs/de/transcript-retention.md): Aufbewahrungsmodi für Transkriptionsdaten und Freigabelinks von Voice Agents.
- [Ausgehende Anrufe ](https://app.miyon.ai/docs/de/ausgehende-anrufe.md): Automatisierte KI-gestützte ausgehende Anrufe an Ihre Kontakte.

### Tickets

- [Tickets](https://app.miyon.ai/docs/de/tickets.md): Aufgaben und Nachverfolgungen erstellen, zuweisen und bis zum Abschluss verfolgen – manuell oder automatisch aus Gesprächen.

### Team

- [Team verwalten](https://app.miyon.ai/docs/de/team.md): Benutzer einladen und verwalten sowie Gruppen anlegen, um Tickets und Gespräche an die richtigen Personen zu verteilen.

### Agent-Vorlagen

- [Callback Agent](https://app.miyon.ai/docs/de/agents/callback.md): Setzen Sie einen Rückruf-Service-Agenten ein, der Anruferdaten erfasst und einen Rückruf organisiert.
- [Custom Agent](https://app.miyon.ai/docs/de/agents/custom.md): Erstellen Sie einen vollständig individuellen Sprachagenten mit eigenen Anweisungen.
- [FAQ Agent](https://app.miyon.ai/docs/de/agents/faq.md): Beantwortet Anrufe anhand Ihrer FAQ-Inhalte mit optionaler Anrufweiterleitung und E-Mail-Zusammenfassung.
- [Forwarding Agent](https://app.miyon.ai/docs/de/agents/forwarding.md): Erstellen Sie ein interaktives Sprachmenü, das Anrufer intelligent an die richtige Abteilung weiterleitet.
- [Info Retrieval Agent](https://app.miyon.ai/docs/de/agents/info-retrieval.md): Erstellen Sie einen Agenten, der Anrufer gezielt befragt, um bestimmte Informationen zu sammeln.
- [Mailbox Agent](https://app.miyon.ai/docs/de/agents/mailbox.md): Richten Sie eine intelligente Sprachmailbox ein, die mehr kann als nur Nachrichten aufzuzeichnen.
- [Smart Desk Agent](https://app.miyon.ai/docs/de/agents/smart-desk.md): Erstellen Sie einen Sprachassistenten, der häufig gestellte Fragen aus Ihrer Wissensdatenbank beantwortet.
- [Workshop Agent](https://app.miyon.ai/docs/de/agents/workshop.md): Erstellen Sie einen Sprachassistenten, der Werkstatttermine für Ihr Autohaus verwaltet.

## API Reference

### Get started

- [Introduction](https://app.miyon.ai/docs/en/api-reference/introduction.md): What the REST API offers, the base URL, and your first request.
- [Authorization](https://app.miyon.ai/docs/en/api-reference/authorization.md): API tokens and scopes.
- [Rate limits](https://app.miyon.ai/docs/en/api-reference/rate-limits.md): Request allowances per account, the 429 response, and the 30-second request limit.
- [Errors](https://app.miyon.ai/docs/en/api-reference/errors.md): The error envelope, stable error codes, and the formats older endpoints still use.

### Voice Agents

- [List voice agents](https://app.miyon.ai/docs/api-reference/voice-agents/list-voice-agents.md): All voice agents of your account, most recently updated first. Not paginated.
- [Create a voice agent](https://app.miyon.ai/docs/api-reference/voice-agents/create-a-voice-agent.md): Create a voice agent with its prompt. Optionally set prompt, voice and knowledge-base values in the same request; they are validated exactly as in the settings endpoints and the whole request fails if any value is rejected. Add tools afterwards with `POST /api/v2/tools` using the returned `id` as `a…
- [Get a voice agent](https://app.miyon.ai/docs/api-reference/voice-agents/get-a-voice-agent.md): Read one voice agent.
- [Update a voice agent](https://app.miyon.ai/docs/api-reference/voice-agents/update-a-voice-agent.md): Change the agent's name and description. Both are mirrored to the agent's prompt. All other settings live in the settings endpoints.
- [Delete a voice agent](https://app.miyon.ai/docs/api-reference/voice-agents/delete-a-voice-agent.md): Delete the agent together with its prompt and configuration. Cannot be undone.

### Voice Agent Settings

- [Set up a voice agent](https://app.miyon.ai/docs/en/api-reference/voice-agent-settings.md): Create a voice agent, then shape how it talks and sounds with recipes for the common settings.
- [Get voice settings](https://app.miyon.ai/docs/api-reference/voice-agent-settings/get-voice-settings.md): Current voice configuration of the agent as dotted keys in `values`, with the `revision` to send as `If-Match` on updates.
- [Update voice settings](https://app.miyon.ai/docs/api-reference/voice-agent-settings/update-voice-settings.md): Update one voice setting per request using `key` and `value`.
- [Get voice settings schema](https://app.miyon.ai/docs/api-reference/voice-agent-settings/get-voice-settings-schema.md): Voice settings and their accepted values for this agent's current configuration. Use `fields[].key` as the `key` of an update, `value_type` and `validation` for the value, and `option_sets[field.options_ref][].value` for selection fields. Labels are for display only. Read the current values with [Ge…
- [Get prompt settings](https://app.miyon.ai/docs/api-reference/voice-agent-settings/get-prompt-settings.md): Instructions, greeting and conversation settings of the agent's prompt.
- [Update prompt settings](https://app.miyon.ai/docs/api-reference/voice-agent-settings/update-prompt-settings.md): Update one prompt setting per request using `key` and `value`. Read the [prompt settings schema](/api-reference/voice-agent-settings/get-prompt-settings-schema) for keys, value types and choices.
- [Get prompt settings schema](https://app.miyon.ai/docs/api-reference/voice-agent-settings/get-prompt-settings-schema.md): Prompt settings and their accepted values. Send a field's `key` in an update and use its `value_type` and `validation` to build the value. For selection fields with `options_ref`, pick the option's `value` from the matching `option_sets` entry. Read the current values with [Get prompt settings](/api…
- [Get knowledge base settings](https://app.miyon.ai/docs/api-reference/voice-agent-settings/get-knowledge-base-settings.md): Knowledge sources currently attached to the agent.
- [Update knowledge base settings](https://app.miyon.ai/docs/api-reference/voice-agent-settings/update-knowledge-base-settings.md): Select the knowledge sources the agent may use. The supplied list replaces the current selection. All sources must belong to your account.
- [Get knowledge base schema](https://app.miyon.ai/docs/api-reference/voice-agent-settings/get-knowledge-base-schema.md): Fields and available knowledge sources for this agent.

### Tools

- [List tools](https://app.miyon.ai/docs/api-reference/tools/list-tools.md): List the tools of your account together with the catalog of tools that can still be added. Pass `agent_id` to learn which tools are enabled for that agent (`is_active`); without it every tool reports `is_active: false`.
- [Create a tool](https://app.miyon.ai/docs/api-reference/tools/create-a-tool.md): Create a tool. Two payload shapes exist:
- [List tool types](https://app.miyon.ai/docs/api-reference/tools/list-tool-types.md): Catalog of tool types. `creatable_via_api` tells whether `POST /api/v2/tools` accepts the type, `requires_integration` and `required_integration_type` whether an `integration_id` must be passed, and `params_schema_hint` describes the expected `params`. Behaviours that belong to the agent itself, suc…
- [Toggle tools for an agent](https://app.miyon.ai/docs/api-reference/tools/toggle-tools-for-an-agent.md): Enable or disable tools for a voice agent. Idempotent: tools already in the requested state stay there. Returns the names of the tools enabled for the agent afterwards.
- [Get a tool](https://app.miyon.ai/docs/api-reference/tools/get-a-tool.md): Read one tool. API tools return their full configuration; other types return the same fields as the list endpoint.
- [Update a tool](https://app.miyon.ai/docs/api-reference/tools/update-a-tool.md): Partial update; only keys present in the body change. `PUT` is accepted as an alias. The payload shape depends on the tool's `function_type`.
- [Delete an API tool](https://app.miyon.ai/docs/api-reference/tools/delete-an-api-tool.md): Delete an API tool (`function_type: external:api`). Other tool types are deleted in the dashboard; deleting them here returns 403 `mf-core:tool-delete-unsupported`.
- [Execute a tool](https://app.miyon.ai/docs/api-reference/tools/execute-a-tool.md): Run a tool with the given arguments and return its result, for example to test an API tool. Test runs are not recorded in any conversation's tool history. When the tool itself fails, the response is `mf-core:tool-execution-failed` with the upstream HTTP status.

### Outbound Calls

- [Outbound calls](https://app.miyon.ai/docs/en/api-reference/outbound-calls.md): Place AI-powered calls to your contacts, personalize each one, and review the outcome.
- [Place a call](https://app.miyon.ai/docs/api-reference/outbound-calls/place-a-call.md): Place a single outbound call. The call is dialed immediately.
- [Place calls in bulk](https://app.miyon.ai/docs/api-reference/outbound-calls/place-calls-in-bulk.md): Place calls to multiple destinations in one request, up to **10 destinations**.
- [List batches](https://app.miyon.ai/docs/api-reference/outbound-calls/list-batches.md): List the call batches of your account, newest first. Every batch appears here, including calls placed from the dashboard; single calls also get a batch.
- [Get a batch](https://app.miyon.ai/docs/api-reference/outbound-calls/get-a-batch.md): Return one batch with its individual call records and a summary. Records are newest first, 20 per page.
- [Cancel a call](https://app.miyon.ai/docs/api-reference/outbound-calls/cancel-a-call.md): Cancel a call record that has not been dialed yet. This applies to dashboard batches awaiting SMS confirmation and to calls whose dial attempt failed. Calls placed through this API are dialed immediately and cannot be canceled.

### Conversations

- [List conversations](https://app.miyon.ai/docs/api-reference/conversations/list-conversations.md): Conversations of your account, newest first (by creation time, then id).
- [Get a conversation](https://app.miyon.ai/docs/api-reference/conversations/get-a-conversation.md): One conversation with its transcript, when your retention settings allow. Hidden and technical messages and audio recordings are never exposed. Shares the request quota of the list endpoint.

### Evals

- [List eval scenarios](https://app.miyon.ai/docs/api-reference/evals/list-eval-scenarios.md): Every eval scenario of your account, most recently updated first. Not paginated. Items are summaries; use `GET /api/v1/evals/{id}` for cases and runs.
- [Create an eval scenario](https://app.miyon.ai/docs/api-reference/evals/create-an-eval-scenario.md): Create a scenario with at least one case. `slug` is generated from `name`.
- [Get an eval scenario](https://app.miyon.ai/docs/api-reference/evals/get-an-eval-scenario.md): Scenario detail with its cases and a page of recent runs.
- [Update an eval scenario](https://app.miyon.ai/docs/api-reference/evals/update-an-eval-scenario.md): Replaces the whole scenario, although the method is PATCH: `name`, `agent_id`, `description` and `meta` are taken from the body (omitted fields are cleared) and all existing cases are deleted and rebuilt from the body. Omitting `cases` removes every case. `PUT` on this path behaves identically.
- [Replace an eval scenario](https://app.miyon.ai/docs/api-reference/evals/replace-an-eval-scenario.md): Identical to `PATCH /api/v1/evals/{id}`: a full replacement of the scenario.
- [Duplicate an eval scenario](https://app.miyon.ai/docs/api-reference/evals/duplicate-an-eval-scenario.md): Creates a copy named `<name> (Copy N)` with the same agent, settings and cases. The copy has no runs. No request body.
- [Start an eval run](https://app.miyon.ai/docs/api-reference/evals/start-an-eval-run.md): Queues a run of the scenario. At most 5 runs per account may be pending or running at once; further starts return 429 with a plain `error` message and no `Retry-After`. Starts are also rate-limited (burst 2, then one start every 10 seconds) with the standard rate-limit envelope.
- [Get an eval run](https://app.miyon.ai/docs/api-reference/evals/get-an-eval-run.md): Returns the run. A run that is still `pending` or `running` 15 minutes after creation is returned as `error`.
- [Cancel an eval run](https://app.miyon.ai/docs/api-reference/evals/cancel-an-eval-run.md): Only `pending` or `running` runs can be canceled. No request body.

## OpenAPI Specs

- [openapi](/docs/api-reference/openapi.yaml)

> The links below point to documentation indexes. Follow each `/_llms/` index recursively until you reach documentation pages.

## Indexes

- [English (82 pages)](https://app.miyon.ai/docs/_llms/en.txt): Documentation for English.


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.