> ## Documentation Index
> Fetch the complete documentation index at: https://app.miyon.ai/docs/llms.txt
> Use this file to discover all available pages before exploring further.

# Introduction

> What the REST API offers, the base URL, and your first request.

> [!NOTE]
>
> **The API is in beta.** Every endpoint in this reference is live in production.
> Contracts can still change while we complete the API, including breaking changes.
> We keep them rare and announce every change in the release notes. Pin your
> integration to the documented field names and status codes, and treat unknown
> fields as optional.

The REST API lets you drive Miyon from your own systems:

* **Voice Agents** - create, list, update and delete voice agents.
* **Voice Agent Settings** - read and change an agent's voice, prompt and
  knowledge-base settings. See [Set up a voice agent](/docs/en/api-reference/voice-agent-settings).
* **Tools** - create and configure tools, enable them per agent, and execute them.
* **Outbound Calls** - place AI calls to your contacts and review the outcome. See
  the [outbound guide](/docs/en/api-reference/outbound-calls).
* **Conversations** - list and inspect the conversations of your account.
* **Evals** - run automated test conversations against a voice agent.

## Base URL

```
https://app.miyon.ai
```

All paths in this reference are relative to this host, the one you use to sign
in to your dashboard. Requests and responses are JSON.

## Your first request

Create an API token on the **Keys** page of your dashboard (see
[Authorization](/docs/en/api-reference/authorization)), then list your voice agents:

```bash theme={null}
curl https://app.miyon.ai/api/v1/voice_agents \
  -H "Authorization: Bearer <your-api-token>"
```

```json theme={null}
{
  "voice_agents": [
    {
      "id": 789,
      "number_id": 789,
      "name": "Booking agent",
      "description": "Takes appointment calls",
      "prompt_id": 987,
      "created_at": "2026-09-30T14:02:11Z",
      "updated_at": "2026-10-12T09:41:07Z"
    }
  ]
}
```

## Before you build

* [Authorization](/docs/en/api-reference/authorization) - tokens and scopes.
* [Rate limits](/docs/en/api-reference/rate-limits) - request allowances and the
  30-second request limit.
* [Errors](/docs/en/api-reference/errors) - the error envelope and how to branch on it.

> [!NOTE]
>
> This reference is available in English only. Endpoint pages are generated from
> the API specification, so they always match what is deployed.


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