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

# API Reference

> HeyMilo Public API documentation. Use v2 (api.heymilo.ai) for all new integrations.

HeyMilo has two API versions. **Use v2 for all new integrations.**

|              | **v2 API (recommended)**                                                                                           | **Legacy API (v1)**                                       |
| ------------ | ------------------------------------------------------------------------------------------------------------------ | --------------------------------------------------------- |
| **Base URL** | `https://api.heymilo.ai/api/v2`                                                                                    | `https://api.heymilo.network/api`                         |
| **Docs**     | [v2 API Overview](/api-reference/overview) + [v2 API Reference](/api-reference/interviews/get-full-interview-data) | [Legacy API (v1)](/api-reference/legacy-v1/documentation) |
| **Status**   | Current, full surface area                                                                                         | Deprecated, maintenance only                              |

## Start here (v2)

1. Read the [v2 API Overview](/api-reference/overview) for auth, response shapes, and migration notes from v1.
2. Browse endpoint docs in **v2 API Reference** (generated from our OpenAPI spec).
3. Try a [quickstart guide](/api-reference/guides/voice-agent-video) if you want a full walkthrough.

## Common v2 endpoints

| I want to…                                          | Endpoint doc                                                                     |
| --------------------------------------------------- | -------------------------------------------------------------------------------- |
| Get interview results (scorecard, transcript, etc.) | [Get full interview data](/api-reference/interviews/get-full-interview-data)     |
| List interviewers                                   | [List interviewers](/api-reference/interviewers/list-interviewers)               |
| Ingest a candidate                                  | [Ingest a single candidate](/api-reference/candidates/ingest-a-single-candidate) |
| Register a webhook                                  | [Register a webhook](/api-reference/webhooks/register-a-webhook)                 |

<Warning>
  **On v1 already?** The [Legacy API (v1)](/api-reference/legacy-v1/documentation) docs are still available, but we recommend migrating to v2. See the [endpoint mapping table](/api-reference/overview#endpoint-mapping-legacy-%E2%86%92-v2) in the overview.
</Warning>